Skip to main content

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
  • Email
  • Mobile Phone

HTTP Request

  • POST /cardholders

Header Parameters

HeaderDescription
Authorization 
required
The Bearer token created in
Get authorization Token
Content-Type 
required
application/json

Body parameters

ParameterTypePatternDescription
first_name
required
string1-12 charactersThe cardholder's first name.
second_name 
required
string1-12 charactersThe cardholder's second name.
surname 
required
string1-12 charactersThe cardholder's surname.
second_surname 
required
string1-12 charactersThe cardholder's second surname.
rfc 
required
string10-13 charactersThe cardholder's RFC.
curp 
required
string18 charactersThe cardholder's CURP.
email 
required
stringemailThe cardholder's email.
primary_phone 
required
string10 digitsThe cardholder's primary phone. Can be local phone or mobile_phone.
mobile_phone 
required
string10 digitsThe cardholder's mobile_phone.
street 
required
string1-20 charactersThe cardholder's street address.
ext_street_number 
required
string1-5 charactersThe cardholder's street address number.
int_street_number 
optional
string1-5 charactersThe cardholder's street address number.
suburb
 required
string1-25 charactersThe cardholder's suburb address.
city 
required
string1-25 charactersThe cardholder's city address.
state 
required
stringStatesThe cardholder's state address. See allowed values in
Get States Catalog
postal_code 
required
string5 digitsThe cardholder's address postal code.
birthdate 
required
dateYYYY-MM-ddThe cardholder's birthdate.
gender 
required
stringGenderThe cardholder's gender. See allowed values in
Get Gender Catalog
marital_status 
required
stringMarital StatusThe cardholder's marital status. See allowed values in
Get Marital Status Catalog
has_kids 
required
booleantrue or falseIf cardholder's has kids or not.
gross_monthly_income 
optional
floatdigitsCardholder's gross monthly income (in MXN).
net_monthly_income 
optional
floatdigitsCardholder's net monthly income (in MXN).
observations 
optional
string0-100 charactersSome observations about cardholder.
external_id 
optional
string0-40 charactersA 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]"
}
}
}