MPay cash-out

Partner cashout

The partner generate an offline QR code that contains the following json

Parameter	Type	Description
shop	string	the shop uuid
agent	string	(optional) Mobile number of the agent/cashier performing the transaction
amount	float	The amount to cashout by the customer
request_id	string	(optional) The partner request id
time	string	ISO 8601 string representing the time the sale was completed

Sample Json:

{
    "operation": "MPayCashOut",
    "amount": 100.15,
    "agent": "agent-id",
    "shop": "30d0d335-e9cb-492a-8c46-be0221408787",
    "request_id": "f8080959-554e-4cc5-89b1-f10c616d5858",
    "time": "2025-04-07T17:20:30+01:00"
}

After the customer success the cashout, we perform a callback to the partner

Authentication

• Token authentication

Header	Description
ApiKey	The authentication header provided by the partner

Or as a querystring that the partner provide us

the default callback scheme is a POST request to the callback url

Parameter	Type	Description
shop_id	string	the shop uuid
status	string	the status of the transaction (pending / approved / rejected)
reason	string	the reason of rejection
agent	string	(optional) ID of the agent/cashier performing the transaction
amount	float	The amount to cashout by the customer
request_id	string	The unique ID representing the request
time	string	ISO 8601 string representing the time the sale was completed
fee	string	the calculated fee for the transaction

Example request body

{
    "shop_id": "30d0d335-e9cb-492a-8c46-be0221408787",
    "agent": "agent-id",
    "request_id": "c3921462-b840-45ad-880e-65d824a8c3e0",
    "time": "2025-04-07T17:20:30+01:00",
    "amount": 100.15,
    "status": "rejected",
    "reason": "Technical Error",
    "fee": "3.00"
}