Get payee

Retrieves one of the authenticated client's payees with all details. Deleted payees are returned with isDeleted true; a payee that does not exist or belongs to another client returns 404. channel is how the payee was created: Portal, Api, or Brokered when an operator created it on the client's behalf. accountNameVerification is the Confirmation of Payee result for GB sort-code payees; it is null when no verification applies or the record cannot be found. Returns 503 when the verification service is unavailable.

Path Params
string
required

The unique identifier of the payee

Headers
string
required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json