Flash Payments Developer API
Back to Flash PaymentsGraphQL Playground
  • Overview
  • Basics
    • Sending data as JSON
  • Authentication
  • Quote
  • Conversions
    • Query conversions
    • Conversion statuses
  • Balance
    • Statement
  • Recipients
    • Required fields
  • Senders
  • Payments
    • Payment statuses
    • Query payments
    • Send funds
    • Auto receive funds
  • Institutions
  • Withdrawals
    • Withdraw funds
    • Withdrawal statuses
    • Query withdrawals
  • Deposits
    • Deposit statuses
    • Query deposits
    • Refund deposits
  • Sub-clients
    • Create sub-clients
    • Disable, Activate and Update sub-clients
    • Query sub-clients
  • Webhooks
    • Regular webhooks
    • Ad hoc webhooks
  • Reference data
    • Bank information
    • Rejection codes
  • Change log
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF

Deposits

Explains how to accept deposits programmatically

PreviousQuery withdrawalsNextDeposit statuses

Last updated 3 months ago

Was this helpful?

After fully registering with us, you get a BSB and a dedicated Virtual Account Number (VAN).

Warning: The account number can only process local transfers, no SWIFT/RTGS.

Every deposit to this account would increase your Flash Payments balance.

You can receive notifications via about every deposit.

The deposit data includes the payment reference (we call it externalReference in this API).

By default, only yourself is allowed to deposit. However, we can enable third party deposits feature for your account. This, effectively, makes your account number a local collection account.

We can also enable the feature. It allows you to programmatically create client accounts with dedicated BSB and account number for transactional purposes. You can give these bank account details to your clients to accept deposits. Once funds arrive, we will increase your account balance, and you will see a deposit with sub-client information linked to it.

To browse your deposits, you can use our FlashConnect tool:

Tip. You can simulate and test a deposit with the FlashConnect tool in the UAT environment. Just go to the Deposits page and click "SEND TEST DEPOSIT". Additionally, you can test a deposit sent by your in the UAT. Just go to the Sub-clients page, find the sub-client, and click "SEND TEST DEPOSIT".

Webhooks
sub-client
https://connect.uat.flash-payments.com.au/
sub-client