The Currency Cloud
Embed the Currency Cloud API to deliver comprehensive international payment and remittance services to your clients.
115 subscribers
31 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
The Currency Cloud endpoints
| Method | Endpoint | Description |
|---|---|---|
| Settlement | ||
| GET |
Summary of a Settlement /{token}/settlement/{settlement_id} |
Obtain the summary of the given settlement run showing amounts, currencies, status, beneficiary details |
| POST |
Open Settlement /{token}/settlement/{settlement_id}/open |
Change status of the settlement from release to open. |
| POST |
Create Settlement /{token}/settlement/create |
Create a new settlement run with a status of 'open', ready to have trades added to it. |
| GET |
Settlement Search /{token}/settlements |
Returns an array containing the details of settlements matching the search criteria. |
| POST |
Add Trade to Settlement /{token}/settlement/{settlement_id}/add_trade |
Add a trade to the specified settlement run. |
| GET |
Details of a Settlement /{token}/settlement/{settlement_id}/details |
Obtain the full details of a settlement run showing all trade information, amounts, currencies, beneficiary details |
| POST |
Add a Deposit to a Settlement /{token}/settlement/{settlement_id}/add_deposit |
Add a transaction for a deposit to the specified settlement run. |
| GET |
Release Settlement /{token}/settlement/{settlement_id}/release |
Update the status of the specified settlement run to 'released' and notify TCC Ops to expect the arrival of the funds for this settlement run. |
| POST |
Settlement Index /{token}/settlement/{settlement_id}/trades |
Returns an array containing the trade IDs for all the trades in this settlement run. |
| POST |
Delete a Settlement /{token}/settlement/{settlement_id}/delete |
Delete the specified settlement run. Note this is only possible before the settlement run is released |
| POST |
Remove a Trade from a Settlement /{token}/settlement/{settlement_id}/remove |
Removes a trade from the specified settlement run. |
| Authentication | ||
| POST |
Authentication Token /authentication/token/new |
A token must be obtained to open the session and must be used for all further API calls. The token is obtained using the 'new token' call. |
| POST |
Close Session /{token}/close_session |
|
| Currency | ||
| POST |
Foreign Currency Payment /{token}/trade/execute |
Executes the requested trade in the market based on the spread table for the logged in Contact. If successful, returns the ID of the newly created trade. |
| GET |
Details of a Trade /{token}/trade/{trade_id} |
Returns a hash containing the full details of a particular trade. |
| GET |
Details of a Trade's Bank Account /{token}/trade/{trade_id}/deposit_account |
Returns a hash containing the bank account details of where to send any required deposit for this trade. |
| GET |
Details of a Trade's Settlement /{token}/trade/{trade_id}/settlement_account |
Returns a hash containing the bank account details for settlement of this trade. |
| GET |
Search Trades /{token}/trades |
Search for trades belonging to the account you are logged in as, use the optional parameters specified |
| POST |
Resend Trade Email /{token}/trade/{trade_id}/confirm/resend |
Request that the trade confirmation email is re-sent. |
| Payments | ||
| POST |
Add Payment to Trade /{token}/payment/add |
Add a new payment instruction for a trade or an error if you do not have permission to view that trade. |
| GET |
Details of a Payment /{token}/payment/{payment_id} |
Returns a hash containing the details of the requested payment or an error is you do not have permissions to view that payment ID |
| GET |
Payments Index /{token}/payments |
Return an array containing hashes of details of the payments matching the search criteria for the logged in contact |
| POST |
Update Payment /{token}payment/{payment_id} |
Update the details of the specified payment |
| Exchange Rate | ||
| POST |
Exchange Rate /{token}/prices/client_quote |
Returns a hash containing a full quote for the requested currency based on the spread table of the currently logged in contact. |
| GET |
Exchange Rate for Currency Pair /{token}/prices/market/{ccy_pair} |
Returns a hash containing mid-market price and the market bid/offer price data for the given currency pair. |
| Beneficiaries | ||
| GET |
Beneficiary Index /{token}/beneficiaries |
Returns hashes containing bank account details for the logged in contact. All hashes are indexed by currency. |
| POST |
New Beneficiary /{token}/beneficiary/new |
Creates a new bank account for the logged in contact. Runs against validation service. Bank account can be beneficiary, source or both beneficiary and source. |
| GET |
Validate Beneficiary Details /{token}/beneficiary/validate_details |
Validates the bank details you provide, which needs to be all the details required for the relevant country to be able to create a beneficiary and make a payment. |
| GET |
Beneficiaries Required Fields /{token}/beneficiaries/required_fields |
Returns a set of required fields which should be provided when a bank account is created. |
| POST |
Update Beneficiary /{token}/beneficiary/{beneficiary_id} |
|
| GET |
Details of a Beneficiary /{token}/beneficiary/{beneficiary_id} |
|
The Currency Cloud pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
