Sub-clients
Generate Virtual Account Numbers for your clients for collection
The sub-client feature allows you to create client accounts for deposit collection purposes.
Note. This feature is OFF by default. Contact us if you want it.
Each sub-client will receive a dedicated BSB and account number that you or your clients can use to accept domestic AUD transfers within Australia. The account number will be on your sub-client's (aka merchant's) name.
Warning: The account number can only process local transfers, no SWIFT/RTGS.
All deposits sent to your sub-client bank details are booked on your (master-client) account's balance. Sub-clients can't have their own balances.
Notifications via webhooks will provide important sub-client information as well.

Creating a sub-client

This action creates real bank account. If you ever submit fake, unreal, testing, or incorrect data - you will be immediately blocked from FlashFX services.
Please add all possible precautions, processes, staff training, warning messages, and validation checks to you system(s) before creating a sub-client.
There are two types of sub-clients: company and individual.
If you are creating a sub-client of the company type, we require you to provide extra details:
  • legalName - company legal name
  • businessNumber - company business number (e.g ABN in Australia)
If the above fields are not set, the sub-client will be created as individual type.
You can find the description of each field in the GraphQL API schema.
Query
Response
1
mutation {
2
createSubClient(
3
input: {
4
legalName: "Chineese Tradings"
5
businessNumber: "330782000329701"
6
firstName: "John"
7
lastName: "Smith"
9
mobile: "+61422832849"
10
dob: "1979-05-12"
11
address: {
12
building: "25"
13
street: "Xihu Road, Yuexiu District"
14
suburb: "Guangzhou City"
15
state: "Guangdong Province"
16
postcode: "510030"
17
country: CN
18
}
19
idDoc: {
20
type: passport
21
docNumber: "FF1948394"
22
issuer: "AU"
23
}
24
externalId: "991188227733"
25
}
26
) {
27
success
28
code
29
message
30
subClient {
31
id
32
legalName
33
businessNumber
34
fullName
35
clientType
36
status
37
primaryContact {
38
firstName
39
lastName
40
email
41
mobile
42
dob
43
}
44
address {
45
country
46
}
47
bsb
48
accountNo
49
externalId
50
# more properties available, see API schema
51
}
52
}
53
}
54
Copied!
1
{
2
"data": {
3
"createSubClient": {
4
"success": true,
5
"code": "SUBCLIENT_CREATED",
6
"message": "Sub-client was successfully created",
7
"subClient": {
8
"id": "606d28675a2d931bc925fec2",
9
"legalName": "Chineese Tradings",
10
"businessNumber": "330782000329701",
11
"fullName": "John Smith",
12
"clientType": "INDIVIDUAL",
13
"status": "ACTIVE",
14
"primaryContact": {
15
"firstName": "John",
16
"lastName": "Smith",
17
"email": "[email protected]",
18
"mobile": "+61 422 832 849",
19
"dob": "1979-05-12"
20
},
21
"address": {
22
"country": "CN"
23
},
24
"bsb": "802919",
25
"accountNo": "1066419",
26
"externalId": "991188227733"
27
}
28
}
29
}
30
}
Copied!
You can also disable and activate sub-clients. Deposits sent to a disabled sub-client will no longer be booked against your balance.

Disabling a sub-client

Query
Response
1
mutation {
2
disableSubClient(id: "606128f24bf29139b2cf74ef") {
3
success
4
code
5
message
6
subClient {
7
id
8
status
9
}
10
}
11
}
Copied!
1
{
2
"data": {
3
"disableSubClient": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Sub-client was successfully disabled",
7
"subClient": {
8
"id": "606128f24bf29139b2cf74ef",
9
"status": "DISABLED"
10
}
11
}
12
}
13
}
Copied!

Activating a sub-client

Query
Response
1
mutation {
2
activateSubClient(id: "606128f24bf29139b2cf74ef") {
3
success
4
code
5
message
6
subClient {
7
id
8
status
9
}
10
}
11
}
Copied!
1
{
2
"data": {
3
"activateSubClient": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Sub-client was successfully activated",
7
"subClient": {
8
"id": "606128f24bf29139b2cf74ef",
9
"status": "ACTIVE"
10
}
11
}
12
}
13
}
Copied!

Available queries

Query for a single sub-client

Query
Response
1
{
2
subClient(id: "606d28675a2d931bc925fec2") {
3
id
4
fullName
5
legalName
6
tradingAsName
7
clientType
8
status
9
primaryContact {
10
firstName
11
middleName
12
lastName
13
email
14
dob
15
mobile
16
}
17
address {
18
building
19
street
20
suburb
21
state
22
country
23
postcode
24
}
25
postalAddress {
26
building
27
street
28
suburb
29
state
30
country
31
postcode
32
}
33
businessNumber
34
bsb
35
accountNo
36
externalId
37
fundingAccounts(input: { currencies: [EUR, USD, HKD, CNY] }) {
38
iban
39
accountNo
40
bic
41
currency
42
externalReference
43
}
44
}
45
}
46
Copied!
1
{
2
"data": {
3
"subClient": {
4
"id": "606d28675a2d931bc925fec2",
5
"fullName": "ACME Corp",
6
"legalName": "ACME Corp",
7
"tradingAsName": null,
8
"clientType": "COMPANY",
9
"status": "ACTIVE",
10
"primaryContact": {
11
"firstName": "John",
12
"middleName": null,
13
"lastName": "Smith",
14
"email": "[email protected]",
15
"dob": "1980-12-12",
16
"mobile": "+61 422 832 849"
17
},
18
"address": {
19
"building": "25",
20
"street": "Moore St",
21
"suburb": "Waterloo",
22
"state": "NSW",
23
"country": "AU",
24
"postcode": "2017"
25
},
26
"postalAddress": {
27
"building": "25",
28
"street": "Moore St",
29
"suburb": "Waterloo",
30
"state": "NSW",
31
"country": "AU",
32
"postcode": "2017"
33
},
34
"businessNumber": "91383840265",
35
"bsb": "802919",
36
"accountNo": "1066419",
37
"externalId": "991188227733"
38
}
39
}
40
}
Copied!

Query for multiple sub-clients

Query
Response
1
{
2
subClients {
3
id
4
fullName
5
legalName
6
clientType
7
status
8
businessNumber
9
bsb
10
accountNo
11
externalId
12
# any other set of properties
13
}
14
}
15
Copied!
1
{
2
"data": {
3
"subClients": [
4
{
5
"id": "5fb314cb9224595df522db61",
6
"fullName": "Richard Smith",
7
"legalName": null,
8
"clientType": "INDIVIDUAL",
9
"status": "ACTIVE",
10
"businessNumber": null,
11
"bsb": "802919",
12
"accountNo": "1963041",
13
"externalId": null
14
},
15
{
16
"id": "60612f00a4d7dd5c96e37676",
17
"fullName": "ABC Capital",
18
"legalName": "ABC Co",
19
"clientType": "COMPANY",
20
"status": "ACTIVE",
21
"businessNumber": "839399923932",
22
"bsb": "802919",
23
"accountNo": "1914920",
24
"externalId": null
25
}
26
]
27
}
28
}
Copied!

Query for multiple sub-clients with filters

Query
Response
1
{
2
# more filters available, see SubClientQueryInput in API schema
3
subClients(
4
input: {
5
clientType: INDIVIDUAL
6
status: ACTIVE
7
firstName: "John"
8
lastName: "Smith"
9
address: { country: AU }
10
}
11
) {
12
id
13
fullName
14
clientType
15
status
16
primaryContact {
17
firstName
18
lastName
19
}
20
address {
21
country
22
}
23
}
24
}
25
Copied!
1
{
2
"data": {
3
"subClients": [
4
{
5
"id": "5fb314cb9224595df522db61",
6
"fullName": "John Smith",
7
"clientType": "INDIVIDUAL",
8
"status": "ACTIVE",
9
"primaryContact": {
10
"firstName": "John",
11
"lastName": "Smith"
12
},
13
"address": {
14
"country": "AU"
15
}
16
}
17
]
18
}
19
}
Copied!
Last modified 1mo ago