Adyen

Foreign Exchange API

The Foreign Exchange API allows you to manage and convert the currencies that are enabled for your integration. Authentication We recommend that you use an…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Foreign Exchange API allows you to manage and convert the currencies that are enabled for your integration.

Authentication

We recommend that you use an API key to connect to the Foreign Exchange API. You can generate an API key in your Customer Area. If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.

Credential format

  • For the rates/calculate endpoint: Generate an API key for the credential with the format ws@BalancePlatform.[YourBalancePlatform].

Header format

To connect to the Foreign Exchange API, add an X-API-Key header with the API key as the value, for example:

curl
-H 'Content-Type: application/json' \
-H 'X-API-Key: ADYEN_API_KEY' \
...

Versioning

The Foreign Exchange API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://balanceplatform-api-test.adyen.com/fx/v1/rates/calculate

Going live

When going live, generate an API key in your live Customer Area. If you have an Adyen Issuing integration, generate an API key in your live Balance Platform Customer Area. You can then use the API key to send requests to https://balanceplatform-api-test.adyen.com/fx/v1.

Endpoints 1

Rates

  • POSTCalculate amount in a different currency/rates/calculateReturns the calculated amounts and rates required to convert the currency of a transaction.

API details

Base URL
https://balanceplatform-api-test.adyen.com/fx/api/v1
https://balanceplatform-api-live.adyen.com/fx/api/v1
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
1 operation on 1 pathPOST 1
Main resources
Rates 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1

How to test the Foreign Exchange API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Foreign Exchange API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Calculate amount in a different currency” (POST /rates/calculate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Foreign Exchange API?

The Foreign Exchange API allows you to manage and convert the currencies that are enabled for your integration. Authentication We recommend that you use an… It is listed under Payments and has 1 endpoint.

Who publishes the Foreign Exchange API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Foreign Exchange API?

Its description lists 2 base URLs: https://balanceplatform-api-test.adyen.com/fx/api/v1, https://balanceplatform-api-live.adyen.com/fx/api/v1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Foreign Exchange API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Foreign Exchange API have?

1 operation on 1 path (1 POST). The largest groups are Rates.

Is forking the Foreign Exchange API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.