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 you want to receive funds from yourself then please provide your own details. See the DOCS in Playground for other sender details options.
sender
andsenders
queries - read your address book.createSender
- creates a new record in the Flash Payments database.updateSender
- updates an existing sender.deleteSender
- deletes an existing sender.
Query single sender
const bodyJSON = {
variables: {
input: "59f2733f2519e236edab0efe",
},
query: `
query ($input: ID) {
sender(id: $input) {
email firstName lastName companyName
address {
country
}
}
}`,
};
Query multiple senders
const bodyJSON = {
variables: {
input: {
email: "[email protected]",
},
},
query: `
query ($input: RecipientQueryInput!) {
senders(input: $input) {
email firstName lastName companyName
address {
country
}
}
}`,
};
Create a sender
Create an Individual sender
const bodyJSON = {
variables: {
input: {
firstName:"Malcolm",
lastName:"Jez",
dob:"2000-01-01",
email:"[email protected]",
mobile:"+61 4123456789",
address: {
street:"1 Test St",
suburb:"London",
state:"TST",
country:"GB",
postcode:"2000",
},
idDoc: {
type:"passport",
docNumber:"GB1234321",
issuer:"His Majesty’s Passport Office (HMPO)",
issueDate:"1990-01-01",
expiryDate:"2045-01-01",
country:"GB",
},
},
},
query: `
mutation ($input: SenderInput!) {
createSender(input: $input) {
success code message
sender {
id nickName
}
}
}`,
};
Create a Company sender
const bodyJSON = {
variables: {
input: {
companyName: "Acme Pte Ltd",
businessNumber: "12345678912",
email: "[email protected]",
mobile: "+61 4123456789",
address: {
street: "1 Test St",
suburb: "London",
state: "TST",
country: "GB",
postcode: "2000",
},
idDoc: {
type: "certificateOfRegistration",
docNumber: "GB-REG-987654321",
issuer: "Companies House",
issueDate: "1990-01-01",
expiryDate: "2100-01-01",
country: "GB",
},
},
},
query: `
mutation ($input: SenderInput!) {
createSender(input: $input) {
success code message
sender {
id nickName
}
}
}`,
};
Update sender
const bodyJSON = {
variables: {
input: {
firstName:"Malcolm",
lastName:"Jez The Second",
dob:"2000-01-01",
email:"[email protected]",
mobile:"+61 4123456789",
address: {
street:"1 Test St",
suburb:"London",
state:"TST",
country:"GB",
postcode:"2000",
},
},
},
query: `
mutation ($input: SenderInput!) {
updateSender(input: $input) {
success code message
sender {
id lastName
}
}
}`,
};
Delete sender
const bodyJSON = {
variables: {
input:"686393e689c1fb1b255cac5c",
},
query: `
mutation ($input: ID) {
deleteSender(id: $input) {
success code message
}
}`,
};
Last updated
Was this helpful?