Calculate amount in a different currency

post/rates/calculate

API Version

Returns the calculated amounts and rates required to convert the currency of a transaction.

Endpoint destination URL

Request Parameters

Required

Optional

An array of objects, where each object defines a currency and value for which you want to perform an exchange calculation.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
Successful operation
exchangeCalculationsarray[object]
An array of objects, where each object returns a currency and value for which you performed an exchange calculation. You can use the calculated amounts in your payment requests.
appliedExchangeRatenumber
The exchange rate to convert the source currency to the target currency. This includes Adyen's markup.
exchangeSidestring
The operation performed on the source amount. Possible values:

buy

sell

sourceAmountobject
The currency of the amount you converted (the source amount).
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
targetAmountobject
An object specifying the currency and value to which you want to convert the source amount (the target amount).
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
typestring
The type of transaction. Possible values:

splitPayment: for payments

splitRefund: for refunds
401
Unauthorized
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403
Forbidden
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Calculate amount in a different currency

HTTP Responses

200

401

403

422 - Unprocessable Entity