API Reference

Process Payment

POST/payment

Inicia el procesamiento de pago para una recarga.

Objetivo

Este webhook permite iniciar una operación de recarga indicando el producto, monto y método de pago.

Request

Headers

CampoTipoObligatorioDescripción
x-api-key
StringAPI Key provista para acceder al endpoint.
x-authorization-token
StringToken de autenticación generado en el login.

Body Parameters

CampoTipoObligatorioDescripción
companyCode
StringCódigo de la compañía de recarga.
productId
StringID del producto de recarga.
amount
NumberMonto de la recarga.
identifierValue
StringValor del identificador (ej: número de teléfono).
paymentMethod
StringMétodo de pago utilizado.
externalPaymentId
StringID único de la operación generado por el cliente.
externalClientId
StringID del usuario final asignado por el cliente.

Response

Response Body

ParámetroTipoDescripción
operationId
StringID único de la operación generada.
createdAt
DatetimeFecha y hora de creación de la operación.
companyCode
StringCódigo de la compañía.
companyName
StringNombre de la compañía.
amount
NumberMonto de la recarga.
identifiers
Object[]Identificadores utilizados para la recarga.
agent
StringNombre del agente procesador.
clientUsername
StringNombre del cliente fintech que realizó la operación.
externalClientId
StringID del usuario final asignado por el cliente.
externalPaymentId
StringID de la operación provisto por el cliente.
additionalData
ObjectInformación adicional relacionada a la operación.

Response Examples

200 OK

Consideraciones

  • Este servicio inicia una operación de recarga y devuelve su identificador único.
  • Si algún campo obligatorio es inválido o falta, se responderá con error 400.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://recharges.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 '{
  "companyCode": "",
  "productId": "",
  "amount": "",
  "identifierValue": "",
  "paymentMethod": "",
  "externalPaymentId": "",
  "externalClientId": ""
}'