v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Payees

List payees

This endpoint will return all payees on your account. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCES to use this endpoint.

get/v1/payees

Query parameters

limitinteger

The number of records to return. Defaults to 10 - max is 200.

offsetinteger

The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will return records 40 to 59.

Response

An array of Payees

totalinteger

The total number of payees in the list.

Example response

{
  "total": 1,
  "fundingSources": [
    {
      "id": 742,
      "currency": {
        "code": "EUR",
        "description": "Euro"
      },
      "status": "LIVE",
      "accountName": "Joe",
      "accountHolderName": "Joe Bloggs",
      "bic": "BOFIIE2DXXX",
      "iban": "IE86BOFI90535211111111",
      "nsc": "998822",
      "accountNumber": "12345678",
      "createdBy": "CUSTOMER",
      "dateCreated": "2019-08-22T07:48:56.460Z"
    }
  ]
}