Unique Customer CLABE

Instructions

Log in and go to Customers section on the sidepanel.
Select a customer from the list.
Inside the customer details panel, select Assign CLABE
A unique CLABE will be assigned to the customer.

📘
Customers can use the assigned CLABE to make payments to a merchant. This payments will appear in the Payments received section in the Customer details.

⚠️
IMPORTANT
To follow the steps below, it is essential to have the corresponding Authorization Token. For more information, please refer to the following documentation page: Authorization Token

Assign a CLABE

Generates an 18-digit interbank CLABE for a customer so they can receive SPEI deposits. The CLABE is created by Ecart Pay. You do not send the number in the request.

The account must be active, the customer must belong to that account, and you must have the write_customers permission. Available for Mexico accounts.

If the customer already has a CLABE, the endpoint returns the existing number.

Endpoint

PATCH https://ecartpay.com/api/customers/{{customer_id}}/clabe
PATCH https://sandbox.ecartpay.com/api/customers/{{customer_id}}/clabe (Sandbox only)

Headers

Authorization: {token}
Content-Type: application/json

Path Parameters

customer_id: The id of the customer that will own the CLABE.

Body

None

Examples

Request

curl --request PATCH \
  --url https://sandbox.ecartpay.com/api/customers/65a864a93df1d9cacf436c5a/clabe \
  --header 'Authorization: {token}'

Response

{
  "clabe": "646180157000000001"
}

❗️
Errors
A customer that does not exist, or that does not belong to the account, returns 404 with the message The customer does not exist.
A token without the write_customers permission returns 403.

List Customer CLABEs

Returns the CLABEs assigned to a customer. You need to have the read_customer_clabes or write_customer_clabes permissions.

Endpoint

GET https://ecartpay.com/api/customers/{{customer_id}}/clabes
GET https://sandbox.ecartpay.com/api/customers/{{customer_id}}/clabes (Sandbox only)

Headers

Authorization: {token}

Path Parameters

customer_id: The id of the customer.

Query Parameters

Field	Type	Description
`page`	number	Page number. Defaults to `1`.
`limit`	number	Page size. Defaults to `50`. Maximum `250`.
`is_active`	boolean	Filter by `true` or `false`.
`bank_code`	string	Exact bank code, for example `072`.
`bank_name`	string	Case-insensitive match on the bank name.
`sort`	string	Sort fields, for example `created_at:desc`. Defaults to newest first.

Examples

Request

curl --request GET \
  --url 'https://sandbox.ecartpay.com/api/customers/65a864a93df1d9cacf436c5a/clabes?page=1&limit=50&is_active=false' \
  --header 'Authorization: {token}'

Response

{
  "count": 1,
  "pages": 1,
  "docs": [
    {
      "id": "68dab82eff8f016d8e168971",
      "account_id": "672a850371be0ecf554d050c",
      "customer_id": "65a864a93df1d9cacf436c5a",
      "clabe": "072180001234567890",
      "customer_rfc": "XAXX010101000",
      "bank_name": "Banorte",
      "bank_code": "072",
      "alias": "Payroll account",
      "is_active": false
    }
  ]
}

Get a Customer CLABE

Returns one CLABE assigned to the customer. The token must include read_customer_clabes or write_customer_clabes.

Endpoint

GET https://ecartpay.com/api/customers/{{customer_id}}/clabes/{{id}}
GET https://sandbox.ecartpay.com/api/customers/{{customer_id}}/clabes/{{id}} (Sandbox only)

Headers

Authorization: {token}

Path Parameters

customer_id: The id of the customer.
id: The id of the customer CLABE.

Examples

Request

curl --request GET \
  --url https://sandbox.ecartpay.com/api/customers/65a864a93df1d9cacf436c5a/clabes/68dab82eff8f016d8e168971 \
  --header 'Authorization: {token}'

Response

{
  "_id": "68dab82eff8f016d8e168971",
  "account_id": "672a850371be0ecf554d050c",
  "customer_id": "65a864a93df1d9cacf436c5a",
  "clabe": "072180001234567890",
  "customer_rfc": "XAXX010101000",
  "bank_code": "072",
  "bank_name": "Banorte",
  "alias": "Payroll account",
  "is_active": false,
  "created_at": "2026-09-30T16:52:00.000Z",
  "updated_at": "2026-09-30T16:52:00.000Z"
}

A missing CLABE returns 404 with the message The customer clabe does not exist.