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
andrecipients
queries - read your address book.createRecipient
- creates a new record in the Flash Payments database.updateRecipient
- updates an existing recipient.deleteRecipient
- deletes an existing recipient.
Query single recipient
{
recipient(id: "12341234123412341234") {
accountIdType
currency
country
email
# there are many other properties
}
}
Query multiple recipients
{
recipients(input: { currency: USD }) {
accountIdType
currency
country
email
# there are many other properties
}
}
Create a recipient
mutation {
createRecipient(
input: {
firstName: "John"
lastName: "Malkovich"
dob: "1987-06-05"
accountIdType: BSB
currency: AUD
bsb: "370370"
accountNo: "12341234"
email: "[email protected]"
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
}
}
}
Update recipient
mutation {
updateRecipient(
id: "5ba89a6b35a2b327b81ffc3b",
input: {
nickName: "JohnM"
firstName: "John"
lastName: "Malkovich"
accountIdType: BSB
currency: AUD
bsb: "370370"
accountNo: "12341234"
email: "[email protected]"
address: {
street: "22 Woolooware Rd"
suburb: "Woolooware"
state: "NSW"
country: AU
postcode: "2230"
}
}
) {
success
code
message
recipient {
id
nickName
# there are many other properties
}
}
}
Delete recipient
mutation {
deleteRecipient(id: "5ba89a6b35a2b327b81ffc3b") {
success code message
}
}
Last updated
Was this helpful?