Skip to main content

Unlocking Preauthorizations (free funds reservation)​

(POST /unlock)

Payload

  • transaction_id (string, required): Transaction identifier obtained from the request to create a preauthorization or update a preauthorization.000024899463550243139
  • amount (string, required): Amount of the operation 1000
  • currency (string, required): Any currency defined according to ISO 4217 will be valid EUR
  • order (string): Ticket for the operation sipay-order-001
  • custom_01 (string): Custom field custom_001
  • custom_02 (string): Custom field custom_002

Request example​

{
    "key": "589365da65c48cff87d0874a",
    "resource": "359ef8ce5c5f4003b71692e446908c27",
    "nonce": "1234567890",
    "mode": "sha256",
    "payload": {
        "transaction_id": "000024899463550243139",
        "amount": 1000,
        "currency": "EUR",
        "order": "sipay-order-001",
        "custom_01": "custom_001",
        "custom_02": "custom_002"
    }
}

Response example​

  • code (string, required): Internal operation code. Refer to Response Codes 0
  • order (string, required): Ticket for the operation sipay-order-001
  • transaction_id (string, required): Transaction identifier.000024899463550243139
  • reconciliation (string, required): Identifier for bank reconciliation (p37) 1234-sipay
{
     "type": "success",
    "code": "0",
    "detail": "unlock",
    "description": "Unlock processed successfully",
    "uuid": "2df61337-c0c5-4b90-ab8c-6098c8b118ce",
    "request_id": "5901ba6d7710014a2c89",
    "payload": {
        "reconciliation": "1234-sipay",
        "order": "sipay-order-001",
        "transaction_id": "000024899463550243139",
        "code": "0"
    }
}