Developer portal

All API calls to Freemarket are authenticated using JWT authentication tokens according to the OpenID Connect standard, OAuth 2.0 Password Grant.​

Bank transfers are transactions that represent client funds entering the system. ​

Exchanges are requests to sell an amount of source currency for a target currency (Sell exchange), or to buy a specific amount in a target currency using a source currency (Buy exchange). The source currency is always the currency sold, the target currency is always the currency bought.​

Withdrawals are transactions that request the move of funds out of the system into a bank account specified as the beneficiary of the transaction.​

Internal transfers are transactions that request the move of funds to one of the beneficiary accounts within the system.​

Real time execution provides access to live rate quotes and an option to book an exchange with a fixed conversion rate (as opposed to the standard exchanges where the exact rate isn't known until the exchange is completed).​

Webhooks are notifications about significant events occurring in the system in the context of a customer account, sent as a JSON encoded payload over HTTPS to an endpoint of the customer's choosing.​

Idempotency is the notion of submitting the same request multiple times but having the same effect as if it was only executed once, returning the same response every time. This allows an API client to retry requests that fail for transient reasons, e. g. one of the Fallacies of distributed computing.​

Open API specifications including definitions​

We provide Sandbox access to potential and existing clients. If you would like access to Sandbox then please contact our Sales team.

For production access a working sandbox integration is required.