HeritagePay API
​string​number · required​string​string​string​string​string​string
​string​number · required​string · required​string · required​string
​string​number · required​string · required​string · required​string
​string​number · required​string · required​string · required​string
Quote a transfer
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/wallets/transfer/quote
Execute a wallet transfer
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/wallets/transfer
Headers
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Execute a wallet transfer › Request Body
amountfromBlnkBalanceIdtoBlnkBalanceIdrecipientAliascurrencyreferencenoteExecute a wallet transfer › Responses
Transfer accepted/applied.
No data returned
Initiate cash-in
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/wallets/cash-in
Headers
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Initiate cash-in › Request Body
amountprovidermsisdncurrencyInitiate cash-in › Responses
Cash-in route authorized or queued.
No data returned
Buy airtime
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/wallets/airtime
Headers
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Buy airtime › Request Body
amountmsisdnoperatorcountryIso2Buy airtime › Responses
200
Airtime purchase result.
No data returned
Pay a bill
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/wallets/bill-pay
Headers
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Pay a bill › Request Body
amountbilleraccountReferencecountryIso2Pay a bill › Responses
200
Bill payment result.
No data returned