Menú: API reference

Cloud API · Pagos

Consultar un pago

Devuelve el estado de un pago con long polling mientras siga en processing.

GET/terminals/:terminalId/payments/:paymentId/status
Ver la guía

Esta llamada debe hacerse con long polling mientras status siga en processing. El resultado se devuelve cuando el pago ha terminado en el terminal. Si se ha dejado propina, también se indica su importe.

Cabeceras

Nombre Valor
Content-Type application/json
Authorization Bearer <clientSecret>
venue-api-key El identificador del restaurante

Respuesta

JSON
{
    "status": "completed",
    "tip": 0,
    "metadata": { "key": "value" },
    "entryMode": "contactless",
    "last4": "4242",
    "cardBrand": "VISA",
    "cardCategory": "CLASSIC",
    "cardCountryCode": "ES",
    "cardType": "DEBIT"
}

Valores de status:

  • processing
  • cancelled
  • timed_out
  • not_completed
  • declined
  • completed

Valores de entryMode:

  • manual_entry
  • magnetic_stripe
  • chip_card
  • contactless
  • qr_code

Otros campos:

  • cardBrand: marca de la tarjeta, como Visa, Mastercard o American Express.
  • cardCountryCode: código ISO del país.
  • cardType: tipo de tarjeta, débito o crédito.
JSON
{
    "status": 403,
    "message": "Not authorized"
}

Se devuelve si alguna cabecera es incorrecta.