Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 3.98 KB

withdraw-funds.md

File metadata and controls

109 lines (82 loc) · 3.98 KB
Raw
description
Send money from your Flash Payments balance to Australian bank accounts

Withdraw funds

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

{% hint style="info" %} Note you must have an AUD balance in your account to do a withdrawal. {% endhint %}

{% tabs %} {% tab title="Query" %}

mutation {
  createWithdrawal(
    input: {
      amount: 1000
      externalReference: "invoice #123"
      recipientId: "5ba89a6b35a2b327b81ffc3b",
      senderId: "5eaf71a1cb328c56f94f9375",
      externalId: "12344321"
      idempotencyKey: "12344321"
    }
  ) {
    success
    code
    message
    withdrawal {
      id
      status
      amount
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "createWithdrawal": {
      "success": true,
      "code": "OK",
      "message": "Scheduled for immediate execution",
      "withdrawal": {
        "id": "60711af8c078ba061f623531",
        "status": "PENDING",
        "amount": 1000
      }
    }
  }
}

{% endtab %} {% endtabs %}

Payment reference - 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

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.

{% hint style="warning" %} 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, send us the final funds sender and recipient. If sending to yourself then please provide your own details. See the schema in Playground for other recipient details options. {% endhint %}

Instructing Institutions

An organisation that instructed you to make a withdrawal. This data is mandatory if you submit this withdrawal on behalf of other financial institution.

{% hint style="info" %} For more information please see Institutions. {% endhint %}

Using existing institutions 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

Optional 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 AND instructingInstitution.address.country

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 can be found on the Webhooks page.

{% hint style="danger" %}

Security note

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