Solicitud de envío de token transaccional

Procesa la solicitud de envío de un token transaccional (generalmente el token se entregará al usuario a través de un mensaje SMS).

Endpoint	Verbo	Requiere autenticación
http://localhost/api/app/tokens/send	POST	[ 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",  
  "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 solicita la generación de un token transaccional.	[ Si ]
DocNumber	string	Número de documento del usuario para el que se solicita la generación de un token transaccional.	[ Si ]
Metadata	string	Metadatos asociados personalizados para el TPS.	[Opcional]
Tags	string	Colección de claves y valores con información asociada para la generación del token Tags.	[Opcional]
AccountType	string	Identificador del tipo de cuenta de donde se tomarán los fondos de la transacción. Cuando se utiliza, este valor deberá coincidir con el recibido en el campo `AccountType` de la transacción financiera para la que se intenta utilizar el token como medio de pago. Si no se establece, el token podrá ser utilizado en cualquier tipo de cuenta.	[Opcional]
Amount	int	Valor de la transacción para la que se utilizará el token. Cuando se utiliza, este valor deberá ser menor o igual que el recibido en el campo `Amount` de la transacción financiera para la que se intenta utilizar el token como medio de pago. Si no se establece, el token podrá ser utilizado para cualquier valor.	[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}$	[ No ]
CardAcceptorId	Código que el adquiriente asigna al comercio desde donde se realiza la transacción.	^\w{1,15}$	[ No ]
CustomerGroup	Identificador del grupo familiar al que pertenece el afiliado.	^\d{1,2}$	[ No ]
Pan	Últimos 4 dígitos del número de tarjeta utilizado para la transacción.	^\d{4}$	[ No ]

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 se envió satisfactoriamente al usuario.
503	int	No fue posible entregar el token transaccional al usuario. No se encontró en el sistema o no se tiene información para la entrega.
417	int	No se pudo enviar el token, el campo `ReasonPhrase` contiene un mensaje que describe de forma detallada el resultado.

Cuando el estatus de la operación es 200 (exitoso), el cuerpo de la respuesta puede incluir un diccionario con datos relevates para la operación (opcionales):

{
  "Email": "nombre@servidor.com"
}

Ejemplo en Postman

POSTMAN