How to Use the Service

Explore the API's endpoints.

The Multi-CLABE API includes a set of RESTful endpoints that enable you to create CLABEs on demand and then query the operations made using these CLABEs. The functionality includes:

  • Create CLABEs: Set up as many CLABES as you need in your account and assign them on a one-to-one relationship to users.
  • Retrieve a specific CLABE: Get comprehensive details of one of your CLABEs.
  • Set minimum and maximum deposit limits: Configure minimum and maximum deposit amounts that determine the lowest and highest values a user can deposit into a CLABE for the service to accept the transaction. You can set maximum limits per transaction and period.
  • Turn unblocked CLABEs on or off: Switch a created CLABE to an inactive state (cannot receive deposits) or vice versa. You can only update the state of unblocked CLABEs and access this endpoint only if the Multi-CLABE feature is active in your account.
  • List your CLABEs: Retrieve a paginated set of CLABEs that match your query parameters.
  • List your CLABEs' deposits: Retrieve a paginated, filtered list of the fundings made into the CLABEs linked to your account.
  • List your CLABEs' withdrawals: Retrieve a paginated, filtered list of the withdrawals made by the CLABEs linked to your account.
  • Receive One-Time Payments: Request a CLABE for a one-time SPEI® payment and provide a unique, client-supplied payment ID for the transaction, streamlining your reconciliation of incoming payments.
  • List your One-Time Payments : Retrieve a paginated payment list that matches your query parameters.
  • List rejected transactions : Retrieve a paginated, filtered list of rejected deposits and one-time payments that rapidly lets you know why the service rejected the transaction.
  • Create mock deposits: Simulate deposits and refund deposits in MXN into your Bitso testing account.
  • Receive deposit notifications: Get real-time status data about deposit events in your account.
  • Receive rejected-transaction notifications: Get real-time data about rejected deposits.

Did this page help you?