Create new Billpocket users through the API by submitting the required personal and business information. After creation, users must log in to the dashboard to complete their setup and start processing transactions.Service available in Mexico only.
Requirements#
An API key (sent in BP-Api-Key header)
Environments#
| Environment | Base URL |
|---|
| Dev | https://test.v2.legacy.billpocket.com |
| Live | https://v2.legacy.billpocket.com |
Create a user#
Submit the user's personal data to create a new Billpocket account.Created users are visible in Brain once registered as distributors.
Request — Physical person (tipo_persona: "1"):{
"email": "john.doe@example.com",
"password": "53dbb513ba3d068be470c01de5297c37",
"telefono": "8100000000",
"nombre": "John",
"apellido_paterno": "Doe",
"apellido_materno": "",
"tipo_persona": "1",
"actividad_comercial": "1",
"curp": "XXXX000000XXXXXX00",
"rfc": "XXXX000000X0X",
"calle": "Centro",
"exterior": "123",
"interior": "123",
"colonia": "Centro",
"codigo_postal": "64000",
"estado": "1",
"municipio": "1"
}
Additional fields for moral persons (tipo_persona: "2"):{
"razon_social": "Example SA de CV.",
"tipo_sociedad": "1",
"fecha_constitucion": "2020-01-01",
"representante_legal": "John Doe"
}
Request fields#
| Field | Description |
|---|
email | User email address |
password | MD5-hashed password |
telefono | Phone number |
nombre | First name |
apellido_paterno | Paternal surname |
apellido_materno | Maternal surname (optional) |
tipo_persona | "1" = physical, "2" = moral |
actividad_comercial | Commercial activity ID (see Catalogs) |
curp | CURP (physical persons) |
rfc | RFC |
calle / exterior / interior / colonia | Address fields |
codigo_postal | Postal code |
estado | State ID (see Catalogs) |
municipio | Municipality ID (see Catalogs) |
Response#
{
"userToken": "XYZ...",
"userId": 123
}
The userToken in the response is the user token for API authentication.
Next steps#
Use Catalogs to look up valid IDs for actividad_comercial, estado, and municipio
Got a suggestion on this documentation? Contact us.