Operation status

(GET /all-in-one)

It allows query the status of the operation.

• Request_id (string): Operation identifier to query.

• key (string): Value provided by Sipay.

• nonce (string): Unique identifier provided by merchant. It allows to cotrol duplicated transactions (idempotency).

• mode (enum[string]): Signature algorithm.

  • sha256
  • sha512

• resource (string): Resource identifier.

Request example

https://sandbox.sipay.es/mdwr/v1/all-in-one/5fd337a071503f00018e1372?key=589365da65c48cff87d0874a&resource=359ef8ce5c5f4003b71692e446908c27&nonce=1234567890&mode=sha256

Success - 0

• code (string): Internal operation code. Refer to Response Codes 0
• status (string): Status of the operation, the following states can be returned:
  • created (string): Authentication request created.
  • authenticated (string): Operation authenticated.
  • not_authorized (string): Operation not authorized.
  • authorized (string): Operation authorized.
• applied_exemption (string): Indicates the exemption applied in the operation.
• challenge_requested (string): Indicates whether completing the 3DSecure protocol was requested (true) or not (false).
• remaining_amount (string): Amount pending authorization.
• amount (string): Amount of the operation.

Response example

{
 "code": "0",
 "detail": "operation_status",
 "request_id": "5fd0efb37760fa00012692bf",
 "description": "Operation status",
 "type": "success",
 "payload": {
 "remaining_amount": 11,
 "amount": 11,
 "applied_exemption": null,
 "challenge_requested": true,
 "status": "not_authorized"
 },
 "uuid": "e709b433-efcb-447d-8ae3-090c4d684625"
}

Response example -1

{
    "uuid": "e9920f6f-2d24-4059-b898-eeb139ddc979",
    "description": "The transaction ID given was not found",
    "payload": {},
    "type": "error",
    "detail": "transaction_id_not_found",
    "code": "-1",
    "request_id": "5fd337a071503f00018e1372"
}