Procesar Pago
POST
/paymentInicia el procesamiento de pago para una factura de servicios.
Objetivo
Este endpoint permite iniciar una operación de pago de servicios indicando la deuda específica, el monto y los datos del cliente.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-authorization-token | String | Sí | Token de autenticación obtenido en el login. |
x-api-key | String | Sí | API Key proporcionada para el acceso a la API. |
Body Parameters
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
debtId | String | Sí | ID de la deuda específica que se quiere procesar. |
amount | Number | Sí | Monto a pagar. |
paymentMethod | String | Sí | Método de pago. Valores posibles: ACCOUNT, DEBIT, CREDIT. |
externalPaymentId | String | Sí | ID de la operación provisto por el cliente. |
paymentDetails | Object | No | Información adicional relacionada a la operación. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
operationId | String | ID único de la operación generada. |
createdAt | Datetime | Fecha y hora de creación de la operación. |
companyCode | String | Código de la compañía. |
companyName | String | Nombre de la compañía. |
amount | Number | Monto del pago. |
identifiers | Object[] | Identificadores utilizados para el pago. |
agent | String | Nombre del agente procesador. |
clientUsername | String | Nombre del cliente fintech que realizó la operación. |
externalClientId | String | ID del usuario final asignado por el cliente. |
externalPaymentId | String | ID de la operación provisto por el cliente. |
additionalData | Object | Información adicional relacionada a la operación. |
Consideraciones
- Este servicio inicia una operación de pago y devuelve su identificador único.
- El monto debe estar dentro del rango permitido para la deuda (entre minAmount y maxAmount).
- Si algún campo obligatorio es inválido o falta, se responderá con error 400.
- Una vez iniciado el pago, use el operationId para consultar el estado con el endpoint /status.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request POST \
--url https://services.homo.tapila.cloud/payment \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
"debtId": "222ba02e-b7a2-40d4-b2cb-3445bf4ba2f3-0",
"amount": 851,
"paymentMethod": "ACCOUNT",
"externalPaymentId": "payment-456",
"paymentDetails": {}
}'