Registro de un cliente
Realiza el registro de un cliente dentro de los sistemas de Pagando Check para ser usado posteriormente en el procesamiento de una transacción. El servicio genera un identificador único del cliente que es utilizado para servicios de procesamiento de pagos. Este servicio generará registros de clientes nuevos siempre y cuando no coincida con clientes existentes previamente guardados.
A menos de que no se cuente con la información para una consulta posterior, no es necesario guardar el identificador del cliente.
Tipo de petición: POST
Ruta de petición: https://api.pagandocheck.com/v1/pagando/users/user
Headers: Autorization: Bearer <token provisto>
Campo | Tipo | Descripción | Requerido |
---|---|---|---|
email | String | Correo electrónico del cliente. | true |
name | String | Nombre del cliente separado por espacios (máximo 30 caracteres). | true |
lastName | String | Primer apellido del cliente (máximo 30 caracteres). | true |
secondLastName | String | Segundo apellido del cliente (máximo 30 caracteres). | true |
phone | String | Número telefónico del cliente. | true |
birthday | String | Día de nacimiento del cliente. (DD/MM/AAAA) | true |
Ejemplo de parámetros
{
"email": "mail@gmail.com",
"name": "Juan Manuel",
"lastName": "Hernandez",
"secondLastName": "Gutierrez",
"phone": "6142345678",
"birthday": "09/01/1990"
}
Ejemplo de respuesta
Todas las respuestas de API se encuentran homologadas para asegurar consistencia con el cliente, puedes conocer más a fondo esto en el glosario de respuestas.
Así mismo, los campos generales type
, key
, message
, code
vienen explicados en ese mismo glosario.
Respuesta exitosa
{
"type": "API_AUTHENTICATION",
"key" : "USER",
"message": "user",
"code": 1,
"data": {
"userId": "20f6c660-e7cd-4f0a-9b97-f9d18fcc950c"
}
}
Explicación de campos
Campo | Explicación |
userId | Identificador del cliente |
Respuesta con error
Código | Mensaje | Explicación |
---|---|---|
1 | user | Creación de cliente exitosa |
102 | The email address is invalid | El formato utilizado para el email es inválido. |
103 | Data was omitted when creating the user | Se ha omitido o hubo un error en el formato de algún parámetro importante en la petición de creación de usuario. |
104 | It was not possible to associate the user with the organization | Hubo un problema al asignar el cliente agregado a la organización. |
107 | Authorization header not found | No se mando el token de autorización en la cabecera de la petición. |
Tokenización de tarjeta
Para realizar el procesamiento de una transacción requiere la tokenización previa de la tarjeta con la que realizara el pago. Este es un procedimiento para reforzar la seguridad de las transacciones.
Para realizar esta petición es necesario realizar una creación de cliente previo.
Tipo de petición: POSt
Ruta de petición: https://api.pagandocheck.com/v1/pagando/payment_methods/add_card
Headers: Autorization: Bearer <token provisto>
Parámetros
Campo | Tipo | Descripción | Requerido |
---|---|---|---|
userId | String | Identificador del cliente al que pertenece la tarjeta | true |
pan | String | Los 15 ó 16 dígitos de la tarjeta a tokenizar | true |
cvv | String | 3 o 4 dígitos del código de validación que se encuentra al reverso de la tarjeta | true |
exp_month | String | Mes de expiración de la tarjeta expresado en dos números. | true |
exp_year | String | Año de expiración de la tarjeta expresado en 2 dígitos. | true |
name | String | Nombre del tarjetahabiente como viene en la tarjeta, no debe de contener números. | true |
street | String | Calle del domicilio registrado en la tarjeta | false |
noExt | String | Número exterior del domicilio registrado en la tarjeta | false |
district | String | Colonia del domicilio registrado en la tarjeta | false |
zipCode | String | Código postal del domicilio registrado en la tarjeta | false |
city | String | Ciudad del domicilio registrado en al tarjeta | false |
state | String | Estado del domicilio registrado en la tarjeta | false |
Country | String | País en el que se emitió la tarjeta, el cual debe de ser enviado en formato ISO 3166 | false |
Ejemplo de parámetros
{
"userId": "e13452da-847d-4281-ae3a-96cb8e6d35c5",
"pan": "1111111111111111",
"cvv": "171",
"exp_month": "02",
"exp_year": "23",
"name": "FRANCISCO TORRES BENAVIDES",
"street": "Diego Rivera",
"noExt": "720",
"district": "Insurgentes",
"zipCode": "31104",
"city": "Chihuahua",
"state": "Chihuahua",
"country": "MX"
}
Ejemplo de respuesta
Todas las respuestas de API se encuentran homologadas para asegurar consistencia con el cliente, puedes conocer más a fondo esto en el glosario de respuestas.
Así mismo, los campos generales type
, key
, message
, code
vienen explicados en ese mismo glosario.
Respuesta exitosa
{
"type": "API_CARD",
"key" : "NEW_CARD",
"message": "The card has been successfully registered.",
"code": 33,
"data": {
"cardId": "cd_udplmzrbm-re7u9b",
"brand": "MASTERCARD"
}
}
Explicación de campos
Campo | Explicación |
cardId | Identificador de la tarjeta tokenizada |
brand | Marca de la tarjeta registrada |
Respuesta con error
{
"type": "API_AUTHENTICATION",
"key": "USER_ID_INVALID",
"message": "There is no user for the provided userId",
"code": 101,
"data": null,
"error": true
}
Posibles códigos de respuesta
Código | Mensaje | Explicación |
---|---|---|
33 | The card has been successfully registered. | Creación de tarjeta exitosa. |
200 | The card number is invalid. Check the card details or use a different card. | El formato del número de la tarjeta no es válido o no fue recibido. |
201 | The card’s security code is invalid. Check the card’s security code or use a different card. | El formato del cvv proporcionado es inválido o no fue recibido. |
202 | The name of the card does not match the name of the record provided. | El nombre del usuario dado de alta y el nombre proporcionado para la tarjeta no coinciden. |
203 | Could not assign card to selected user. | Hubo un problema al asignar la tarjeta al cliente. |
204 | The card information is not correct. | Hubo un error de formato en los campos de mes y año de expiración, o no se recibieron al dar de alta la tarjeta. |
205 | Missing card address information in request. | Se ha omitido o hubo algún error en el formato de los parámetros que corresponden a la dirección de la tarjeta cuando la misma se intentaba guardar. |