API
Saltar al contenido principal

Enviar solicitud de pago

Flujo de Pago

El proceso de pago con el terminal cloud implica la comunicación entre su sistema y el terminal:

1. Inicio del Pago (a través de API)

Su sistema inicia el pago de forma remota a través de la API de PayPay:

  1. El sistema envía la solicitud a la API de PayPay:
Endpoint
POST /terminals/{uuid}/payments
Ejemplo básico
{
"amount": 100,
"code": "sale-code",
"summary": "sale-description"
}
Parámetros
ParámetroTipoObligatorioDescripción
uuidstringUUID del terminal al que se enviará la solicitud de pago
amountintegerImporte
codestringNoCódigo indicado por el comerciante, por ejemplo, código de pedido del sistema
summarystringNoDescripción indicada por el comerciante, por ejemplo, descripción del pedido del sistema
  1. La API PayPay se comunica con el terminal de forma assíncrona;
  2. El terminal recibe y muestra automáticamente el importe al operador;
información
El terminal espera 1 minuto por la presentación de la tarjeta.
  1. La API de PayPay devuelve la respuesta del éxito o fracaso de la solicitud asíncrona, mientras que el terminal espera a que se presente la tarjeta.
Respuesta de la API
{
"date": "2025-09-01T13:06:22+01:00",
"success": true,
"data": {
"id": "1",
"clientId": "502056800",
"type": "payment",
"amount": 100,
"stateDetails": {
"state": "pending_confirmation",
"createdAt": "2025-09-01T13:06:22+01:00"
},
"paymentMethod": {
"code": "CC",
"type": "TPA"
},
"code": "order-code",
"summary": "product-description",
"availableMethods": [
{
"code": "CC",
"type": "TPA",
"name": "Credit\/Debit card Physical TPA"
}
],
"bankAccount": {
"code": "O9uFVmSZ",
"bankName": "Banco",
"last4digits": "8513"
},
"createdAt": "2025-09-01T13:06:22+01:00",
"updatedAt": "2025-09-01T13:06:22+01:00"
}
}

Estructura de la Respuesta

CampoTipoDescripción
idstringID del pago PayPay
clientIdstringNIF de la entidad a la que se asoció el pago
typestringTipo de operación
stateDetails.statestringEstado del pago
stateDetails.createdAtdatetimeFecha del estado
paymentMethodobjectMétodo de pago seleccionado para el pago
codestringCódigo indicado por el comerciante
summarystringDescripción indicada por el comerciante
availableMethodsobjectFormas de pago disponibles para el pago
bankAccountobjectIdentificación del banco que recibirá los fondos
createdAtdatetimeFecha de creación del registro
updatedAtdatetimeFecha de la última actualización

información

La estructura de la respuesta varía en función de los parámetros enviados en la solicitud. Por ejemplo, si envía información del cliente (customer) esta también se devuelve.

  1. Flujo de Pago en el terminal