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 and senders 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

Query

{
  sender(id: "59f2733f2519e236edab0efe") {
    email
    firstName
    lastName
    companyName
    address {
      country
    }
  }
}

Response

{
  "data": {
    "sender": {
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "companyName": null,
      "address": {
        "country": "GB"
      }
    }
  }
}

Query multiple senders

Query

{
  senders(input: { email: "[email protected]" }) {
    email
    firstName
    lastName
    companyName
    address {
      country
    }
    # there are other properties
  }
}

Response

{
  "data": {
    "senders": [
      {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "companyName": null,
        "address": {
          "country": "GB"
        }
      },
      {
        "email": "[email protected]",
        "firstName": null,
        "lastName": null,
        "companyName": "Acme Inc",
        "address": {
          "country": "US"
        }
      },
    ]
  }
}

Create a sender

In addresses thesuburbfield is an Australian suburb. For other countries you should put the city (e.g. Manila or London) or any other small administrative area name.

If you find it technically challenging to submit all components of the sender’s address, we would appreciate it if you could at least collect the sender’s country along with a complete address string that includes the postcode and put them into the country and street fields, respectively. In this case, you can skip the postcode, suburb, and state fields, and the sender record will still be created.

The date of birth (dob) is not mandatory. However, if it is not provided, your transactions may undergo additional compliance reviews, which can lead to longer processing times—potentially several hours or days instead of seconds. Please also be aware that this may result in additional fees to cover the extra effort involved.

Individual

mutation {
  createSender(
    input: {
      firstName: "Malcolm"
      lastName: "Jez"
      dob: "2000-01-01"
      email: "[email protected]"
      mobile: "[phone]"
      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
      }
    }
  ) {
    success
    code
    message
    sender {
      id
      nickName
      # there are many other properties
    }
  }
}

Company/Corporate

mutation {
  createSender(
    input: {
      companyName: "Acme Pte Ltd"
      businessNumber: "12345678912"
      email: "[email protected]"
      mobile: "[phone]"
      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
      }
    }
  ) {
    success
    code
    message
    sender {
      id
      nickName
      # there are many other properties
    }
  }
}

Update sender

Query

mutation {
  updateSender(
    id: "5ca18312ace1db0af5784826"
    input: {
      firstName: "Malcolm"
      lastName: "Jez The Seconds"
      dob: "2000-01-01"
      email: "[email protected]"
      mobile: "[phone]"
      address: {
        street: "1 Test St"
        suburb: "London"
        state: "TST"
        country: GB
        postcode: "2001"
      }
      idDoc: {
        type: passport
        docNumber: "GB1234321"
        issuer: "His Majesty’s Passport Office (HMPO)"
        issueDate: "1990-01-01"
        expiryDate: "2045-01-01"
        country: GB
      }
    }
  ) {
    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

mutation {
  deleteSender(id: "5ca18d25ace1db0af5784893") {
    success code message
  }
}

Response

{
  "data": {
    "deleteSender": {
      "success": true,
      "code": "SUCCESS",
      "message": "Sender deleted"
    }
  }
}