Descripción

Con este endpoint, podrás obtener la lista de todos los usuarios previamente dados de alta en nuestro sistema.

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

Agregar encabezados de autenticación

Ejemplo:

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

https://{enviroment-domain}/api/v1/get-user?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6

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.

Ejemplo de respuesta exitosa

Http code 200

{
    "payload": {
        "users": [
            {
                "customerId": "IdUser1",
                "contractNumber": "123"
            },
            {
                "customerId": "IdUser2",
                "contractNumber": "456"
            },
            {
                "customerId": "IdUser",
                "contractNumber": "789"
            }
        ]
    },
    "isSuccess": true
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Payload`	Respuesta solicitada a nuestro sistema.
`Users`	Lista de usuarios guardados en nuestro sistema.
`CustomerId`	Identificador único del cliente. Este identificador lo asigna el propio comercio, es de tipo alfanumérico y no mayor a 100 caracteres.
`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.
`Errors`	Una lista de errores que ocurrieron en la petición.
`Key`	Llave del error
`Value`	Breve descripción del error.

📘
CONSIDERACIONES IMPORTANTES

El campo MerchantId es obligatorio.