Adyen · Schema

PaymentMethodSetupInfo

PaymentsFinancial ServicesFintech

Properties

Name Type Description
afterpayTouch object Afterpay Touch details.
applePay object Apple Pay details.
bcmc object Bancontact details.
businessLineId string The unique identifier of the business line. Required if you have a [platform setup](https://docs.adyen.com/marketplaces-and-platforms/platform-structure-resources/platform-setup/).
cartesBancaires object Cartes Bancaires details.
clearpay object Clearpay details.
countries array The list of countries where a payment method is available. By default, all countries supported by the payment method.
cup object China Union Pay details.
currencies array The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
customRoutingFlags array The list of custom routing flags to route payment to the intended acquirer.
diners object Diners details.
discover object Discover details.
eftpos_australia object Eftpos Australia details.
giroPay object giropay details.
girocard object Girocard details.
googlePay object Google Pay details.
ideal object iDeal details.
interac_card object Interac Card details.
jcb object JCB details.
klarna object Klarna details.
maestro object Maestro details.
mc object MasterCard details.
mealVoucher_FR object Meal Voucher FR details.
paypal object PayPal details.
reference string Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
shopperInteraction string The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account. Possible values: **e
sofort object Sofort details.
storeIds array The unique identifier of the store for which to configure the payment method, if any.
swish object Swish details.
twint object Twint details.
type string Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
vipps object Vipps details.
visa object Visa details.
View JSON Schema on GitHub

JSON Schema

adyen-paymentmethodsetupinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentMethodSetupInfo",
  "title": "PaymentMethodSetupInfo",
  "properties": {
    "afterpayTouch": {
      "description": "Afterpay Touch details.",
      "$ref": "#/components/schemas/AfterpayTouchInfo"
    },
    "applePay": {
      "description": "Apple Pay details.",
      "$ref": "#/components/schemas/ApplePayInfo"
    },
    "bcmc": {
      "description": "Bancontact details.",
      "$ref": "#/components/schemas/BcmcInfo"
    },
    "businessLineId": {
      "description": "The unique identifier of the business line. Required if you have a [platform setup](https://docs.adyen.com/marketplaces-and-platforms/platform-structure-resources/platform-setup/).",
      "type": "string"
    },
    "cartesBancaires": {
      "description": "Cartes Bancaires details.",
      "$ref": "#/components/schemas/CartesBancairesInfo"
    },
    "clearpay": {
      "description": "Clearpay details.",
      "$ref": "#/components/schemas/ClearpayInfo"
    },
    "countries": {
      "description": "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "cup": {
      "description": "China Union Pay details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "currencies": {
      "description": "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customRoutingFlags": {
      "description": "The list of custom routing flags to route payment to the intended acquirer.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "diners": {
      "description": "Diners details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "discover": {
      "description": "Discover details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "eftpos_australia": {
      "description": "Eftpos Australia details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "giroPay": {
      "description": "giropay details.",
      "$ref": "#/components/schemas/GiroPayInfo"
    },
    "girocard": {
      "description": "Girocard details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "googlePay": {
      "description": "Google Pay details.",
      "$ref": "#/components/schemas/GooglePayInfo"
    },
    "ideal": {
      "description": "iDeal details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "interac_card": {
      "description": "Interac Card details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "jcb": {
      "description": "JCB details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "klarna": {
      "description": "Klarna details.",
      "$ref": "#/components/schemas/KlarnaInfo"
    },
    "maestro": {
      "description": "Maestro details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "mc": {
      "description": "MasterCard details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    },
    "mealVoucher_FR": {
      "description": "Meal Voucher FR details.",
      "$ref": "#/components/schemas/MealVoucherFRInfo"
    },
    "paypal": {
      "description": "PayPal details.",
      "$ref": "#/components/schemas/PayPalInfo"
    },
    "reference": {
      "description": "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
      "maxLength": 150,
      "type": "string"
    },
    "shopperInteraction": {
      "description": "The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.\n\nPossible values: **eCommerce**, **pos**, **contAuth**, and **moto**. ",
      "enum": [
        "eCommerce",
        "pos",
        "moto",
        "contAuth"
      ],
      "type": "string"
    },
    "sofort": {
      "description": "Sofort details.",
      "$ref": "#/components/schemas/SofortInfo"
    },
    "storeIds": {
      "x-addedInVersion": "3",
      "description": "The unique identifier of the store for which to configure the payment method, if any.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "swish": {
      "description": "Swish details.",
      "$ref": "#/components/schemas/SwishInfo"
    },
    "twint": {
      "description": "Twint details.",
      "$ref": "#/components/schemas/TwintInfo"
    },
    "type": {
      "description": "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
      "enum": [
        "afterpaytouch",
        "alipay",
        "alipay_hk",
        "amex",
        "applepay",
        "bcmc",
        "blik",
        "cartebancaire",
        "clearpay",
        "cup",
        "diners",
        "directdebit_GB",
        "discover",
        "ebanking_FI",
        "eftpos_australia",
        "elo",
        "elocredit",
        "elodebit",
        "girocard",
        "googlepay",
        "hiper",
        "hipercard",
        "ideal",
        "interac_card",
        "jcb",
        "klarna",
        "klarna_account",
        "klarna_paynow",
        "maestro",
        "mbway",
        "mc",
        "mcdebit",
        "mealVoucher_FR",
        "mobilepay",
        "multibanco",
        "onlineBanking_PL",
        "paybybank",
        "paypal",
        "payshop",
        "swish",
        "trustly",
        "twint",
        "twint_pos",
        "vipps",
        "visa",
        "visadebit",
        "vpay",
        "wechatpay",
        "wechatpay_pos"
      ],
      "type": "string"
    },
    "vipps": {
      "description": "Vipps details.",
      "$ref": "#/components/schemas/VippsInfo"
    },
    "visa": {
      "description": "Visa details.",
      "$ref": "#/components/schemas/GenericPmWithTdiInfo"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}