Skip to main content

Documentación

Terminal Responses

The customer polls the API with the poll id using the /poll/terminalresponse/{pollId} endpoint. The latest terminal response is delivered in the response.

Contract

The following contract is delivered in the response body. All properties are optional and the endpoints must not fail if new properties are added. Properties will never be removed from the contract.

      • {
  "eventType": "NONE",
  "callbackUrl": "string",
  "correlationId": "string",
  "terminalResponse": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

These are the properties you must expect to receive for transaction-related events (such as SALE_COMPLETED or DISCOUNT_CARD_READ). Properties will never be removed from the contract.

      • "terminalResponse": {
    "cardholderReceipt": "string",
    "merchantReceipt": "string",
    "responseCode": "string",
    "result": "string",
    "transCancelled": "string",
    "cardTypeExtra": "string"
    "authorizationCode": "string",
    "amount": "string",
    "cardPan": "string",
    "stan": "string",
    "terminalId": "string",
    "merchantId": "string",
    "softwareVersion": "string",
    "retrievalReferenceNumber": "string",
    "longitude": "string",
    "latitude": "string",
    "radius": "string",
    "lastSync": "string"
}

These are the properties you must expect to receive for eventType TERMINAL_ERROR. Properties will never be removed from the contract.

      • "terminalResponse": {
    "errorMessage": "string"
}
Event types

  • SALE_RECEIVED - Terminal received the request (sent immediately, before card presentation or transaction processing begins). No action required by the client.

  • SALE_COMPLETED - The transaction successfully completed. Polling and receiving this response constitutes the acknowledgment. Do not use the deprecated /poll/confirmation endpoint.

  • SALE_CANCELLED - Cardholder or merchant have cancelled the transaction at the POS device. Final state for a transaction, no further actions available.

  • TERMINAL_BUSY - Terminal is processing another transaction. Exception: if the incoming request has the same referenceId as the current transaction, it is treated as a retry (not busy). Otherwise, retry to check for availability.

  • TERMINAL_ERROR - Terminal encountered an error (e.g., payment core not installed, or merchant configuration update failed such as terminalId not found). No cleanup required on behalf of the client.

En esta sección: