Genera un card token con la información de una tarjeta proporcionada.
Recuerda que para consumir este endpoint es necesario comprobar que cuentas con la certificación PCI AoC (Attestation of Compliance) vigente. Da clic aquí para solicitar permiso.
Tokeniza la información de una tarjeta y obtén un card token id el cuál podrás usarla para realizar una transacción a través de la API de de Pagos.
El card token id tiene una vigencia de 15 mins y es de un solo uso.
Header parameters (parámetros del encabezado)
La siguiente tabla describe el esquema de los parámetros del encabezado:
|
Parámetro |
Descripción |
Tipo |
Requerido / Opcional |
Notas |
|
|
Content-Type |
Define el formato del objeto de la llamada |
application/json |
Requerido |
Solicitud en formato JSON |
|
|
Authorization |
Especifica el token de acceso. |
String |
Requerido |
auth_token |
|
Path parameters (parámetros de la ruta)
La siguiente tabla describe los parámetros path:
|
Parámetro |
Descripción |
Tipo |
Ejemplo |
Requerido / Opcional |
Notas |
|
|
card_number |
Número de la tarjeta |
String |
"5555444433332222" |
Requerido |
Número de 16 dígitos |
|
|
card_exp_month |
Mes de expiración de la tarjeta |
String |
"05" |
Requerido |
Mes representado en valor numérico |
|
|
card_exp_year |
Año de expiración de la tarjeta |
String |
"28" |
Requerido |
Año representado en valor numérico |
|
|
cvv |
Número de seguridad CVV de la tarjeta |
String |
"342" |
Requerido |
Código de seguridad de la tarjeta |
|
|
cardholder_name |
Nombre completo del tarjetahabiente |
String |
"John Doe Doe" |
Requerido |
Nombre completo incluyendo nombres y apellidos como están en la tarjeta |
|
Respuesta
La siguiente tabla describe el esquema de los elementos en la estructura de la respuesta:
|
Elemento |
Descripción |
Tipo |
Notas |
id |
Token de la tarjeta. |
String |
Número de identificación del token. Formato: UUID. |
last_digits |
Últimos 4 dígitos de la tarjeta. |
String |
|
bin |
Número BIN de la tarjeta. |
String |
Se regresan los primeros 8 dígitos de la tarjeta. |
brand |
Marca de la tarjeta. |
String |
Posibles valores: VISA, MASTERCARD, AMEX, CARNET. |
type |
Tipo de tarjeta. |
String |
Posibles valores: DEBIT, CREDIT. |
created_at |
Fecha de creación del token. |
Datetime |
Formato ISO 8601. |
bank |
Banco emisor de la tarjeta. |
String |
Nombre del banco emisor. |
cardholder_name |
Nombre del titular de la tarjeta. |
String |
Nombre completo como aparece en la tarjeta. |
expiration_month |
Mes de expiración de la tarjeta. |
Integer |
Mes de expiración en formato MM. |
expiration_year |
Año de expiración de la tarjeta. |
Integer |
Año de expiración en formato YYYY. |
Código de ejemplo
Ejemplo de una llamada.
El siguiente bloque de código muestra un ejemplo de la solicitud cURL:
curl --location 'https://api-secure.payclip.com/card_tokens' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json' \
--data '{
"card_exp_month": "05",
"card_exp_year": "28",
"card_number": "5555444433332222",
"cardholder_name": "John Doe Doe",
"cvv": "111"
}'
Ejemplo de un objeto de la respuesta
El siguiente objeto es una respuesta de éxito con código HTTP 201 OK:
{
"id": "0915e7-f6f-862-89e-0c5d71ae6",
"last_digits": "6634",
"bin": "55554444",
"brand": "MASTERCARD",
"card_type": "Credit",
"created_at": "2024-02-11T09:52:39.539003526Z",
"expires_at": "2024-02-11T10:07:39.539003526Z",
"card_exp_year": "28",
"card_exp_month": "05",
"cardholder_name": "John Doe Doe"
}
Códigos de respuesta
La siguiente tabla contiene una lista de los códigos de respuesta y su asociación con algunos de los estados HTTP:
|
Estado HTTP |
Error code |
Mensaje |
|
|
400 |
CL1103 |
card is expired |
|
|
400 |
CL2200 |
invalid card data |
|
|
400 |
CL2201 |
invalid card for token |
|
|
400 |
AI1300 |
bin not found. |
|
|
400 |
CL2290 |
"decoder_error" "json: cannot unmarshal ... |
|
|
401 |
CL1501 |
Unauthorized |
|
|
500 |
AI1899 |
Internal error. |
|
Este es un ejemplo del objeto de error en formato JSON:
{
"error_code": "CL1103",
"message": "Bad Request",
"detail": [
"card is expired"
]
}
Llamada de prueba
Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra a continuación.
Asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha:
Por último dale click en el botón "Try It!":
