Menú: API reference

Local API

Consultar pago o devolución

Devuelve el estado de un pago o una devolución a partir de su ref.

GET/device-bridge/payments/:ref/status
Ver la guía

Consulta con short polling mientras status siga en processing. Usa el ref del pago o el que generaste para la devolución. counter y hmac se envían como parámetros de consulta.

Respuesta de un pago

JSON
{
    "ref": "abc123",
    "status": "completed",
    "tip": 0,
    "entryMode": "contactless",
    "last4": "4242",
    "cardBrand": "visa",
    "cardCategory": null,
    "cardCountryCode": null,
    "cardType": null,
    "paymentId": "67e565ca4116f4401ccbf789",
    "hmac": "<firma>"
}

Valores de status: processing, completed, declined, error.

JSON
{
    "ref": "abc123",
    "reason": "not_found"
}

Se devuelve si el terminal no conoce el ref: o nunca se envió, o su resultado ha caducado tras 7 días.

Respuesta de una devolución

JSON
{
    "ref": "refund-1",
    "status": "completed",
    "refundId": "6aa9551eb5df24b859a80b9c",
    "amount": 12.5,
    "paymentId": "67e565ca4116f4401ccbf789",
    "hmac": "<firma>"
}

Valores de status: processing, completed, declined, error.

JSON
{
    "ref": "refund-1",
    "reason": "not_found"
}