Limited availability
Currency conversion in currently in pilot phase. Some of the processes and documentation may change as the feature evolves. If you are interested in piloting currency conversion or have any feedback, reach out to your Adyen contact.
When you fix the cost of the goods in the settlement currency, your user always receives the same, fixed amount in their currency of choice (the settlement currency). The amount the customer pays in the processing currency is not fixed and depends on the prevailing exchange rate and Adyen's conversion markup.
How it works
If the cost of the goods in the settlement currency (the currency your user receives) is fixed:
- You calculate the amount the customer must pay in the processing currency, using either the Foreign Exchange API or the Exchange Rate Report.
- You make a POST
/payments
request, specifying the cost of the goods in both currencies. - When Adyen receives the request, we debit the customer and credit your user in their respective currencies.
Requirements
Requirement | Description |
---|---|
Integration type | You must have an Adyen online payments integration and a checkout UI. |
API credentials | You must have credentials for the following APIs:
|
API credential roles | To use the Foreign Exchange API, make sure you have the following role:
|
Customer Area roles | To use the Exchange Rate Report, make sure that you have at least one of the following roles
|
Webhooks | Ensure that your server can receive and accept standard webhooks. Subscribe to any of the following webhooks: |
Capabilities | Make sure that your account holders have the following capabilities:
|
Setup steps | Before you begin:
|
Calculate the amount in the processing currency
To calculate the exact amount the customer must pay in their currency of choice (the processing currency), you have two options:
- Make a POST
/rates/calculate
request using the Foreign Exchange API to get the exact payment amount in the processing currency. - Use our Exchange Rate Report to manually calculate the exact payment amount in the processing currency.
Send a payment request with the calculated amount
-
Make sure that you have the API key for the Checkout API. Your credential has the format ws@Company.[YourCompanyAccount].
-
Send a POST /payments, /sessions, or /payments/{paymentPspReference}/captures request, specifying the following fields for the currency conversion:
Parameter Description Example amount.value
The cost of the goods in the processing currency, calculated in step 1. amount.value: 20174 amount.currency
The currency in which the customer pays. amount.currency: "PLN" splits.amount.value
The cost of the goods in the settlement currency. In case of multiple splits, the sum of the split amounts in the splits array must equal the cost of the goods in the settlement currency. Any mismatch is booked to the balance account you specify in the split item with type Remainder. splits.amount.value: 100000 splits.amount.currency
The settlement currency.
This is the currency in which your user receives the funds.splits.amount.currency: "CZK" splits.type
The type of the split item. We recommend to always add a split item for the Remainder and the transaction fees. split.type: BalanceAccount
split.type: PaymentFee
split.type: Remainder -
You receive the following response:
The splits are guaranteed, and the payment is booked according to the data you provide in the splits array. Any mismatch or miscalculation is booked to the balance account you specify in the split item with type Remainder. You can reconcile these mismatches per transaction using the Balance Platform Accounting Report.