Jump to Content

Guides API Reference Changelog

Client Portal API Status Website

API Reference

Client Portal API Status Website

Guides API Reference Changelog

Authorization

Authorizations
- Get tokenget

Accounts and Balances

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

Payment

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

FX

Foreign Exchange
Multicurrency Payments
- Get a rate for multicurrency paymentsget

Virtual Banking

Ordering
Virtual Accounts

REPORTING AND RECONCILIATION

Report
Reports on request

FEES and Interest

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

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 status of a recall

get https://www.bankingcircleconnect.com/api/v1/recalls/{recall-id}/status

Language

Credentials

Bearer