Wallets

Server

Create wallet

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets

Create wallet › Request Body

currency

string

Create wallet › Responses

Wallet created.

No data returned

List wallets for the authenticated user

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/my

List wallets for the authenticated user › Responses

200

User wallets.

No data returned

Get wallet balance

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/{id}/balance

Get wallet balance › path Parameters

id

string · required

Get wallet balance › Responses

200

Wallet balance.

No data returned

Resolve a transfer recipient

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/recipients/resolve

Resolve a transfer recipient › Request Body

aliasType

string · enum · required

Enum values:

phone

account

wallet

alias

string · required

Resolve a transfer recipient › Responses

200

Recipient candidate and policy.

No data returned

Quote a transfer

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/transfer/quote

Quote a transfer › Request Body

TransferRequest

amount

number · required

fromBlnkBalanceId

string

toBlnkBalanceId

string

recipientAlias

string

currency

string

reference

string

note

string

Quote a transfer › Responses

200

Fees, limits, blockers, and total.

No data returned

Execute a wallet transfer

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/transfer

Execute a wallet transfer › Headers

Idempotency-Key

string

Stable operation key for retries and duplicate submission protection.

Execute a wallet transfer › Request Body

TransferRequest

amount

number · required

fromBlnkBalanceId

string

toBlnkBalanceId

string

recipientAlias

string

currency

string

reference

string

note

string

Execute a wallet transfer › Responses

Transfer accepted/applied.

No data returned

Recent wallet transactions

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/transactions/recent

Recent wallet transactions › Responses

200

Recent transactions.

No data returned

Search wallet transactions

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/transactions

Search wallet transactions › query Parameters

limit

integer

Default: 50

Search wallet transactions › Responses

200

Transaction list.

No data returned

Transaction detail

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/transactions/{id}

Transaction detail › path Parameters

id

string · uuid · required

Transaction detail › Responses

200

Transaction detail.

No data returned

Recent transfer recipients

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/recipients/recent

Recent transfer recipients › Responses

200

Recent recipients.

No data returned

Available statements

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/statements

Available statements › Responses

200

Statement summaries.

No data returned

Statement detail

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/statements/{month}

Statement detail › path Parameters

month

string · pattern: ^\d{4}-(0[1-9]|1[0-2… · required

Statement detail › Responses

200

Statement detail.

No data returned

Unavailable — initiate cash-in (rail not connected)

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/cash-in

Unavailable until a cash-in rail is connected. Live sandbox readiness and the Côte d'Ivoire service catalog mark cash-in as unavailable. Do not send production clients through this mutation. Required available money-flow mutations are POST /wallets/transfer and sandbox POST /wallets/topup-dev.

Unavailable — initiate cash-in (rail not connected) › Headers

Idempotency-Key

string

Stable operation key for retries and duplicate submission protection.

Unavailable — initiate cash-in (rail not connected) › Request Body

CashInRequest

amount

number · required

provider

string · required

msisdn

string · required

currency

string

Unavailable — initiate cash-in (rail not connected) › Responses

Cash-in route authorized or queued.

No data returned

Unavailable — buy airtime (rail not connected)

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/airtime

Unavailable until an airtime rail is connected. Live sandbox readiness and the Côte d'Ivoire service catalog mark airtime as unavailable. Do not send production clients through this mutation.

Unavailable — buy airtime (rail not connected) › Headers

Idempotency-Key

string

Stable operation key for retries and duplicate submission protection.

Unavailable — buy airtime (rail not connected) › Request Body

AirtimeRequest

amount

number · required

msisdn

string · required

operator

string · required

countryIso2

string

Unavailable — buy airtime (rail not connected) › Responses

200

Airtime purchase result.

No data returned

Unavailable — pay a bill (rail not connected)

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/bill-pay

Unavailable until a bill-pay rail is connected. Live sandbox readiness and the Côte d'Ivoire service catalog mark bills as unavailable. Do not send production clients through this mutation.

Unavailable — pay a bill (rail not connected) › Headers

Idempotency-Key

string

Stable operation key for retries and duplicate submission protection.

Unavailable — pay a bill (rail not connected) › Request Body

BillPayRequest

amount

number · required

biller

string · required

accountReference

string · required

countryIso2

string

Unavailable — pay a bill (rail not connected) › Responses

200

Bill payment result.

No data returned

Sandbox developer top-up

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/wallets/topup-dev

Enabled only in sandbox/development.

Sandbox developer top-up › Headers

Idempotency-Key

string

Stable operation key for retries and duplicate submission protection.

Sandbox developer top-up › Request Body

amount

number · required

currency

string

Sandbox developer top-up › Responses

200

Top-up result.

No data returned

Auth Savings pots