Create a cardholder
This endpoint creates a cardholder.
note
When register a cardholder the following fields must be unique and can't be shared with two different cardholders:
- RFC
- CURP
- Mobile Phone
HTTP Request
POST /cardholders
Header Parameters
Header | Description |
---|---|
Authorization required | The Bearer token created in Get authorization Token |
Content-Type required | application/json |
Body parameters
Parameter | Type | Pattern | Description |
---|---|---|---|
first_name required | string | 1-12 characters | The cardholder's first name. |
second_name required | string | 1-12 characters | The cardholder's second name. |
surname required | string | 1-12 characters | The cardholder's surname. |
second_surname required | string | 1-12 characters | The cardholder's second surname. |
rfc required | string | 10-13 characters | The cardholder's RFC. |
curp required | string | 18 characters | The cardholder's CURP. |
email required | string | The cardholder's email. | |
primary_phone required | string | 10 digits | The cardholder's primary phone. Can be local phone or mobile_phone. |
mobile_phone required | string | 10 digits | The cardholder's mobile_phone. |
street required | string | 1-20 characters | The cardholder's street address. |
ext_street_number required | string | 1-5 characters | The cardholder's street address number. |
int_street_number optional | string | 1-5 characters | The cardholder's street address number. |
suburb required | string | 1-25 characters | The cardholder's suburb address. |
city required | string | 1-25 characters | The cardholder's city address. |
state required | string | States | The cardholder's state address. See allowed values in Get States Catalog |
postal_code required | string | 5 digits | The cardholder's address postal code. |
birthdate required | date | YYYY-MM-dd | The cardholder's birthdate. |
gender required | string | Gender | The cardholder's gender. See allowed values in Get Gender Catalog |
marital_status required | string | Marital Status | The cardholder's marital status. See allowed values in Get Marital Status Catalog |
has_kids required | boolean | true or false | If cardholder's has kids or not. |
gross_monthly_income optional | float | digits | Cardholder's gross monthly income (in MXN). |
net_monthly_income optional | float | digits | Cardholder's net monthly income (in MXN). |
observations optional | string | 0-100 characters | Some observations about cardholder. |
external_id optional | string | 0-40 characters | A place to put an external reference. If provided, it must be unique. |
Example JSON Request:
{
"first_name": "John",
"second_name": "Doe",
"surname": "González",
"second_surname": "Pérez",
"rfc": "XAXX010101000",
"curp": "XEXX010101HNEXXXA4",
"email": "[email protected]",
"primary_phone": "5555555555",
"mobile_phone": "5555555555",
"street": "Av. Siempre",
"ext_street_number": "#12",
"int_street_number": "Lt3.",
"suburb": "Nápoles",
"township": "Benito Juárez",
"city": "CDMX",
"state": "CDMX",
"postal_code": "55120",
"birthdate": "1995-09-22",
"gender": "MALE",
"marital_status": "SOLTERO",
"has_kids": false,
"gross_monthly_income": 20000,
"net_monthly_income": 18000,
"observations": ""
}
Example JSON Response:
{
"success": true,
"code": 0,
"message": "OK",
"data": {
"cardholder": {
"id": "ec123456-1qq2-1234-tt5g-8873fe52bf54",
"first_name": "John",
"second_name": "Doe",
"surname": "González",
"second_surname": "Pérez",
"rfc": "XAXX010101000",
"curp": "XEXX010101HNEXXXA4",
"email": "[email protected]"
}
}
}