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
{
recipient(id: "12341234123412341234") {
accountIdType
currency
country
email
# there are many other properties
}
}
{
"data": {
"recipient": {
"accountIdType": "ACC NO",
"currency": "USD",
"country": "AU",
"email": "[email protected]"
}
}
}

Query multiple recipients

Query
Response
{
recipients(input: { currency: USD }) {
accountIdType
currency
country
email
# there are many other properties
}
}
{
"data": {
"recipients": [
{
"accountIdType": "ACC NO",
"currency": "USD",
"country": "AU",
"email": "[email protected]"
}
]
}
}

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
mutation {
createRecipient(
input: {
firstName: "John"
lastName: "Malkovich"
accountIdType: BSB
currency: AUD
bsb: "123456"
accountNo: "12341234"
address: {
street: "22 Woolooware Rd"
suburb: "Woolooware"
state: "NSW"
country: AU
postcode: "2230"
}
}
) {
success
code
message
recipient {
id
nickName
accountIdType
currency
email
# there are many other properties
}
}
}
{
"data": {
"createRecipient": {
"success": true,
"code": "SUCCESS",
"message": "Recipient created",
"recipient": {
"id": "5ba89a6b35a2b327b81ffc3b",
"nickName": "JohnMalkov",
"currency": "AUD",
"email": "[email protected]"
}
}
}
}

Update recipient

Query
Response
mutation {
updateRecipient(
id: "5ba89a6b35a2b327b81ffc3b",
input: {
nickName: "JohnM"
firstName: "John"
lastName: "Malkovich"
accountIdType: BSB
currency: AUD
bsb: "123456"
accountNo: "12341234"
address: {
street: "22 Woolooware Rd"
suburb: "Woolooware"
state: "NSW"
country: AU
postcode: "2230"
}
}
) {
success
code
message
recipient {
id
nickName
# there are many other properties
}
}
}
{
"data": {
"createRecipient": {
"success": true,
"code": "SUCCESS",
"message": "Recipient updated",
"recipient": {
"id": "5ba89a6b35a2b327b81ffc3b",
"nickName": "JohnM"
}
}
}
}

Delete recipient

Query
Response
mutation {
deleteRecipient(id: "5ba89a6b35a2b327b81ffc3b") {
success code message
}
}
{
"data": {
"deleteRecipient": {
"success": true,
"code": "SUCCESS",
"message": "Recipient deleted"
}
}
}
Copy link
Edit on GitHub
On this page