latestOpenAPI 3.0.12026-08-108798310.5 KB

fa1a72b9ecec

Payees

Get an account holder's payees

get/api/v2/payees

Response

Successful operation

Example response

{
  "payees": [
    {
      "payeeUid": "55665566-5566-5566-5566-556655665566",
      "payeeName": "Bob Bobbington",
      "phoneNumber": "+447700900123",
      "firstName": "Bob",
      "middleName": "Bobity",
      "lastName": "Bobbington",
      "businessName": "Trotters Independent Traders",
      "dateOfBirth": "1990-11-30",
      "accounts": [
        {
          "payeeAccountUid": "66776677-6677-6677-6677-667766776677",
          "payeeChannelType": "SETTLE_UP",
          "description": "Bob's business account",
          "defaultAccount": true,
          "countryCode": "GB",
          "accountIdentifier": "12345678",
          "bankIdentifier": "123456",
          "bankIdentifierType": "SORT_CODE"
        }
      ]
    }
  ]
}