Jump to Content
Guides
API Reference
Changelog
v1.0
v2
Client Portal
API Status
Website
API Reference
Client Portal
API Status
Website
v2
Guides
API Reference
Changelog
Agency Banking Accounts
All
Pages
Start typing to search…
JUMP TO
Authorization
Authorizations
Get token
get
Accounts and Balances
Account
Get all accounts
get
Get details of an account
get
Get balances of an account
get
Get bookings of an account
get
ACCOUNTHOLDERVERIFICATION
Account Holder Verification
Create AccountHolderVerification request
post
Get details of an AccountHolderVerification request
get
Account Holder Verification V2
Create AccountHolderVerification request
post
Get details of an AccountHolderVerification request
get
FX
Foreign Exchange
Get an FX quote
get
Get an FX quote for a currency pair
get
Request FX quotes in bulk
post
Execute a BCFX order
post
Get FX transactions
get
Post FX transactions
post
Get a specific FX transaction
get
Get FX exposure for given client with trading line and/or collateral account
get
Get a held rate
get
Get list of active held rates
get
Get FX settlement dates
get
Get available accounts for FX trading
get
Get FX transactions
get
Post FX transactions
post
Multicurrency Payments
Get a rate for multicurrency payments
get
Payment
Single payments
Make a payment
post
Get payments
get
Get status of a payment
get
Get details of a payment by payment id
get
Initiate the cancellation of an active payment
put
Initiate the rejection of an active payment process for a direct debit
put
Get a MT103 payment confirmation
get
Get details of a payment by transaction reference number
get
Bulk payments
Make bulk payments
post
Get bulk files
get
Get single bulk file
get
Get status of single bulk payment
get
Initiate the cancellation of active payment processes, belonging to the same bulk. If successful, payments eligible for cancellation will be cancelled and have a final state with status = Cancelled.
put
Agency and Correspondent Banking payments
Make an agency or correspondent banking payment
post
ISO20022
Payment initiation using pain001 format
post
Payment instruction using pacs008 format
post
Recalls
Initiate recall for a payment
post
Get a collection of recalls
get
Get a specific recall by id
get
Get status of a recall
get
Traces
Initiate trace for a payment
post
Get a collection of traces
get
Cancel a trace
put
Get a specific trace by id
get
Get status of a trace
get
Returns
Initiate the return of a payment
post
Actions
Invoke a specified action for a given payment or direct debit
post
Virtual Banking
Ordering
Order Virtual Accounts
post
List of Virtual Account orders
get
Details of a Virtual Account order
get
Virtual Accounts
List of Virtual Accounts
get
Status of virtual account closure
get
Close Virtual Accounts
post
Close Virtual Accounts by file
post
Add currency by file
post
Add currency
post
Customer Details
Add customer details
post
Add customer details by file
post
Modify customer details
patch
Modify customer details by file
patch
Status of customer details update
get
Modification status
get
REPORTING AND RECONCILIATION
Report
Get bank to customer account report
get
Get account activity report
get
Get paged account activity report
get
Get account balance report
get
Get reconciliation report
get
Get paged reconciliation report
get
Get intraday paged reconciliation report
get
Get rejection report
get
Get bank to customer statement v1
get
Get bank to customer statement
get
Reports on request
Account activity report
post
Account balance report
post
Bank statement report
post
Bank to customer report
post
Company account balance report
post
Reconciliation report
post
Rejection report
post
Sanctions Screening report
post
Get status of requested report
get
Get list of requested reports
get
Download generated report
get
(Available soon) Bank to customer account report
post
(Available soon) Bank to customer statement
post
FEES
Fee details
Get details of a specific fee
get
Get details of all fees
get
Get details of a specific fee By Id
get
Interest details
Get details of a specific interest
get
Get details of all interests
get
Get details of a specific interest by Id
get
Webhooks
Add events
Add an event to a subscription
post
Delete an event
del
Set up subscriptions
Get all subscriptions
get
Setup a subscription
post
Get details of a subscription
get
Update a subscription
put
Delete a subscription
del
Activate a subscription
put
Deactivate a subscription
put
Simulator (Sandbox only)
Simulate payments (sandbox only)
Simulate debit (sandbox only)
post
Simulate credit (sandbox only)
post
Simulate notifications
Trigger events
post
Request To Pay
Request to pay
Create a new request to pay
post
Get a cursor paged list of requests to pay
get
Get a specific request to pay
get
Direct Debit
BankAccounts
Creates a new bank account
post
Returns a cursor paged list of bank accounts
get
Returns a specific bank account
get
BankAccountBlockRules
Creates new bank account block rules
put
Returns a cursor paged list of bank account block rules
get
Creates a new bank account country block rule
put
Returns a cursor paged list of bank account country block rules
get
Deletes entities of bank account block rules
post
Deletes a bank account country block rule
post
Connectors
Returns a specific connector
get
Returns a cursor paged list of connectors
get
Customers
Creates a new customer
post
Returns a cursor paged list of customers
get
Returns a specific customer
get
HostedPages
Returns a cursor paged list of hosted pages
get
Returns a specific hosted page
get
View the hosted page
get
LocalizationTexts
Returns a specific localizationText
get
Mandates
Creates a new mandate
post
Returns a cursor paged list of mandates
get
Returns a specific mandate
get
Approves a mandate
post
Creates a new approval TAN and re-sends it via email or sms to the customer
post
Manually accept or reject this mandate
post
Discards a mandate
post
Reinstates a discarded or expired mandate
post
Merchants
Returns a specific merchant
get
Returns a cursor paged list of merchants
get
Payments
Creates a new payment
post
Returns a cursor paged list of payments
get
Returns a specific payment
get
Manually accept or reject this payment
post
Cases Api
Cases
Get Case by id
get
Get Cases
get
Upload and attach a file to a Case
post
Download attachment
get
Rfi
Get RFI Case by id
get
Submit answers to an RFI Case.
post
Get RFI question types
get
Agency Banking Accounts
Ask AI
