Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Payees

Update payee

Updates an existing payee.

You can update a payee with the outcome of a CoP request by supplying a cop-request-url.

A payee can be deactivated by updating the payee-status of an active payee to deactivated. Any attempt to create or submit a payment to a deactivated payee will fail.

A 422 is served when attempting to deactivate an already-deactivated payee.

patch/v0/payees/{payee-id}

Path parameters

payee-idstring required

Request body

payee-status'deactivated'

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

Response

OK

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"
}