Giftcard Purchase Confirmation
POST
/paymentPermite confirmar y registrar el resultado final de una operación de giftcard.
Objetivo
Este endpoint permite realizar la compra de subscripciones y pines digitales. Una vez completada la transacción exitosamente, la respuesta incluye el código de activación necesario para que el usuario final pueda activar y utilizar su giftcard en la plataforma correspondiente.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-api-key | String | Sí | API Key requerida para validar la autenticidad del mensaje. |
Body Parameters
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
status | String | Sí | Resultado de la operación (confirmed o failed). |
operationId | String | Sí | ID de la operación previamente iniciada. |
companyCode | String | Sí | Código de la compañía asociada al producto. |
productId | String | Sí | Identificador del producto asociado a la operación. |
externalPaymentId | String | Sí | ID de la operación provisto por el cliente. |
externalClientId | String | Sí | ID del usuario final asignado por el cliente. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
operationId | String | ID de la operación. |
createdAt | String | Fecha y hora de creación de la operación. |
companyCode | String | Código de la compañía asociada al producto. |
companyName | String | Nombre de la compañía. |
amount | Number | Monto de la transacción. |
activatePin | String | PIN de activación para la giftcard. |
clientUserName | String | Nombre de usuario del cliente. |
externalClientId | String | ID del usuario final asignado por el cliente. |
externalPaymentId | String | ID de la operación provisto por el cliente. |
additionalData | Object | Datos adicionales de la operación. |
Response Examples
200 OK
Consideraciones
- Este endpoint debe ser implementado por el cliente para recibir la confirmación de resultado de TAPI.
- El campo 'status' puede ser 'confirmed' o 'failed'.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request POST \
--url https://suscriptions.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 '{
"status": "confirmed",
"operationId": "",
"companyCode": "",
"productId": "",
"externalPaymentId": "",
"externalClientId": ""
}'