v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB

customer

Create customer

post/customer

Request body

namestring

The customer name

tax_id_type'rfc' | 'cnpj' | 'cpf' | 'ruc' | 'curp' | 'le' | 'dni' | 'lm' | 'pas' | 'ce' | 'nit' | 'cc' | 'pa' | 'ti' | 'nuip' | 'ppt' | 'pep' | 'cuil' | 'cuit' | 'other'

The type of tax identification of the customer

tax_idstring

The customer's tax identification number

external_idstring required

An external ID to identify a user. It can be the merchant's user ID or other tracking ID.

Example request

{
  "name": "Jane Doe",
  "tax_id_type": "rfc",
  "tax_id": "DODJ2301016J3",
  "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
  "withdrawal_account": {
    "account_number": "19395123123223150",
    "branch": "0",
    "account_format": "clabe",
    "bicfi": "BBVAMXMMXXX"
  }
}

Response

Create customer successfully

namestring required

document_typestring nullable

document_numberstring nullable

emailstring email nullable

idstring uuid required

Example response

{
  "id": "9c1dd10e-7c19-470d-9dd1-0e7c19670d64"
}