Pago con token
Procesa una solicitud financiera de compra(compra), utilizando un token transaccional como método de validación.
Verbo | Endpoint | Requiere autenticación |
---|---|---|
POST | http://localhost/api/app/financial/payment | [ Si ] |
[^Segmentos de URL]: La información entre corchetes en la URL se denomina segmentos de URL y aplican solo para algunas operaciones. Cuando aparezcan en un ejemplo, deben ser reemplazados por sus valores correspondientes omitiendo los corchetes. Por ejemplo, sin en la URL de ejemplo apareciera http://localhost/api/operation/value/{value}, para establecer el valor de value
en la solicitud a la cadena abc
, la URL final se vería de la siguiente forma: http://localhost/api/operation/value/abc
Datos de la solicitud (body)
{
"DocType": "CC",
"DocNumber": "123456789",
"AccountType": "80",
"Token": "0000000",
"Amount": 99999,
"Metadata" : "RANDOM_DATA_BY_ACQUIRER"
}
Valores de la solicitud
Campo | Tipo de dato | Descripción | Requerido |
---|---|---|---|
DocType | string | Tipo de documento del usuario para el que se generó el token transaccional. | [ Si ] |
DocNumber | string | Número de documento del usuario para el que se generó el token transaccional. | [ Si ] |
Token | string | Valor del token transaccional generado para el usuario. Generalmente le será entregado en un mensaje SMS. | [ Si ] |
AccountType | string | Identificador del tipo de cuenta de donde se toman los fondos para la transacción. Generalmente este valor lo debe "ingresar/seleccionar/establecer" el usuario y/o comercio en el punto de pago. Corresponde con una lista de valores predefinidos por Evertec Colombia. | [ Si ] |
Amount | int | Valor de la transacción (compra). Cantidad de dinero que se desea autorizar. | [ Si ] |
Metadata | string | Metadatos asociados personalizados para el TPS. | [Opcional] |
Tags | string | Colección de claves y valores con información asociada con la transacción Tags. | [Opcional] |
Tags
Una colección de claves y valores (ambos de tipo string), que representan información relacionada con la transacción. Todos los valores son opcionales, pero si se envian, deben cumplir con los siguientes formatos:
Claves admitidas | Descripción | Formato admitido | Requerido |
---|---|---|---|
TerminalId | Código que el adquiriente asigna al punto dentro del comercio desde donde se realiza la transacción. | ^\w{1,8}$ | [Opcional] |
CardAcceptorId | Código que el adquiriente asigna al comercio desde donde se realiza la transacción. | ^\w{1,15}$ | [Opcional] |
CustomerGroup | Identificador del grupo familiar al que pertenece el afiliado. | ^\d{1,2}$ | [Opcional] |
Pan | Últimos 4 dígitos del número de tarjeta utilizado para la transacción. | ^\d{4}$ | [Opcional] |
Cuando se utiliza el campo Tags en una solicitud, es necesario establecer la cabecera Content-Type al valor application/json
Ejemplo de Tags
{
"TerminalId": "XXXXXXXX",
"CardAcceptorId": "XXXXXXXXXXXXXXX",
"CustomerGroup": "00",
"Pan": "1234"
}
Datos de la respuesta
Si al procesar la respuesta del servicio está utilizando un serializador que distinga mayúsculas y minúsculas, tenga en cuenta que Aspen genera todas sus respuestas utilizando el formato conocido como LowerCamelCase
Esta operación no retorna información adicional al código de estado de HTTP de acuerdo con la especificación RFC 2616. Si la respuesta no es HttpStatus
200, en el campo ReasonPhrase
de la respuesta encontrará un mensaje que describe de forma detallada el resultado de la operación.
Valores de respuesta más utilizados
HttpStatus | Tipo | Descripción |
---|---|---|
200 | int | El token de pago se validó satisfactoriamente y se realizó el descuento de los fondos monetarios en la cuenta del usuario. |
203 | int | El token de pago se validó satisfactoriamente, pero no se realizó el descuento de los fondos monetarios en la cuenta del usuario. La transacción fue reversada de forma automática. El campo Reason de la respuesta describe el problema que se encontró. |
404 | int | El token de pago no existe, no es válido, ya expiró o fue generado por un valor diferente. |
406 | int | El token de pago se validó satisfactoriamente, pero el autorizador financiero denegó la transacción. Puede examinar el cuerpo de la respuesta (Body) para extraer los valores de FinancialResponseCode y FinancialResponseMessage donde se encuentra el motivo del rechazo. |
Cuando el estatus de la operación es 200 (exitoso), el cuerpo de la respuesta incluye el número de autorización generado:
{
"AuthNumber": "999999"
}
Nota
Indiferentemente al código de la respuesta, el token transaccional utilizado se invalidará, ya que se trata de un OTP.