Withdraw funds
Send money from your Flash Payments balances to Australian bank accounts or internationally per your approved use case.
Last updated
Was this helpful?
Send money from your Flash Payments balances to Australian bank accounts or internationally per your approved use case.
Last updated
Was this helpful?
To make a withdrawal, you need to execute the createWithdrawal
mutation as below.
externalReference
Arbitrary text, which will be seen in the ultimate recipient's bank statement. E.g. "invoice #123"
. Will be eventually truncated to 18
ASCII chars if delivered via Australia's old (DE, Direct Entry) payment system. However, if you choose to use the real-time NPP network, then the maximum length is 280
chars.
recipientId
senderId
or subClientId
, or neitherTo use subClientId
as the sender for your withdrawal, please execute the createWithdrawal
mutation as below.
We are legally obliged to collect the actual sender and beneficiary details. Please do not send us intermediate organisation details such as exchanges, banks, gateways, etc.
If sending from yourself, there's an option to use your company's Flash account details as sender by default. Please consider the example below.
If your company is the ultimate sender for a withdrawal, you can skip both the senderId
and subClientId
. In this situation, we will use your company’s Flash account as the sender for the transaction. Please note that a new sender record will not be created in this case.
Please execute the following createWithdrawal
mutation to use your company's Flash account details as sender.
An organisation that instructed you to make a withdrawal. This data is mandatory if you submit this withdrawal on behalf of another financial institution.
instructingInstitutionId
This optional field refers to an existing Institution
that was created earlier in the Flash Connect interface or via this API.
instructingInstitution
fieldBy instructingInstitution.externalId
if present.
By instructingInstitution.businessNumber
AND instructingInstitution.address.country
We recommend against continuous polling for withdrawal status changes. Instead, please use callbackUri
.
You should and provide us with their ID. The recipient's Australian account must be either BSB
or PAYID
(coming soon).
In the above createWithdrawal
example, you had to first and use senderId
as an input. Alternatively, if your account is configured to disburse funds on behalf of your , you may provide us with the sub-client ID, and the withdrawal created will be linked to that sub-client. In this case, the subClientId
will be used as the sender and will be reported to the government.
If it is an intermediate, please see instead.
Please always send us the ultimate sender and recipient. If sending to yourself, please provide your own details. See the schema in for other recipient details options.
For more information please see .
Optional field that allows you to provide details without pre-creating one. Once passed, Flash Payments will create the Institution for you. Before creating an institution, we will try to find an existing one:
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 can be found on the .
The callback (aka ) endpoint URI can be invoked by anyone on the internet. Thus opening up a potential attack vector. See page to secure your data properly.