Deposits
Explains how to accept deposits programmatically
After fully registering with us, you get a BSB and a dedicated bank account number.
Warning: The account number can only process local transfers, no SWIFT/RTGS.
Every deposit to this account would increase your FlashFX balance.
You can receive notifications via Webhooks 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 sub-client feature. It allows you to programmatically create client accounts for transaction purposes, with dedicated BSB and account number. 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: https://connect.flash-fx.com/
Tip. You can simulate a deposit using the FlashConnect tool. Just go to the Deposits page and click "SEND TEST DEPOSIT". It's available only in our development environment. Additionally, you can fake a deposit sent by your sub-client. Just go to the Sub-clients page, find the sub-client, and click "SEND TEST DEPOSIT". It's available only in our development environment.

Deposit processing statuses

As soon as we see a deposit in FlashFX controlled bank account(s) we create a confirmed deposit.
(none) -> CONFIRMED
If you choose to reject that deposit it goes through refunding statuses:
CONFIRMEDREFUNDINGREFUNDED

Querying deposits

Query all deposits

Request
Response
1
{
2
deposits {
3
id
4
amount
5
currency
6
status
7
statusMessage
8
externalId
9
externalReference
10
subClient {
11
id
12
fullName
13
status
14
clientType
15
}
16
createdAt
17
# more fields available, see API schema
18
}
19
}
Copied!
1
{
2
"data": {
3
"deposits": [
4
{
5
"id": "6053d4e0e3bc655e0598a742",
6
"amount": 2000,
7
"currency": "AUD",
8
"status": "CONFIRMED",
9
"statusMessage": "Transaction Confirmed",
10
"externalId": "PR.1vcl",
11
"externalReference": "FX1111",
12
"subClient": null,
13
"createdAt": "2021-03-18T22:32:01.010Z"
14
},
15
{
16
"id": "6053d3319588389e1443587e",
17
"amount": 40,
18
"currency": "AUD",
19
"status": "CONFIRMED",
20
"statusMessage": "Transaction Confirmed",
21
"externalId": "PR.1vci",
22
"externalReference": "FX2121",
23
"subClient": {
24
"id": "5fb314cb9224595df522db61",
25
"fullName": "John Doe",
26
"status": "ACTIVE",
27
"clientType": "INDIVIDUAL"
28
},
29
"createdAt": "2021-03-18T22:24:49.096Z"
30
},
31
]
32
}
33
}
Copied!

Query deposit by ID

Query
Response
1
{
2
deposit(id: "6053d4e0e3bc655e0598a742") {
3
id
4
amount
5
currency
6
status
7
statusMessage
8
externalId
9
externalReference
10
createdAt
11
# more fields available, see API schema
12
}
13
}
14
Copied!
1
{
2
"data": {
3
"deposit": {
4
"id": "6053d4e0e3bc655e0598a742",
5
"amount": 2000,
6
"currency": "AUD",
7
"status": "CONFIRMED",
8
"statusMessage": "Transaction Confirmed",
9
"externalId": "PR.1vcl",
10
"externalReference": "KX23249",
11
"createdAt": "2021-03-18T22:32:01.010Z"
12
}
13
}
14
}
Copied!
Last modified 6mo ago