API Reference
Every published endpoint, grouped by resource.
Authentication 2
POST
User Login
/auth/login
POST
Refresh Token
/auth/refresh/token
FX Rate 7
GET
Retrieve A Closed Deal By Trade Reference
/fx-rate-api/deal/{tradeReference}
GET
Find A Trade By The Client Reference You Supplied
/fx-rate-api/fx/orders/reference
POST
Trade a Quote and Close The Deal
/fx-rate-api/partner/fx/trade
GET
Retrieve A Live Quote
/fx-rate-api/quote/{quoteId}
POST
Request an FX Quote
/fx-rate-api/request/quote
GET
Get Latest Rate By Currency
/fx-rate-api/traded-rates/{currencyCode}
GET
Get Latest Rates All Currencies
/fx-rate-api/traded-rates/all
Virtual Account 7
POST
Create a Virtual Account
/collection-middleware/create/virtual-account
GET
End-Of-Day Statement For A Virtual Account
/collection-middleware/statement/end-of-day
GET
Intraday Statement For A Virtual Account
/collection-middleware/statement/intraday
PATCH
Update Virtual Account
/collection-middleware/update/virtual-account/{externalReference}
GET
Retrieve Virtual Account Balance
/collection-middleware/virtual-account/{accountNumber}
GET
Get Virtual Account Balances By Merchant ID
/collection-middleware/virtual-account/merchant/{merchantId}
GET
Get Virtual Account Details
/collection-middleware/virtual-account/reference
Payout API 6
POST
Account Enquiry
/gateway/account/enquiry
POST
Initiate Payout Request
/handler/send/remittance/transaction
GET
List Financial Institutions
/remittance-middleware/list/financial/institutions
GET
End-Of-Day Statement
/remittance-middleware/statement/end-of-day
GET
Intraday Statement
/remittance-middleware/statement/intraday
GET
Transaction Status
/remittance-middleware/transaction/status/check/{transactionReference}
Collection Refunds 3
GET
Fetch A Refund By Reference
/collection-middleware/fetch/{refundReference}
GET
List Refunds By Merchant
/collection-middleware/list/refunds
POST
Refund A Collection
/collection-middleware/process/refund