Withdraw Funds

post

https://test.api.promisepay.com/wallet_accounts/{id}/withdraw

Withdraw funds from a Wallet Account to a specified disbursement account.

Path Params

string

required

Defaults to bd6e9c20-73f1-0138-fb91-0a58a9feac09

Wallet account ID

Body Params

account_id

string

required

Defaults to c1824ad0-73f1-0138-3700-0a58a9feac09

Account to withdraw to.

amount

integer

required

Amount (in cents) to withdraw.

custom_descriptor

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

reference_id

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.

end_to_end_id

string

Defaults to NOTPROVIDED

A unique identifier assigned by the initiating party to track and reconcile the IFTI payout throughout its lifecycle. This value must be unique per transaction and is included in payment messaging for traceability across participating financial institutions. This is the Debtor’s (customer) reference for the Payment to be provided to Creditor (customer). Mandatory for NPP IFTI Payment.

ifti_information

object

IFTI Payer Information. This is an optional field and cannot contain invalid characters. Please get in touch with customer service before enabling this feature. Fields marked below are required exclusively for IFTI payout processing to meet reporting and compliance requirements. Please refer to individual field descriptions for specific conditional requirements

Response

Language

Credentials

URL

Response

Choose an example:

application/json

201OK