Clients
Información sobre endpoints relacionados con la entidad Clientes Finales (Clients) de un Merchant
Last updated
Información sobre endpoints relacionados con la entidad Clientes Finales (Clients) de un Merchant
Last updated
GET
/api-hub/v1/clients/{term}
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
status : El estado tiene que estar activo, si no es el caso hay un endpoint para reactivar al usuario
provider_reference : Es el código de Unibanca
internal_reference : Rastreo interno del cliente del negocio
POST
/api-hub/v1/clients
internal_reference Rastreo interno del cliente del negocio
provider_reference Es el código de Unibanca
status El estado tiene que estar activo, si no es el caso hay un endpoint para reactivar al usuario
POST
/api-hub/v1/clients/reactive
status : El estado tiene que estar activo, si no es el caso hay un endpoint para reactivar al usuario
provider_reference : Es el código de Unibanca
internal_reference : Rastreo interno del cliente del negocio
GET
/api-hub/v1/clients/{client_id}/cards
Definiciones de campos
document_type DNI, CE, PAS, RUC, PTP
gender F ⇒ FEMENINO, M ⇒ MASCULINO
birth_country ISO 3
birth_date YYYY-MM-DD
residence_country ISO 3
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
term*
String
El valor puede ser el CLIENT_ID, el INTERNAL_REFERENCE del cliente o el DOCUMENT_NUMBER
timestamp*
String
El valor debe ser en formato UNIX, comprendido por 13 dígitos. En javascript se puede usar la función Date.now() = 1664568045547
authorization-token*
String
Se envía el token generado luego del Login, y debe contar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
document_type*
String
El tipo de documento debe de ser DNI, CE, PAS, RUC o PTP.
document_number*
String
Para el valor del número de documento está relacionado con el document_type, en la cantidad de dígitos.
first_name*
String
El primer nombre del cliente.
second_name
String
El segundo nombre del cliente.
first_last_name*
String
El apellido paterno o primer apellido del cliente.
second_last_name
String
El apellido materno o segundo apellido del cliente.
gender*
String
El género del cliente debe de ser F (Femenino) o M (Masculino).
birth_country*
Date
El país de nacimiento debe de ser en formato ISO 3.
birth_date*
String
La fecha de nacimiento debe de ser en formato (YYY-MM-DD).
residence_address*
String
La dirección de residencia del cliente.
residence_country*
String
El país de residencia debe de ser en formato ISO 3.
residence_city*
String
La ciudad de residencia del cliente.
residence_zip_code*
String
El código postal de residencia del cliente.
phone_country_code*
String
El código de país del teléfono del cliente.
phone_number*
String
El número de teléfono o celular del cliente.
email*
String
La dirección de correo electrónico del cliente.
occupation*
String
La ocupación o carrera profesional del cliente.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
id*
UUID
El identificador de cliente, en formato UUID.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
client_id*
UUID
El identificador del cliente.
page*
Number
El número de página del listado.
per_page
Number
El cantidad de elementos vistos en el listado.
status
ACTIVE | INACTIVE
Filtrar por el estado de las tarjetas.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende de todos los campos enviados por el query, ordenados de forma alfabética y el secret-key.