Local API

Iniciar una devolución

Comprueba que el pago se puede devolver y, si es así, inicia la devolución en el terminal.

POST/device-bridge/payments/:ref/refund

Esta llamada va firmada: consulta Autenticación.

:ref es un identificador que generas tú para esta devolución. No tiene por qué coincidir con el ref del pago original.

Cuerpo

JSON

{
    "paymentId": "67e565ca4116f4401ccbf789",
    "amount": 12.5,
    "counter": 2,
    "hmac": "<firma calculada>"
}

Nombre	Tipo	Descripción
`paymentId`	string	El `paymentId` que devolvió la consulta de estado del pago original.
`amount`	number	Importe que se devuelve. No puede superar lo que queda por devolver del pago.
`counter`	number	Consulta Autenticación.
`hmac`	string	Consulta Autenticación.

Respuesta

202 Accepted

JSON

{
    "ref": "refund-1",
    "status": "processing",
    "hmac": "<firma>"
}

El pago ha pasado la comprobación y la devolución ya se está ejecutando en segundo plano. Consulta el resultado con el endpoint de estado.

200 OK: rechazada antes de empezar

JSON

{
    "ref": "refund-1",
    "status": "declined",
    "reason": "You cannot refund more than the payment amount",
    "hmac": "<firma>"
}

Se devuelve en lugar de 202 si el pago no se puede devolver, y el lector de tarjetas no llega a activarse. reason es uno de los mensajes de esa comprobación: pago no encontrado, no completado, ya devuelto o importe superior a lo que queda por devolver.

400 Bad Request

JSON

{
    "ref": "refund-1",
    "reason": "invalid_request"
}

Se devuelve si paymentId o amount faltan o no son válidos.

409 Conflict

JSON

{
    "ref": "refund-1",
    "reason": "busy"
}

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