๐ธ Withdraw AUD
Transferring funds back to a bank account after burning AUDD
When you burn AUDD, the equivalent amount of Australian dollars (AUD) is credited to your Virtual Account balance. To complete the process, youโll need to specify the external bank account where those funds should be withdrawn.
Bank Account Required:Before you can initiate a withdrawal, the destination bank account must be added and approved in Mint. For setup instructions, see the External Bank Account Management guide.
๐ฒ Withdrawing AUD
Withdrawals are made using the POST /bank-accounts/withdraw endpoint. This request tells the AUDD Mint how much AUD youโd like to withdraw, and which registered bank account it should be sent to. Request Body fields are defined as follows:
| Field | Type | Required | Description |
|---|---|---|---|
srcBankAccountId | string | โ | Public ID of the deposit bank account |
destBankAccountId | string | โ | Public ID of the withdrawal bank account |
currency | string | โ | Only "AUD" is supported |
amount | float | โ | The amount to be withdrawn |
๐ค Example Request:
curl -X POST [https://distributor-api-staging.audd.digital/bank-accounts/withdraw](https://distributor-api-staging.audd.digital/bank-accounts/withdraw)
-H "Authorization: Bearer <YOUR_API_KEY>"
-H "Content-Type: application/json"
-d '{
"srcBankAccountId": "<DEPOSIT_BANK_ACCOUNT_ID>",
"destBankAccountId": "<WITHDRAWAL_BANK_ACCOUNT_ID>",
"currency": "AUD",
"amount": 1
}'
๐ฅ Example Response:
{
"id": "withdraw id",
"type": "WITHDRAWAL",
"sourceBankAccount": {
"id": "<deposit bank account public id>",
"bsb": "",
"accountNumber": "",
"payId": null,
"currency": "AUD",
"balance": null,
"type": "DISTRIBUTOR",
"nickname": "<deposit bank account nickname>",
"company": {
"id": "<distributor company id>",
"name": "<distributor company name>",
"types": null
},
"subType": "DEPOSIT",
"contactId": null,
"providerType": "<AUDD to provide>",
"status": "ACTIVE",
"accountHolderName": "",
"accountHolderFirstname": "",
"accountHolderLastname": ""
},
"destinationBankAccount": {
"id": "<withdrawal bank account id>",
"bsb": "",
"accountNumber": "",
"payId": null,
"currency": "AUD",
"balance": null,
"type": "DISTRIBUTOR",
"nickname": "",
"company": {
"id": "<distributor company id>",
"name": "<distributor company name>",
"types": null
},
"subType": "WITHDRAWAL",
"contactId": null,
"providerType": "NONE",
"status": "ACTIVE",
"accountHolderName": null,
"accountHolderFirstname": null,
"accountHolderLastname": null
},
"amount": 1,
"fee": 0.01,
"currency": "AUD",
"status": "IN_PROGRESS",
"approver": null,
"createdBy": {
"id": "",
"firstName": "",
"lastName": "",
"email": "",
"phone": ""
},
"distributorCompany": {
"id": "",
"name": "",
"types": null
},
"createdAt": "2025-09-05T07:39:00.689+00:00",
"reference": "ZTLPAQO",
"description": null,
"bankTransactionId": null,
"transactionId": null,
"metadata": null,
"refundTransactionId": null,
"holdUntilDate": null,
"adjustment": false,
"privateAdjustment": false
}
Fees May Apply:Withdrawal fees may be deducted automatically from the withdrawal amount, meaning the funds received will be the requested amount minus fees. For more details on how this is handled, refer to the Fees and Charges Guide.
Fee Behaviour
When funds are withdrawn from a Virtual Account (VA) to an external bank account, a withdrawal fee is applied. In staging, this fee is credited to TestMintFee, which may result in an additional transaction showing funds moving from the bank account to TestMintFee. This behaviour is expected and reflects the VA withdrawal fee settlement mechanism.
Simulating Withdrawal Outcomes
Withdrawal transactions in Sandbox are processed through our banking provider's test environment. You can trigger specific payment outcomes by using certain transaction amounts when creating a withdrawal.
This allows you to test how your integration handles different withdrawal statuses using the same request structure you would use in Production.
| Amount | Simulated outcome | Payment status |
|---|---|---|
13.00 | Insufficient funds | MissingFunding |
17.00 | Payment remains pending | PendingProcessing |
19.00 | Payment is rejected immediately | Rejected |
27.00 | Payment is processed and then reversed after approximately 30 seconds | Reversed |
53.00 | Payment is cancelled | Cancelled |
119.00 | Payment is processed successfully, with an additional information request raised by the banking provider | Processed |
177.00 | Payment is returned with a fee deduction | Returned |
| Any other amount | Payment is processed successfully | Processed |
These simulated outcomes are available in Sandbox only and are intended for integration testing. They do not affect Production withdrawals.
Updated 12 days ago
