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 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": "[e-mail]",
      "firstName": "John",
      "lastName": "Smith",
      "companyName": null,
      "address": {
        "country": "GB"
      }
    }
  }
}

Query multiple senders

Query

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

Response

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

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

mutation {
  createSender(
    input: {
      firstName: "Malcolm"
      lastName: "Jez"
      dob: "2000-01-01"
      email: "[e-mail]"
      mobile: "[phone]"
      address: {
        street: "1 Test St"
        suburb: "London"
        state: "TST"
        country: GB
        postcode: "2000"
      }
      idDoc: {
        type: passport
        docNumber: "GB1234321"
        issuer: "GB"
      }
    }
  ) {
    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

mutation {
  updateSender(
    id: "5ca18312ace1db0af5784826"
    input: {
      firstName: "Malcolm"
      lastName: "Jez The Seconds"
      dob: "2000-01-01"
      email: "[e-mail]"
      mobile: "[phone]"
      address: {
        street: "1 Test St"
        suburb: "London"
        state: "TST"
        country: GB
        postcode: "2001"
      }
      idDoc: {
        type: passport
        docNumber: "GB1234321"
        issuer: "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"
    }
  }
}