Gets details of the Standard Settlement Instructions (SSIs) that can be used to settle and collect funds in each available currency.

Returns a JSON structure with details of the sender of funds.

Triggers a production-like flow for processing funds, topping up CM balance or rejecting the transaction without topping up CM balance. This resource is only available in the Currencycloud Demo environment; it is not implemented in the Production environment.

BETA

Please be aware that this is a beta version of the endpoint and it is subject to change during this period. We will provide at least 10 days' notice before implementing any breaking changes, which will be highlighted in this box. If you are interested in using this endpoint before it is out of beta, please contact your Account Manager.

Creates a new conversion. Returns the details of the created conversion on success.

Gets a conversion record for the provided unique ID.

Finds conversions based on search parameters. If no search parameters are provided, all conversions under the house account are returned.

Gets a quote of the projected cost to cancel a conversion identified by a provided unique ID {id}.

Cancels the conversion identified by the provided unique ID {id}.

Gets a quote of the projected cost to change the date of a conversion identified by a provided unique ID {id}.

Changes the date of the conversion identified by the provided unique ID {id}.

Returns the information of any actions related to a conversion that have generated profit or loss, including the profit or loss amount.

Gets a preview of the details of each part of a split conversion specified by the provided unique conversion ID {id}.

Splits the conversion specified by the unique ID {id}. Upon success, it returns the details of the parent and new child conversions.

Returns the history of executed conversion splits, specified by a unique conversion ID {id}.

Gets indicative foreign exchange rate information for one or more currency pairs in a single request.

This endpoint is intended to provide an indication of the rate available in the market and can support requests for multiple currency pairs, so is good for polling requirements such as live FX ticker widgets. This endpoint should be used where speed, availability and the ability to request multiple currency pairs is important.

Gets a detailed, tradeable rate quote to convert money from one currency to another. The quotation provided will be based on the spread table of the authenticated user. There is also the option to provide a specific date for the conversion to occur.

This endpoint provides a current tradeable rate for a single currency pair. It should be used as the start of the flow before a conversion is booked. This endpoint should be used where accuracy is the most important aspect, such as when a trade is about to be booked.

Authenticates and authorizes a user to the Currencycloud API.

Submit a login ID and API key for a Currencycloud account, you can register for and API key here. A temporary authentication token is returned following a succesful login.

The authentication token is required to make requests to all other endpoints in the Currencycloud API. Tokens expire after 30 minutes of inactivity.

Token requests are limited to 60 calls per minute.

For security, Currencycloud accounts are disabled when four unsuccessful login attempts are made within a short period. In these circumstances, account holders must contact support to reactivate their account.

Authentication tokens expire automatically after 30 minutes of inactivity. If a session is no longer required, it is good security practice to retire its authentication token early rather than leave it to time out.

Creates a new sub-account. Returns the new account entity on success.

Gets an account or sub-account owned by the authenticated user.

Updates a sub-account owned by the authenticated user. The updated account entity is returned on success.

Gets the authenticated user's main account.

Returns account and any sub-accounts owned by the authenticated user. Optionally filter by account status and other criteria.

Retrieves the Payment Charges Settings for the given account.

Manage a given account's Payment Charge Settings (enable, disable, set as default).

Endpoint for accounts using our Outsourced KYC model to accept Terms of Use.

Gets the balance for a currency from the account of the authenticated user.

Searches for currency balances in the main account or a sub-account owned by the authenticated user.

Tops up the margin balance.

Gets the contact record for the authenticated user.

Returns contacts that match the parameters.

Gets the contact for the given ID.

Updates an existing contact. Returns the updated contact entity on success.

Creates a new contact and attaches it to a sub-account. Returns the new contact entity on success.

Generates a new account HMAC key for the current contact.

Returns the related bank details for the given account reference.

Returns the information that is required to make payments to beneficiaries in specified currencies and countries.

Provides a list of upcoming non-trading dates, such as weekends or public holidays, for a specified currency pair. Common use cases include situations where this information needs to be provided, or for planning upcoming conversion bookings.

Many currencies are triangulated; this means that holidays affecting the intermediary currency, as well as the sale and purchase currencies, will impact transactions. Find out more at our support article.

Gets a list of all currencies that can be traded on the Currencycloud platform.

Returns the payer information you need to provide to create a payment. Requirements vary depending on the location of the payer, the type of payment to be made (priority or regular), and other factors.

Gets a list of invalid payment dates for a given currency covering a two months period from the start_date specified. A payment date is when a payment will be executed by Currencycloud. Payments cannot be made on some days, for example when banks are closed.

Gets the payment fee information set up for the account / payment type provided.

Gets a list of payment purpose codes for a given currency and entity type. When initiating cross-border payments, the central bank of the country may require a purpose to be included with your transaction in order for your payment to be accepted and processed. If a payment purpose code is required but not provided, your payment may be delayed or rejected by the beneficiary bank.

Gets settlement account information - a list of accounts that require funding in order to allow for outstanding transactions to be processed.

Returns a JSON structure with details of the conversion report requested.

Returns a JSON structure with details of the payments report requested.

Searches for report requests made. Returns a JSON structure with details of matching report requests.

Searches for a report by ID. Returns a JSON structure with details of the specified report request.

Search for transactions.

Gets a transaction record.

Lists all withdrawal accounts assigned to an account.

Submits an ACH pull request from a specific withdrawal account. The funds will be pulled into the account the specified withdrawal account is related to.

Returns beneficiaries attached to the account or any sub-account owned by the authenticated user.

Gets a beneficiary with the given ID.

Updates an existing beneficiary. Returns the updated beneficiary entity on success.
Please note that it's not possible to change a beneficiary's entity type (company or individual) by an update. To achieve this, you should create a new beneficiary.

Creates a new beneficiary. Returns the new beneficiary entity on success.

Delete a beneficiary associated with a sub-account. If the deletion is successful, the beneficiary's final state is returned.

Validates a new beneficiary's bank details, without actually creating a record of the beneficiary. On success, returns an object that represents the entity that would be created if the beneficiary was saved.

This service is currently only available to in-scope clients who must provide Confirmation of Payee services to their end-users making local GBP payments in the UK.

In the UK, Confirmation of Payee is a peer-to-peer name-checking service designed to help reduce misdirected payments and provide greater assurance that payments are being sent, and collected from, the intended account holder for UK domestic payments.

Currently, access is restricted to UK institutions and in-scope clients.

We plan to add more market coverage to this API in the future, thereby extending access to additional clients.

If you're interested in learning more or have received notification that you're in-scope, please contact your Customer Success Manager.

Submits a payment. On success, returns the new payment record. Use the Get Payer Requirements endpoint to find out what payer information needs to be provided.

Sponsored model clients who are implementing Strong Customer Authentication (SCA) for payments should refer to our integration guide.

Searches for payment records.

Gets a payment record.

Updates a payment. On success, returns the updated payment entity.

Gets confirmation for a given payment.

DEPRECATED

This endpoint is deprecated and will be removed on 1 October 2025. Please use the Get Payment Submission Information endpoint below instead.

Gets the pacs.008 or MT103 information for a Swift payment.

Authorises a payment pending authorisation.

Delete a payment. On success, returns the final payment record state.

Gets the tracking information for a payment.

Assigns a payment fee table to a specific sub-account.

Gets payment delivery date.

Gets the payment fee tables for the current authenticated account.

Gets the calculated quote for the fee that will be applied against a payment.

Unassigns the payment fee tables for a specific sub-account.

Validates the details of a new payment without creating a record of the payment. On success, returns an object containing a string validation_result with value "success".

Sponsored model clients who are implementing Strong Customer Authentication (SCA) for payments should refer to our integration guide.

Get a payer record.

Transfers funds from one account to another. No currency conversion is performed, so the sending and receiving accounts must hold money in the same currency.

Returns the money transfer record with the given ID.

Searches for transfer records that meet the given criteria.

Requests that a transfer be cancelled.