Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Payees

Create payee

Registers a new payee with a legal person.

You may associate the outcome of a CoP request with the payee by supplying a cop-request-url.

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

Path parameters

legal-person-idstring required

Request body

account-holderstring required

The name of the account holder.

account-numberstring required

A UK account number.

bank-idstring required

A UK sort code.

Example request

{
  "account-number": "12345678",
  "bank-id": "123456"
}

Response

Created

account-numberstring required

A UK account number.

account-holderstring required

The name of the account holder.

bank-idstring required

A UK sort code.

created-atstring date-time required

ISO 8601 formatted date-time.

payee-status'deactivated' | 'active' required

The status of the payee; you can only make payments to active payees.

country-codestring required

ISO 3166-1 alpha-2 two-letter country code.

Example response

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