Menú: API reference

Local API

Iniciar un pago

Abre en el terminal la pantalla para pasar o acercar la tarjeta. Responde de inmediato.

POST/device-bridge/init-payment
Ver la guía

Esta llamada va firmada: consulta Autenticación.

Esta llamada abre en el terminal la pantalla para pasar o acercar la tarjeta. Responde de inmediato: no espera a que el cliente pague.

Cuerpo

JSON
{
    "ref": "abc123",
    "amount": 12.5,
    "counter": 1,
    "hmac": "<firma calculada>"
}
Nombre Tipo Descripción
ref string Un identificador que generas tú para este pago. El mismo ref siempre devuelve el mismo resultado: nunca se reutiliza para un segundo cobro.
amount number Importe que se cobra, en la unidad principal de la moneda del terminal (por ejemplo 12.50, no céntimos).
counter number Consulta Autenticación.
hmac string Consulta Autenticación.

Respuesta

JSON
{
    "ref": "abc123",
    "status": "processing",
    "hmac": "<firma>"
}

El cobro ya se está ejecutando en segundo plano. Consulta el resultado con el endpoint de estado.

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

Otro valor posible de reason: invalid_request (falta ref).

JSON
{
    "reason": "invalid_signature"
}

También puede devolver {"reason": "not_provisioned"} si aún no se ha emitido un secreto de firma para este terminal.

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

Se devuelve si ya hay otro cobro o devolución en curso en este terminal.