Tapi Logo

Recomendamos ingresar en Desktop

Nuestra documentación y herramientas de integración están optimizadas para brindarte la mejor experiencia en computadora.

Por favor, accede desde una computadora para continuar.

Referencia API

Procesar Pago

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
StringSíAPI Key provista para acceder al endpoint.
x-authorization-token
StringSíToken de autenticación generado en el login.

Body Parameters

ParámetroTipoRequeridoDescripción
companyCode
StringSíCódigo de la compañía de recarga.
productId
StringSíID del producto de recarga.
amount
NumberSíMonto de la recarga.
identifierName
StringSíNombre del identificador (ej: BA1, IDC).
identifierValue
StringSíValor del identificador (ej: número de teléfono).
paymentMethod
StringSíMétodo de pago utilizado. Valores posibles: DEBIT, ACCOUNT, CREDIT.
externalPaymentId
StringSíID único de la operación generado por el cliente.
externalClientId
StringSíID 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.

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.
Ver la librería de errores de esta referencia

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://recharge.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": "",
  "identifierName": "",
  "identifierValue": "",
  "paymentMethod": "",
  "externalPaymentId": "",
  "externalClientId": ""
}'