theme
The Currency Cloud
FREE
By community
Updated a year ago

The Currency Cloud API Documentation

Embed the Currency Cloud API to deliver comprehensive international payment and remittance services to your clients.

Learn more about this API
Exchange Rate
POSTExchange Rate
GETExchange Rate for Currency Pair
Settlement
POSTAdd Trade to Settlement
POSTAdd a Deposit to a Settlement
POSTCreate Settlement
POSTDelete a Settlement
GETDetails of a Settlement
POSTOpen Settlement
POSTRemove a Trade from a Settlement
GETRelease Settlement
POSTSettlement Index
GETSettlement Search
GETSummary of a Settlement
Authentication
POSTAuthentication Token
POSTClose Session
Currency
GETDetails of a Trade
GETDetails of a Trade's Bank Account
GETDetails of a Trade's Settlement
POSTForeign Currency Payment
GETSearch Trades
POSTResend Trade Email
Payments
POSTAdd Payment to Trade
GETDetails of a Payment
GETPayments Index
POSTUpdate Payment
Beneficiaries
GETBeneficiaries Required Fields
GETBeneficiary Index
GETDetails of a Beneficiary
POSTNew Beneficiary
POSTUpdate Beneficiary
GETValidate Beneficiary Details
POSTExchange Rate

Returns a hash containing a full quote for the requested currency based on the spread table of the currently logged in contact.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
sideSTRING
REQUIRED1 = buy, 2 = sell
amountSTRING
REQUIREDnumber to 2dp
buy_currencySTRING
REQUIREDISO Currency Code
sell_currencySTRING
REQUIREDISO Currency Code
tokenSTRING
REQUIRED
Optional Parameters
delivery_dateSTRING
OPTIONALYYYYmmdd
Code Snippet
Install SDK
null

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication