Recipients
CRUD queries for your payment recipients
We are legally obliged to collect the actual recipient details. Please, do not send us an intermediate organisation details such as exchanges, banks, gateways, etc.
Please, send us the final funds recipient. If sending to self then please provide your own details. See the DOCS in Playground for other recipient details options.
  • recipient and recipients queries - read your address book.
  • createRecipient - creates a new record in the FlashFX database.
  • updateRecipient - updates an existing recipient.
  • deleteRecipient - deletes an existing recipient.

Query single recipient

Query
Response
1
{
2
recipient(id: "12341234123412341234") {
3
accountIdType
4
currency
5
country
6
email
7
# there are many other properties
8
}
9
}
Copied!
1
{
2
"data": {
3
"recipient": {
4
"accountIdType": "ACC NO",
5
"currency": "USD",
6
"country": "AU",
7
"email": "[email protected]"
8
}
9
}
10
}
Copied!

Query multiple recipients

Query
Response
1
{
2
recipients(input: { currency: USD }) {
3
accountIdType
4
currency
5
country
6
email
7
# there are many other properties
8
}
9
}
Copied!
1
{
2
"data": {
3
"recipients": [
4
{
5
"accountIdType": "ACC NO",
6
"currency": "USD",
7
"country": "AU",
8
"email": "[email protected]"
9
}
10
]
11
}
12
}
Copied!

Create a recipient

In addresses the suburb is an Australian suburb. For other countries you should put the city (e.g. Manila or London) or any other small administrative area name.
Query
Response
1
mutation {
2
createRecipient(
3
input: {
4
firstName: "John"
5
lastName: "Malkovich"
6
accountIdType: BSB
7
currency: AUD
8
bsb: "123456"
9
accountNo: "12341234"
10
11
address: {
12
street: "22 Woolooware Rd"
13
suburb: "Woolooware"
14
state: "NSW"
15
country: AU
16
postcode: "2230"
17
}
18
}
19
) {
20
success
21
code
22
message
23
recipient {
24
id
25
nickName
26
accountIdType
27
currency
28
email
29
# there are many other properties
30
}
31
}
32
}
Copied!
1
{
2
"data": {
3
"createRecipient": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Recipient created",
7
"recipient": {
8
"id": "5ba89a6b35a2b327b81ffc3b",
9
"nickName": "JohnMalkov",
10
"currency": "AUD",
11
"email": "[email protected]"
12
}
13
}
14
}
15
}
Copied!

Update recipient

Query
Response
1
mutation {
2
updateRecipient(
3
id: "5ba89a6b35a2b327b81ffc3b",
4
input: {
5
nickName: "JohnM"
6
7
firstName: "John"
8
lastName: "Malkovich"
9
accountIdType: BSB
10
currency: AUD
11
bsb: "123456"
12
accountNo: "12341234"
13
14
address: {
15
street: "22 Woolooware Rd"
16
suburb: "Woolooware"
17
state: "NSW"
18
country: AU
19
postcode: "2230"
20
}
21
}
22
) {
23
success
24
code
25
message
26
recipient {
27
id
28
nickName
29
# there are many other properties
30
}
31
}
32
}
Copied!
1
{
2
"data": {
3
"createRecipient": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Recipient updated",
7
"recipient": {
8
"id": "5ba89a6b35a2b327b81ffc3b",
9
"nickName": "JohnM"
10
}
11
}
12
}
13
}
Copied!

Delete recipient

Query
Response
1
mutation {
2
deleteRecipient(id: "5ba89a6b35a2b327b81ffc3b") {
3
success code message
4
}
5
}
Copied!
1
{
2
"data": {
3
"deleteRecipient": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Recipient deleted"
7
}
8
}
9
}
Copied!
Last modified 5mo ago
Copy link
Contents