Menú: API reference

Cloud API · Pagos

Iniciar un pago

Abre en el terminal la pantalla para pasar la tarjeta e inicia un nuevo pago.

POST/terminals/:terminalId/init-payment
Ver la guía

Esta llamada abre en el terminal correspondiente la pantalla para pasar la tarjeta.

Cabeceras

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

Cuerpo

JSON
{
    "amount": 12.5,
    "currency": "EUR", // formato ISO 4217
    "metadata": { "key": "value" } // opcional
}

Respuesta

JSON
{
    "paymentId": "67e565ca4116f4401ccbf789",
    "paymentStatusUrl": "{base}/v1/terminals/{terminalId}/payments/{paymentId}/status",
    "paymentAbortUrl": "{base}/v1/terminals/{terminalId}/payments/{paymentId}/abort"
}

El campo paymentStatusUrl siempre llega completo.

El campo paymentAbortUrl solo llega si el terminal permite cancelar.

JSON
{
    "status": 400,
    "message": "Bad Request",
    "reason": "Invalid type for currency: expected string, but got undefined"
}
JSON
{
    "status": 403,
    "message": "Not authorized"
}

Se devuelve si alguna cabecera es incorrecta.