Endpoint lookup table
Endpoint lookup table
This table lists all the endpoints in our API for the UK, with links to further information. The rows are ordered alphabetically based on the path, ignoring the version number.
| Endpoint | Description |
|---|---|
| GET /v3/Accounts | Get all accounts associated with your institution |
| POST /v3/Accounts | Create an account with the specified name |
| POST /v4/Accounts | Create a new FSCS-protected current account |
| GET /v3/Accounts/{accountId} | Get a detailed view of an account |
| PATCH /v1/Accounts/{accountId} | Amend the properties of an existing account |
| GET /v1/accounts/{accountId}/closure | Get savings account or flexible cash ISA closure status |
| POST /v1/accounts/{accountId}/closure | Close a savings account or flexible cash ISA |
| GET /v2/Accounts/{accountId}/Mandates | Get all of the Direct Debit Instructions associated with the account |
| POST /v1/Accounts/{accountId}/Mandates | Request creation of a Direct Debit Instruction |
| DELETE /v1/Accounts/{accountId}/Mandates/{mandateId} | Request cancellation for a Direct Debit Instruction |
| PATCH /v1/Accounts/{accountId}/Mandates/{mandateId} | Request amendments to Direct Debit Instruction |
| GET /v2/Accounts/{accountId}/Mandates/{mandateId}/Collections | Get a collection of transactions for account Instruction |
| POST /v1/Accounts/{accountId}/Mandates/{mandateId}/Returns | Request rejection for the supplied Direct Debit Instruction identifier |
| GET /v2/Accounts/{accountId}/Mandates/Unpaid | Get a list of all unpaid transactions belonging to an account |
| GET /v1/accounts/{accountId}/nominated-account | Get a nominated account for a flexible cash ISA or savings account |
| PUT /v1/accounts/{accountId}/nominated-account | Set a nominated account for a flexible cash ISA or savings account |
| GET /v2/Accounts/{accountId}/Transactions | Get a summary of all of the transactions from the specified account |
| GET /v2/Accounts/{accountId}/Transactions/{transactionId} | Get the details of a specific transaction from the specified account |
| POST /v1/Accounts/{accountId}/Transactions/Returns | Create a return of one or more Direct Debit or Direct Credit transactions for the account |
| GET /v2/Accounts/{accountId}/Virtual | Get a list of virtual accounts belonging to a given real account |
| POST /v2/Accounts/{accountId}/Virtual | Create a series of virtual accounts |
| DELETE /v1/Accounts/{accountId}/Virtual/{virtualAccountId} | Disable the virtual account that belongs to the given account |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId} | Get a specific virtual account |
| PATCH /v1/Accounts/{accountId}/Virtual/{virtualAccountId} | Amend the properties of an existing virtual account |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates | Get all of the Direct Debit Instructions associated with the virtual account |
| POST /v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates | Request creation of a Direct Debit Instruction |
| DELETE /v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId} | Request cancellation for a Direct Debit Instruction for virtual account |
| PATCH /v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId} | Request amendments to Direct Debit Instruction for virtual account |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}/Collections | Get a collection of transactions for account Direct Debit Instructions |
| POST /v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}/Returns | Request rejection for the supplied Instruction identifier |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/Unpaid | Get a list of all unpaid transactions belonging to a virtual account |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions | Get a summary of all of the transactions from the specified virtual account |
| GET /v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/{transactionId} | Get the details of a specific transaction from the specified virtual account |
| POST /v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/Returns | Create a return of one or more Direct Debit or Direct Credit transactions for the virtual account |
| GET /v1/Accounts/Virtual | Get a list of all the virtual accounts belonging to an institution |
| PUT /v1/Cop/opt/accounts/{accountId} | Update an account to either opt out or opt back into our Confirmation of Payee (CoP) service |
| PUT /v1/Cop/opt/accounts/{accountId}/virtual/{virtualAccountId} | Update a virtual account to either opt out or opt back into our Confirmation of Payee (CoP) service |
| POST /v1/customers/retail | Create a new retail customer |
| PATCH /v1/customers/retail/{customerId} | Update the details of an existing retail customer |
| PUT /v1/customers/retail/{customerId}/currentaddress | Update the address of an existing retail customer |
| POST /fx/v1/ExecuteQuote | Execute a FX trade using the rate received in a quote (must be executed within the held rate period of 45 seconds) |
| POST /fx/v1/order | Create a Foreign Exchange (FX) trade with the buy or sell amount specified |
| POST /fx/v1/quote | Request a quote up-front for a FX trade |
| POST /inbound-payment-simulation/chaps/v1/customer-payments | Simulate an inbound CHAPS payment for testing in the sim environment |
| POST /inbound-payment-simulation/chaps/v1/institution-payments | Simulate an inbound CHAPS bank-to-bank payment for testing in the sim environment |
| POST /inbound-payment-simulation/chaps/v1/return-payments | Simulate a returned CHAPS payment for testing in the sim environment |
| GET /interest/v1/accounts/{accountId}/configurations | Get past, current, and future interest configuration IDs for an interest-bearing account |
| POST /interest/v1/accounts/{accountId}/configurations | Update the interest configuration ID of an interest-bearing account |
| POST /v1/isas | Create a cash ISA |
| GET /v1/isas/{accountId} | Get cash ISA details |
| POST /v1/isas/{accountId}/cancellation | Cancel a cash ISA |
| POST /v1/isas/{accountId}/declaration | Declare a customer's eligibility for a cash ISA |
| PATCH /v1/isas/{accountId}/discontinue | Inform ClearBank that the cash ISA account holder has deceased |
| POST /v1/isas/{accountId}/transfer-in | Transfer in a Cash ISA |
| POST /v1/isas/{accountId}/transfer-in/{transferInId}/rejection | Reject an existing cash ISA transfer in request |
| GET /v1/isas/{accountId}/transfer-in/{transferInId} | Get information on a cash ISA transfer in |
| PUT /v1/isas/{accountId}/transfer-in/{transferInId}/transfer-history-form | Submit a cash ISA transfer history form |
| POST /v1/isas/{accountId}/transfer-outs | Transfer out a cash ISA |
| POST /v1/isas/{accountId}/transfer-outs/rejection | Inform ClearBank that cash ISA transfer out has been rejected |
| GET /mccy/v1/Accounts | Get a list of all the real multi-currency accounts associated with your institution, excluding virtual accounts |
| POST /mccy/v2/Accounts | Create a real multi-currency account |
| DELETE /mccy/v1/Accounts/{accountId} | Close an existing real multi-currency account |
| GET /mccy/v1/Accounts/{accountId} | Get details related to a real multi-currency account |
| PATCH /mccy/v1/Accounts/{accountId} | Amend the properties of an existing real multi-currency account |
| GET /mccy/v1/Accounts/{accountId}/balances | Get the balance of a real multi-currency account |
| POST /mccy/v1/Accounts/{accountId}/currencies | Enable an existing real multi-currency account to support a new currency |
| PATCH /mccy/v1/Accounts/{accountId}/status | Update the status of an existing real multi-currency account |
| GET /mccy/v1/Accounts/{accountId}/transactions | Get a list of transactions for a real multi-currency account and any virtual accounts associated with that real account |
| POST /v1/mccy/inboundpayment/{accountUniqueId} | Make an inbound payment to a multi-currency account in the simulation environment |
| POST /v1/mccy/internaltransfers | Initiate an internal transfer request |
| POST /v1/mccy/payments | Initiate a multi-currency payment |
| DELETE /v1/mccy/payments/{batchId} | Cancel a batch of multi-currency payments with a matching batch ID |
| DELETE /v1/mccy/payments/{batchId}/{endToEndId} | Cancel a single multi-currency payment within a batch, with a matching batch ID and end-to-end ID |
| POST /mccy/v1/StatementRequests | Request a statement for all multi-currency accounts associated with your institution (as per the specified currency) |
| POST /mccy/v1/StatementRequests/account/{iban} | Request a statement for a specific multi-currency account associated with your institution (as per the specified currency), excluding virtual accounts |
| GET /mccy/v1/Transactions/{transactionId} | Get the details of a multi-currency transaction |
| POST /mccy/v1/VirtualAccounts | Create a new multi-currency virtual account |
| DELETE /mccy/v1/VirtualAccounts/{virtualAccountId} | Close an existing multi-currency virtual account |
| GET /mccy/v1/VirtualAccounts/{virtualAccountId} | Get details related to a multi-currency virtual account |
| PATCH /mccy/v1/VirtualAccounts/{virtualAccountId} | Amend the properties of an existing multi-currency virtual account |
| PATCH /mccy/v1/VirtualAccounts/{virtualAccountId}/status | Update the status of an existing virtual account |
| GET /mccy/v1/VirtualAccounts/{virtualAccountId}/transactions | Get a list of transactions for a multi-currency virtual account |
| POST /open-banking/outbound/v1/name-verification | Confirm the exact name registered with the payee's account |
| POST /open-banking/outbound/v1/srd/validate | Confirm whether a given sort code/account number combination requires Secondary Reference Data (SRD) with Confirmation of Payee (CoP) requests |
| POST /payments/chaps/v5/customer-payments | Initiate an outbound CHAPS payment (pacs.008) |
| POST /payments/chaps/v5/institution-payments | Initiate an outbound CHAPS bank-to-bank payment |
| POST /payments/chaps/v5/return-payments | Initiate the return of a CHAPS payment |
| POST /payments/cheques/v1/submit-deposit | Initiate a cheque deposit |
| POST /payments/cross-border-sterling/v3/payments | Initiate a cross border GBP payment |
| POST /v3/payments/fps | Initiate an FTR compliant payment using the Faster Payments scheme |
| POST /v3/payments/fps/return | Return a single inbound Faster Payment |
| POST /v2/payments/fps/singlepayment | Initiate an outbound payment originated overseas |
| POST /v1/savings | Create a savings account |
| POST /v1/statementrequests | Request the generation of a camt.053 statement |
| GET /v1/statements/{messageId} | Retrieve a specific page of a camt.053 statement |
| GET /v2/Transactions | Get a summary of all of the transactions from the institution |
| GET /v1/Transactions/{sortCode}/DirectCredit/Unapplied | Return a list of all unapplied Direct Credit transactions for a given sort code |
| GET /v1/Transactions/{sortCode}/DirectDebit/Unpaid | Return a list of all unpaid Direct Debit Transactions for a given sort code |
Related links
You can find a list of webhooks here: