GRgriffin
Payees

List legal person payees

Changed on

Lists payees belonging to the legal person.

get/v0/legal-persons/{legal-person-id}/bank/payees

Request

  • Base URL
    https://api.griffin.com
  • Auth
    API key in header Authorization

Path parameters

legal-person-idstring required

Query parameters

sort'-created-at' | 'created-at'
includestring[]

For each payee returned, include its Confirmation of Payee (CoP) details (if they exist) in the response under the included attribute.

page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

includedunknown

Example response

{
  "payees": [
    {
      "account-number": "12345678",
      "bank-id": "123456",
      "country-code": "GB"
    }
  ]
}

Changes