4 endpoints
Wallet
The balance of your payment account, its RIB in the merchant's name, the downloadable certificate, and how to fund it.
Endpoint names and descriptions come from the OpenAPI contract, in English — they cannot drift from the API.
In plain English
Your ChariPay payment account: check the balance, get your RIB, fund it.
When to use it
To display a balance in your back-office, to give a RIB to a payer, or to fund the account before an outgoing operation.
How to integrate it
- 1Read the available balance before any operation that sends money out.
- 2Fetch the RIB, or its PDF certificate, when a third party needs to transfer funds to you.
- 3Fund the wallet when the position does not cover what you want to commit.
- POST
/v1/wallet/cash-insFund the merchant wallet - GET
/v1/wallet/account/rib-documentDownload wallet RIB (PDF) - GET
/v1/wallet/accountRetrieve wallet account (RIB) - GET
/v1/walletRetrieve wallet balance
Fund the merchant wallet
Creates a local hosted card-payment link. Card submission funds the shared sandbox eSIM or the merchant's real production eSIM through the canonical checkout flow. Ledger-only sandbox creates and finalizes a canonical cash-in through the durable outbox.
Schema · WalletCashinRequest
| Field | Type | In | Required | Description |
|---|---|---|---|---|
Idempotency-Key | string | header | Required | Required retry-safe idempotency key. |
amount | number | body | Required | Amount to fund in MAD. |
Download wallet RIB (PDF)
Returns the wallet's bank details rendered as a downloadable PDF document.
No parameters.
Retrieve wallet account (RIB)
Returns the copyable bank details (RIB/IBAN/BIC, holder, bank) and current balances.
No parameters.
Retrieve wallet balance
Returns the live wallet balance in MAD for the key's environment.
No parameters.
A question about integration?
Our technical team supports integrators from the first sandbox call through to go-live.