Saltar al contenido principal

Conseguir un titular de la tarjeta

Esta operación consulta a un titular de tarjeta utilizando varios filtros de parámetros. Si se utilizan varios parámetros para realizar la búsqueda, se concatenarán con el operador AND. Se debe especificar al menos un filtro de parámetros.

Solicitud HTTP

  • GET /cardholders

Parámetros del encabezado

EncabezadoDescripción
Authorization
requerida
El bearer token creado en
 Obtener token de autorización
Content-Type
requerido
application/json

Parámetros de consulta

ParámetroTipoPatrónDescripción
id
opcional
cadenaUUIDEl card_id a buscar.
rfc
opcional
cadena10-13 caracteresEl rfc para buscar.
curp 
opcional
cadena18 caracteresEl curp a buscar.
email
opcional
cadena5-100 caracteresEl email a buscar.
primary_phone 
opcional
cadena10 dígitosEl primary_phone a buscar.
mobile_phone
opcional
cadena10 dígitosEl mobile_phone a buscar.

Ejemplo de solicitud JSON:

GET /cardholders?id=ec123456-1qq2-1234-tt5g-8873fe52bf54

Ejemplo de respuesta JSON:

{
"success": true,
"code": 0,
"message": "OK",
"data": {
"cardholder": {
"id": "ec123456-1qq2-1234-tt5g-8873fe52bf54",
"first_name": "John",
"second_name": "Doe",
"surname": "González",
"second_surname": "Pérez",
"rfc": "XAXX010101000",
"curp": "XEXX010101HNEXXXA4",
"email": "[email protected]",
"primary_phone": "5555555555",
"mobile_phone": "5555555555",
"address": {
"street": "Av. Siempre",
"external_street_number": "#12",
"internal_street_number": "Lt3.",
"suburb": "Nápoles",
"township": "Benito Juárez",
"city": "Ciudad de México",
"state": "CDMX",
"postal_code": "55120",
"country": "484"
},
"birthdate": "1995-09-22",
"gender": "M",
"gross_monthly_income": 20000,
"net_monthly_income": 20000,
"observations": "",
"has_kids": true,
"marital_status": "CASADO",
"external_id": "123",
"accounts": [
{
"id": "cca4c4a5-504e-4fa4-bafc-a947bcf77f4e",
"account_number": 555555555,
"creation_date": "2020-11-25T18:00:00.000-06:00",
"activation_date": null,
"assigned_by": "161549d5-644b-4df2-bfc8-4b3df2e6a327",
"status": "ACTIVE",
"document": {
"type": "INE",
"number": "321321321321321"
},
"cards": [
{
"id": "12123214-2e34-4fff-844f-321654987123",
"last_four": "1234",
"assignation_date": "2020-11-26T02:26:32.066-06:00",
"status": "ACTIVE",
"assigned_by": {
"id": "161549d5-644b-4df2-bfc8-4b3df2e6a327",
"alias": "API_KEY",
"name": "WS_NAME",
"description": ""
}
}
]
}
]
}
}
}