Senders
CRUD queries for your payment senders
We are legally obliged to collect the actual sender details. Please, do not send us an intermediate organisation details such as exchanges, banks, gateways, etc.
If receiving from yourself then please provide your own details. See the DOCS in Playground for other sender details options.
  • sender and senders queries - read your address book.
  • createSender - creates a new record in the FlashFX database.
  • updateSender - updates an existing sender.
  • deleteSender - deletes an existing sender.

Query single sender

Query
Response
1
{
2
sender(id: "59f2733f2519e236edab0efe") {
3
email
4
firstName
5
lastName
6
companyName
7
address {
8
country
9
}
10
}
11
}
Copied!
1
{
2
"data": {
3
"sender": {
4
"email": "[email protected]",
5
"firstName": "John",
6
"lastName": "Smith",
7
"companyName": null,
8
"address": {
9
"country": "GB"
10
}
11
}
12
}
13
}
Copied!

Query multiple senders

Query
Response
1
{
2
senders(input: { email: "[email protected]" }) {
3
email
4
firstName
5
lastName
6
companyName
7
address {
8
country
9
}
10
# there are other properties
11
}
12
}
Copied!
1
{
2
"data": {
3
"senders": [
4
{
5
"email": "[email protected]",
6
"firstName": "John",
7
"lastName": "Smith",
8
"companyName": null,
9
"address": {
10
"country": "GB"
11
}
12
},
13
{
14
"email": "[email protected]",
15
"firstName": null,
16
"lastName": null,
17
"companyName": "Acme Inc",
18
"address": {
19
"country": "US"
20
}
21
},
22
]
23
}
24
}
Copied!

Create a sender

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
createSender(
3
input: {
4
firstName: "Malcolm"
5
lastName: "Jez"
6
dob: "2000-01-01"
8
mobile: "+1 123412341234"
9
address: {
10
street: "1 Test St"
11
suburb: "London"
12
state: "TST"
13
country: GB
14
postcode: "2000"
15
}
16
}
17
) {
18
success
19
code
20
message
21
sender {
22
id
23
nickName
24
# there are many other properties
25
}
26
}
27
}
Copied!
1
{
2
"data": {
3
"createSender": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Sender created",
7
"sender": {
8
"id": "5ca18312ace1db0af5784826",
9
"nickName": "MalcolmJez"
10
}
11
}
12
}
13
}
Copied!

Update sender

Query
Response
1
mutation {
2
updateSender(
3
id: "5ca18312ace1db0af5784826"
4
input: {
5
firstName: "Malcolm"
6
lastName: "Jez The Seconds"
7
dob: "2000-01-01"
9
mobile: "+1 123412341234"
10
address: {
11
street: "1 Test St"
12
suburb: "London"
13
state: "TST"
14
country: GB
15
postcode: "2001"
16
}
17
}
18
) {
19
success
20
code
21
message
22
sender {
23
id
24
# there are many other properties
25
}
26
}
27
}
Copied!
1
{
2
"data": {
3
"updateSender": {
4
"success": true,
5
"code": "SUCCESS",
6
"message": "Sender updated",
7
"sender": {
8
"id": "5ca18312ace1db0af5784826"
9
}
10
}
11
}
12
}
Copied!

Delete sender

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