Descripción

Con este endpoint, podrás obtener la información de un usuario previamente dado de alta en nuestro sistema.

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

Agregar encabezados de autenticación

Ejemplo:

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

https://{enviroment-domain}/api/v1/get-user?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": {
        "contractNumber": "123456789",
        "contactInfo": {
            "email": "[email protected]",
            "phoneNumber": "123456",
            "address": "address",
            "zipCode": "123"
        },
        "createdAt": "2025-08-25T17:41:35.0491795Z"
    },
    "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 IdUser"
            ]
        }
    ]
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Payload`	Respuesta solicitada a nuestro sistema.
`ContractNumber`	Identificador del contrato que se tiene con el cliente. Este identificador lo asigna el propio comercio, es de tipo alfanumérico y no mayor a 20 caracteres.
`ContactInfo`	Engloba toda la información de contacto del usuario.
`Email`	Correo del usuario (dato opcional).
`PhoneNumber`	Número telefónico del usuario (dato opcional).
`Address`	Dirección del usuario Máximo de 512 caracteres (dato opcional).
`ZipCode`	Código postal del usuario. Máximo de 16 caracteres (dato opcional).
`CreatedAt`	Fecha de creación del usuario en nuestro sistema en UTC.
`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.