v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

payees

Retrieve all payees created by an API client

Requires payee:read scope. Default limit is set to 10.

get/payees

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

userIdstring

The user ID to query payees on

hasUserIdboolean

Determine if you want to return payees with user ID of not

Response

Successful Payee Response

Example response

{
  "data": [
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "clientId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
      "sortCode": "123456",
      "accountNumber": "12345678",
      "createdAt": "2018-07-10T12:00:00+00:00",
      "modifiedAt": "2018-08-10T12:00:00+00:00",
      "name": "Payee 1",
      "displayName": "Payee One",
      "externalId": "external-id",
      "userId": "5349b4ddd2781d08c09890f3"
    }
  ]
}