Withdraw funds
Send money from your Flash Payments balances to Australian bank accounts or internationally per your approved use case.
To make a withdrawal, you need to execute the createWithdrawal
mutation as below.
Payment reference - externalReference
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.
Recipient - recipientId
recipientId
You should pre-create recipients and provide us with their ID. The recipient's Australian account must be either BSB
or PAYID
(coming soon).
Sender - senderId
or subClientId
, or neither
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 it is an intermediate, please see Instiutions instead.
Please always send us the ultimate sender and recipient. If sending to yourself, please provide your own details. See the schema in Playground for other recipient details options.
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.
Instructing Institutions
An organisation that instructed you to make a withdrawal. This data is mandatory if you submit this withdrawal on behalf of another financial institution.
Using existing institutions instructingInstitutionId
instructingInstitutionId
This optional field refers to an existing Institution
that was created earlier in the Flash Connect interface or via this API.
Create institutions on the fly using the instructingInstitution
field
instructingInstitution
fieldOptional field that allows you to provide Institution 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:
By
instructingInstitution.externalId
if present.By
instructingInstitution.businessNumber
ANDinstructingInstitution.address.country
Callback (aka Webhook) URI
We recommend against continuous polling for withdrawal status changes. Instead, please use callbackUri
.
Last updated
Was this helpful?