Adyen · JSON Structure

Management Payment Method Setup Info Structure

PaymentMethodSetupInfo schema from Adyen API

Type: object Properties: 33 Required: 1

PaymentsFinancial ServicesFintech

PaymentMethodSetupInfo is a JSON Structure definition published by Adyen, describing 33 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

afterpayTouch applePay bcmc businessLineId cartesBancaires clearpay countries cup currencies customRoutingFlags diners discover eftpos_australia giroPay girocard googlePay ideal interac_card jcb klarna maestro mc mealVoucher_FR paypal reference shopperInteraction sofort storeIds swish twint type vipps visa

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-payment-method-setup-info-structure.json",
  "description": "PaymentMethodSetupInfo schema from Adyen API",
  "type": "object",
  "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"
  ],
  "name": "PaymentMethodSetupInfo"
}