API Reference
API Reference

Withdraw Funds

post
https://test.api.promisepay.com/sub_wallets//withdraw

Withdraw funds from a sub-wallet using the given id and move the specified amount to a disbursement account associated with the account_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to bd6e9c20-73f1-0138-fb91-0a58a9feac09

sub-wallet ID

Body Params
string
required
Defaults to c1824ad0-73f1-0138-3700-0a58a9feac09

Account to withdraw to.

integer
required
Defaults to 173

Amount (in cents) to withdraw.

string

A descriptor specified by the customer to be passed on the withdraw call. This requires that custom_descriptors are enabled. In the case of fast payments (AU / NPP) Assembly will append a value in the beginning of descriptor, the customer can use 200 characters (excluding URL, javascript/code, emojis). In the case of DE batch payments will allow 18 characters

string
Defaults to 7190770-1-2908

Unique reference information that can be specified for a for wallet withdrawal request. This is an optional field and cannot contain '.' character.

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 days ago