Descripción

Con este endpoint, podrás crear un nuevo usuario. Es indispensable crear al nuevo usuario para poder dar de alta sus tarjetas y/o procesar sus pagos.

Method: post
URL: https://{enviroment-domain}/api/v1/create-user
Encabezados HTTP: Content-Type: application/json
Agregar encabezados de autenticación

Ejemplo:

Body

{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerId": "IdUser",
  "contractNumber": "123456789",
  "contactInfo": {
    "email": "[email protected]",
    "phoneNumber": "123456",
    "address": "address",
    "zipCode": "123"
  }
}

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.
`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).

Ejemplo de respuesta exitosa

Http code 200

{
    "isSuccess": true
}

Ejemplos de respuesta con error

Http code 400

Usuario ya existente

{
    "isSuccess": false,
    "errors": [
        {
            "key": "InvalidOperationException",
            "value": [
                "User already exists: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IdUser"
            ]
        }
    ]
}

Http code 400

Error en algún campo

{
    "isSuccess": false,
    "errors": [
        {
            "key": "ContractNumber",
            "value": [
                "ContractNumber must be at most 20 characters."
            ]
        }
    ]
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Errors`	Una lista de errores que ocurrieron en la petición.
`Key`	Llave del error
`Value`	Breve descripción del error.

📘
CONSIDERACIONES IMPORTANTES

El CustomerId debe de ser único por cada usuario dado de alta en nuestro sistema.