Skip to main content

Preauthorization

(PUT /all-in-one/{request_id})

After authentication, it allows preauthorizing the authenticated amount. To indicate the authentication you want to preauthorize, it is necessary to add the request_id from the authentication call in the endpoint of the PUT request.

Payload

  • operation (enum[string], required): Operation to be performed
    • preauthorization: Preauthorization

Request example

{
"key": "{{key}}",
"resource": "{{resource}}",
"nonce": "123456123",
"mode": "sha256",
"payload": {
"operation": "preauthorization"
}
}

Success - 0 - preauthorization

  • code (string, required): Internal operation code. Refer to Response Codes 0
  • amount (string, required): Amount of the operation 1000
  • currency (string, required): Currency used in the operation EUR
  • order (string, required): Ticket for the operation sipay-order-001
  • reconciliation (string, required): Identifier for bank reconciliation 1234sipay
  • card_trade (string, required): Issuer of the card. Request more information. undefined
  • card_type (string, required): Type of the card. Request more information. undefined
  • masked_card (string, required): Masked card number 6712 00** ****0205
  • transaction_id (string, required): Transaction identifier. 000024899463550243139
  • sequence (string, required): 1131238
  • authorizator (string, required): Authorizing entity for the operation BANCO SANTANDER, S.A.
  • approval (string, required): Approval code from the entity 346179

Response example

{
"type": "success",
"code": "0",
"detail": "preauthorization",
"description": "Preauthorization processed successfully",
"payload": {
"currency": 978,
"order": "Pruebas-psd2-018",
"reconciliation": "",
"code": "0",
"authorizator": "BANCO SANTANDER, S.A.",
"amount": 0,
"masked_card": "4918 01** **** 3839",
"transaction_id": "080834210105175236",
"approval": null,
"card_type": "debit",
"card_trade": "consumer",
"card_country": 724,
"card_brand": "VISA",
"token": "token-psd2"
},
"uuid": "4c9dff1d-5d5a-4b5f-b336-3824ebb4ca12",
"request_id": "5ff4995776378c3a3d3ecfc2"
}

Response example -1

{
"type": "error",
"code": "-1",
"detail": "preauthorization_error",
"description": "An error occurred in the preauthorization",
"payload": {
"currency": "",
"order": "",
"reconciliation": "",
"code": "-1",
"authorizator": null,
"amount": 0,
"masked_card": null
},
"uuid": "7933a276-73f0-4222-9ba8-8ae0434781e2",
"request_id": "5ff496e276378c30f8cc27d9"
}