🔗 GET REQUISITE
Create Requisite for Deposits
POST
/api/v3/client-requisite/create
This endpoint allows the merchant to create a requisite (e.g. CLABE) to accept deposits from clients. A single requisite can be used for multiple deposits.
Request
Request Body (Full)
Minimum Required Body
POST /api/v3/client-requisite/create
{"client": {"id": "merchantClientId" // required – unique client ID},"currency": "mxn", // required – currency of the deposit"conversionCurrency": null, // optional – conversion currency; can be omitted"merchantOrderIdPrefix": "string", // optional – prefix for merchantOrderId"type": "long_term", // optional – "long_term" (default) or "short_term""attributes": {"blockchainNetwork": null, // optional"routingKey": null // optional},"webhookUrl": "https://merchant.com/webhook" // optional – webhook URL for notifications}
Response
RESPONSE
{"error": null,"data": {"id": "17df2706-4b94-414e-868c-e5789b545f42", // unique ID of the requisite"requisite": {"clabe": "058027970502111111", // destination, static CLABE"reference": null, // always null"type": "clabe"},"expiresAt": "2029-08-24T14:15:22Z", // expiry timestamp; extended after each deposit"minAmount": "10.23" // minimum allowed deposit amount. Deposits with lower ammount will be canceled.}}
Flow & Usage
- Merchant displays the
requisite.clabe
to their client. - The client may send multiple deposits to this requisite.
- Orders will be created automatically.
- If
webhookUrl
was provided, webhooks about new orders will be sent (same as current order webhooks).
Force Expire a Requisite
POST
/api/v3/client-requisite/deactivate
Using ID
Using Requisite
POST /api/v3/client-requisite/deactivate
{"id": "50f86dd8-85b3-4172-9fde-b67f3ae7991f"}
Retrieve Orders by Requisite
POST
/api/v3/client-requisite/get-orders-list
Using ID
Using Requisite
POST /api/v3/client-requisite/get-orders-list
{"id": "50f86dd8-85b3-4172-9fde-b67f3ae7991f","createdAtFrom": "2025-06-29T07:44:22+00:00","createdAtTo": "2025-06-29T07:44:22+00:00","limit": 100,"offset": 0}
Notes
- All optional fields (such as
conversionCurrency
,type
,attributes
, etc.) can be omitted- These options are inherited from the existing
getAddress
flow- The requisite auto-renews its
expiresAt
time upon each successful deposit