Get wallet balance for a customer or entity
Retrieve balance information for a specified customer, corporate entity, or tenant. This is a GET API where the entity ID is passed as a path parameter (no request body).
Returns an array of balance entries, one per product associated with the entity. Each entry contains the available balance and the lien (held) balance.
Balance represents funds available for transactions. Lien balance represents funds that are temporarily held due to pending transactions, disputes, or other holds. The actual spendable amount is the balance minus the lien balance.
Authorization
BearerAuth TenantHeader JWT Bearer token obtained from the /auth/login endpoint
In: header
Tenant identifier provided by M2P (e.g. ENBDTABBY)
In: header
Path Parameters
Entity ID of the customer, corporate, or tenant to fetch balance for
Response Body
application/json
application/json
application/json
curl -X GET "https://api.m2p.com/Yappay/business-entity-manager/fetchbalance/ABCDEF"{
"result": [
{
"entityId": "ABCDEF",
"productId": "BUSINESS",
"balance": "12345.67",
"lienBalance": "0.0"
}
],
"exception": null,
"pagination": null
}{
"result": null,
"exception": {
"detailMessage": "Entity Id Invalid",
"shortMessage": "Entity Id Invalid",
"errorCode": "Y226",
"languageCode": "en"
},
"pagination": null
}{
"result": null,
"exception": {
"detailMessage": "Not a registered Customer",
"shortMessage": "Not a registered Customer",
"errorCode": "Y109",
"languageCode": "en"
},
"pagination": null
}Debit funds from a wallet POST
Debit funds from a customer wallet. This API withdraws the specified amount from the wallet associated with the provided kit number. Idempotent on the externalTransactionId field. Duplicate requests with the same ID return the original result. The transactionType field indicates the nature of the debit. Common values are C2M (customer-to-merchant transfer), P2P (peer-to-peer transfer), and BILL_PAY (utility or bill payment). The amount must be a positive number and must not exceed the available balance. Insufficient balance returns error code Y212 or TXN_003.
Get transaction history for a card GET
Retrieve paginated transaction history for a specific card identified by kit number. Supports filtering by date range and transaction type. Results are paginated with a default page size of 20 and maximum of 100 records per page. Page numbering starts at 0. Each transaction record includes the transaction ID, external reference, type, amount, currency, balance after transaction, status, narration, and timestamp.