Descripción

Con este endpoint, podrás obtener los tokens de las tarjetas que tiene cierto usuario, así como información adicional.

Method: get
URL: https://{enviroment-domain}/api/v1/Card/get-cards

Agregar encabezados de autenticación

Ejemplo:

Query Params:
MerchantId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
CustomerId: IdUser

https://{enviroment-domain}/api/v1/Card/get-cards?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&CustomerId=IdUser

Descripción de campos

Campo	Descripción
`MerchantId`	Identificador único del comerciante en la pasarela de pago, es asignado al momento de crear la cuenta.
`CustomerId`	Identificador único del cliente. Este identificador lo asigna el propio comercio, es de tipo alfanumérico y no mayor a 100 caracteres.

Ejemplo de respuesta exitosa

Http code 200

{
    "payload": {
        "cards": [
            {
                "token": "9f73be1b-720a-4edf-a27b-e3547d88842d",
                "cardInfo": {
                    "bin": "494134",
                    "last4Numbers": "9161",
                    "cardBrand": "Visa"
                },
                "cardHolderInfo": {
                    "cardholderName": "",
                    "cardholderLastName": "",
                    "email": "",
                    "address": "",
                    "zipCode": ""
                },
                "isDefault": true
            },
            {
                "token": "f4f36c7a-125d-4284-b46f-c6eff03c6b8e",
                "cardInfo": {
                    "bin": "528851",
                    "last4Numbers": "3853",
                    "cardBrand": "MasterCard"
                },
                "cardHolderInfo": {
                    "cardholderName": "",
                    "cardholderLastName": "",
                    "email": "",
                    "address": "",
                    "zipCode": ""
                },
                "isDefault": false
            }
        ]
    },
    "isSuccess": true
}

Ejemplos de respuesta con error

Http code 404

Usuario no existente

{
    "isSuccess": false,
    "errors": [
        {
            "key": "ResourceNotFoundException",
            "value": [
                "User does not exist: 3fa85f64-5717-4562-b3fc-2c963f66afa6 UserTest1222"
            ]
        }
    ]
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Payload`	Respuesta solicitada a nuestro sistema.
`Cards`	Lista de tarjetas del usuario.
`Token`	Token asignado a la tarjeta.
`CardInfo`	Encapsula la información de la tarjeta.
`Bin`	Número de Identificación Bancaria de la tarjeta.
`Last4Numbers`	Últimos 4 dígitos de la tarjeta.
`CardBrand`	Marca de la tarjeta
`CardHolderInfo`	Encapsula la información del titular de la tarjeta.
`CardholderName`	Nombre del titular de la tarjeta (dato opcional).
`CardholderLastName`	Apellido del titular de la tarjeta (dato opcional).
`Email`	Correo electrónico del titular de la tarjeta (dato opcional).
`Address`	Dirección del titular de la tarjeta (dato opcional).
`ZipCode`	Código postal del titular de la tarjeta (dato opcional).
`IsDefault`	Indica si la tarjeta está marcada como default.
`Errors`	Una lista de errores que ocurrieron en la petición.
`Key`	Llave del error
`Value`	Breve descripción del error.

📘
CONSIDERACIONES IMPORTANTES

Los campos MerchantId y CustomerId son obligatorios.

Las tarjetas que regresamos son vigentes.

Si nuestro sistema detecta una tarjeta expirada, sólo la mantendremos por 2 meses después de su fecha de expiración, después de esto, serán borradas automáticamente.