Jump to Content

Guides Recipes API Reference Changelog Discussions

Client Portal API Status Website

API Reference

Client Portal API Status Website

Guides Recipes API Reference Changelog Discussions

All

Pages

Start typing to search…

Authorization

Authorizations
- Get tokenget

Accounts and Balances

Account
Account Holder Verification
- Create AccountHolderVerification requestpost
- Get details of an AccountHolderVerification requestget

FX

Foreign Exchange
Multicurrency Payments
- Get a rate for multicurrency paymentsget

Payment

Single payments
Bulk payments
Agency and Correspondent Banking payments
- Make an agency or correspondent banking paymentpost
ISO20022
- Payment initiation using pain001 formatpost
- Payment instruction using pacs008 formatpost
Recalls
Traces
Returns
- Initiate the return of a paymentpost
Actions
- Invoke a specified action for a given payment or direct debitpost

Virtual Banking

Ordering
Virtual Accounts

REPORTING AND RECONCILIATION

Report
Reports on request v2

FEES

Fee details
- Get details of a specific feeget
- Get details of all feesget
Fee details
Fee details v2
Interest details

Webhooks

Add events
- Add an event to a subscriptionpost
- Delete an eventdel
Set up subscriptions

Simulator (Sandbox only)

Simulate payments (sandbox only)
- Simulate debit (sandbox only)post
- Simulate credit (sandbox only)post
Simulate notifications
- Trigger eventspost

Request To Pay

Request to pay

Direct Debit

BankAccounts
BankAccountBlockRules
Connectors
- Returns a specific connectorget
- Returns a cursor paged list of connectorsget
Customers
HostedPages
LocalizationTexts
- Returns a specific localizationTextget
Mandates
Merchants
- Returns a specific merchantget
- Returns a cursor paged list of merchantsget
Payments

Get details of a specific interest by Id

get https://www.bankingcircleconnect.com/api/v1/interests/{id}

Language

Credentials

Bearer