PayPM Platform API
​string · pattern: ​string​string​number​string · date​string​string​string
​string · pattern: ​string​number · required​string​string​string
​string · pattern: ​string​number · required​string​string​string
Create a savings pot
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/savings-pots
Update a savings pot
PATCH
https://sandbox-heritagepay-api.paypm.net/api/v1
/savings-pots/{blnkBalanceId}
path Parameters
blnkBalanceId^bln_[0-9a-f-]{36}$ · requiredUpdate a savings pot › Request Body
namedescriptiontargetAmounttargetDatecurrencyiconcolorUpdate a savings pot › Responses
200
Pot updated.
No data returned
Deposit into a savings pot
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/savings-pots/{blnkBalanceId}/deposit
path Parameters
blnkBalanceId^bln_[0-9a-f-]{36}$ · requiredHeaders
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Deposit into a savings pot › Request Body
amountsourceWalletBalanceIddestinationWalletBalanceIdreferenceDeposit into a savings pot › Responses
200
Deposit result.
No data returned
Withdraw from a savings pot
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/savings-pots/{blnkBalanceId}/withdraw
path Parameters
blnkBalanceId^bln_[0-9a-f-]{36}$ · requiredHeaders
Idempotency-KeyStable operation key for retries and duplicate submission protection.
Withdraw from a savings pot › Request Body
amountsourceWalletBalanceIddestinationWalletBalanceIdreferenceWithdraw from a savings pot › Responses
200
Withdrawal result.
No data returned