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
Query
{
sender(id: "59f2733f2519e236edab0efe") {
email
firstName
lastName
companyName
address {
country
}
}
}
Response
{
"data": {
"sender": {
"email": "john@example.com",
"firstName": "John",
"lastName": "Smith",
"companyName": null,
"address": {
"country": "AU"
}
}
}
}

Query multiple senders

Query
Response
Query
{
senders(input: { email: "john@example.com" }) {
email
firstName
lastName
companyName
address {
country
}
# there are other properties
}
}
Response
{
"data": {
"senders": [
{
"email": "john@example.com",
"firstName": "John",
"lastName": "Smith",
"companyName": null,
"address": {
"country": "AU"
}
},
{
"email": "john@example.com",
"firstName": null,
"lastName": null,
"companyName": "Acme Inc",
"address": {
"country": "US"
}
},
]
}
}

Create a sender

Query
Response
Query
mutation {
createSender(
input: {
firstName: "Malcolm"
lastName: "Jez"
dob: "2000-01-01"
email: "malcolm@example.com"
mobile: "+1 123412341234"
address: {
street: "1 Test St"
suburb: "Testville"
state: "TST"
country: AU
postcode: "2000"
}
}
) {
success
code
message
sender {
id
nickName
# there are many other properties
}
}
}
Response
{
"data": {
"createSender": {
"success": true,
"code": "SUCCESS",
"message": "Sender created",
"sender": {
"id": "5ca18312ace1db0af5784826",
"nickName": "MalcolmJez"
}
}
}
}

Update sender

Query
Response
Query
mutation {
updateSender(
id: "5ca18312ace1db0af5784826"
input: {
firstName: "Malcolm"
lastName: "Jez The Seconds"
dob: "2000-01-01"
email: "malcolm@example.com"
mobile: "+1 123412341234"
address: {
street: "1 Test St"
suburb: "Testville"
state: "TST"
country: AU
postcode: "2001"
}
}
) {
success
code
message
sender {
id
# there are many other properties
}
}
}
Response
{
"data": {
"updateSender": {
"success": true,
"code": "SUCCESS",
"message": "Sender updated",
"sender": {
"id": "5ca18312ace1db0af5784826"
}
}
}
}

Delete sender

Query
Response
Query
mutation {
deleteSender(id: "5ca18d25ace1db0af5784893") {
success code message
}
}
Response
{
"data": {
"deleteSender": {
"success": true,
"code": "SUCCESS",
"message": "Sender deleted"
}
}
}

‚Äč