Withdraw funds

This will send money from your FlashFX balance to bank account(s)

‚Äč

To do a withdrawal (AUD only) you need to execute the createWithdrawal mutation as below.

Note you must have an AUD balance in your account to do a withdrawal.

Query
Response
Query
mutation {
createWithdrawal(
input: {
amount: 1000
recipientId: "5ba89a6b35a2b327b81ffc3b",
senderId: "5eaf71a1cb328c56f94f9375",
acceptingInstructionInstitutionSenderId: "5eaf7159cb328c56f94f936d",
acceptingMoneyInstitutionSenderId: "5eaf9e9b1c84a7678d3f7c6c"
externalId: "12344321"
}
) {
success
code
message
withdrawal {
id
status
amount
}
}
}
Response
{
"data": {
"createWithdrawal": {
"success": true,
"code": "OK",
"message": "Scheduled for immediate execution",
"withdrawal": {
"id": "60711af8c078ba061f623531",
"status": "PENDING",
"amount": 1000
}
}
}
}

Recipient - recipientId

You should pre-create recipients and provide us their ID. The recipient's account must be either BSB or PAYID.

Sender - senderId

You should pre-create senders and provide us their ID.

We are legally obliged to collect the actual sender and beneficiary details. Please, do not send us an intermediate organisation details such as exchanges, banks, gateways, etc.

Please, send us the final funds sender and recipient. If sending to self then please provide your own details. See the schema in Playground for other recipient details options.

Sender Institution - acceptingInstructionInstitutionSenderId

This optional element is a reference to a sender object to give the information about the party who this withdrawal ultimately came from. This is normally the financial institution that accepts an instruction from a customer to transfer money electronically to a beneficiary institution so that it reaches the intended recipient. This is not the sender. If there is no other institution who has instructed this withdrawal, leave this blank and your own details will be used for compliance and auditing purposes.

Accepting Institution - acceptingMoneyInstitutionSenderId

This optional element is a reference to a sender object to give the information about the party who this withdrawal ultimately came from. This is normally the financial institution that accepts money from a customer to transfer money electronically to a beneficiary institution so that it reaches the intended recipient. These details are needed for AML/KYC obligations here in Australia. This is not the sender. If there is no other institution who has accepted money that will result with this withdrawal, leave this blank and your own details will be used for compliance and auditing purposes.

Callback (aka Webhook) URI

We recommend against continuous polling for withdrawal status changes. Instead, please use callbackUri.

The optional callbackUri will be invoked several times during the processing of a withdrawal. These callbacks will usually occur soon (within several seconds) after the initial create withdrawal call - but may be delayed in some cases. The example JSON payloads are below.

withdrawal_initiated
withdrawal_completed
withdrawal_failed
withdrawal_cancelled
withdrawal_initiated
{
"event": "withdrawal_initiated",
"id": "51711af8c078ba061f623531",
"amount": 2000,
"currency": "AUD",
"externalId": "12344321"
}
withdrawal_completed
{
"event": "withdrawal_completed",
"id": "51711af8c078ba061f623531",
"amount": 2000,
"currency": "AUD",
"externalId": "12344321"
}
withdrawal_failed
{
"event": "withdrawal_failed",
"id": "51711af8c078ba061f623531",
"amount": 2000,
"currency": "AUD",
"externalId": "12344321"
}
withdrawal_cancelled
{
"event": "withdrawal_failed",
"id": "51711af8c078ba061f623531",
"amount": 2000,
"currency": "AUD",
"externalId": "12344321"
}

Security note

The callback (aka webhook) endpoint URI can be invoked by anyone in the internet. Thus opening up a potential attack vector. See Webhooks page to secure your data properly.