Adyen · Schema

CurrencyConversion

A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt). Information related to a currency conversion.

PaymentsFinancial ServicesFintech

Properties

Name Type Description
CustomerApprovedFlag boolean Notify if the customer has approved something. Indicates if the customer has accepted a currency conversion.
ConvertedAmount object
Rate string Rate of currency conversion.
Markup string Markup of a currency conversion amount as a percentage.
Commission number Commission for a currency conversion.
Declaration string If a declaration has to be presented to the customer.
View JSON Schema on GitHub

JSON Schema

adyen-currencyconversion-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CurrencyConversion",
  "title": "CurrencyConversion",
  "type": "object",
  "description": "A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt). Information related to a currency conversion.",
  "properties": {
    "CustomerApprovedFlag": {
      "type": "boolean",
      "default": true,
      "description": "Notify if the customer has approved something. Indicates if the customer has accepted a currency conversion."
    },
    "ConvertedAmount": {
      "$ref": "#/components/schemas/ConvertedAmount"
    },
    "Rate": {
      "type": "string",
      "description": "Rate of currency conversion."
    },
    "Markup": {
      "type": "string",
      "description": "Markup of a currency conversion amount as a percentage."
    },
    "Commission": {
      "type": "number",
      "maximum": 99999999.999999,
      "minimum": 0,
      "description": "Commission for a currency conversion."
    },
    "Declaration": {
      "type": "string",
      "pattern": "^.+$",
      "description": "If a declaration has to be presented to the customer."
    }
  },
  "required": [
    "ConvertedAmount"
  ]
}