Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Wallet Accounts

Withdraw Funds

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

post/wallet_accounts/{id}/withdraw

Path parameters

idstring required

Wallet account ID

Request body

account_idstring required

Account to withdraw to.

amountinteger required

Amount (in cents) to withdraw.

custom_descriptorstring

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_idstring

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

Example request

{
  "account_id": "c1824ad0-73f1-0138-3700-0a58a9feac09",
  "amount": 173,
  "reference_id": "7190770-1-2908"
}

Response

OK

Example response

{
  "disbursements": {
    "id": "ad688d54-6791-4f1d-add7-88fbd89b70d1",
    "reference_id": "7190770-1-2908",
    "amount": 10000,
    "currency": "AUD",
    "state": "pending",
    "to": "Bank Account",
    "bank_name": "Bank of Australia",
    "bank_account_name": "Samuel Seller",
    "bank_account_number": "XXX234",
    "bank_routing_number": "XXXXX3",
    "npp_payout_state": "trying",
    "account_name": "My Water Company",
    "biller_name": "ABC Water",
    "crn": "0987654321",
    "links": {
      "transactions": "/disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/transactions",
      "wallet_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/wallet_accounts",
      "paypal_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/paypal_accounts",
      "bank_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bank_accounts",
      "bpay_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bpay_accounts",
      "items": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/items",
      "users": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/users"
    }
  }
}