PaymentMethod is a JSON Structure definition published by Adyen, describing 37 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-payment-method-structure.json",
"description": "PaymentMethod schema from Adyen API",
"type": "object",
"properties": {
"afterpayTouch": {
"description": "Afterpay Touch details.",
"$ref": "#/components/schemas/AfterpayTouchInfo"
},
"allowed": {
"description": "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.",
"type": "boolean"
},
"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"
},
"enabled": {
"description": "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type": "boolean"
},
"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"
},
"id": {
"description": "The identifier of the resource.",
"type": "string"
},
"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.",
"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).",
"type": "string"
},
"verificationStatus": {
"description": "Payment method status. Possible values:\n* **valid**\n* **pending**\n* **invalid**\n* **rejected**",
"enum": [
"valid",
"pending",
"invalid",
"rejected"
],
"type": "string"
},
"vipps": {
"description": "Vipps details.",
"$ref": "#/components/schemas/VippsInfo"
},
"visa": {
"description": "Visa details.",
"$ref": "#/components/schemas/GenericPmWithTdiInfo"
}
},
"required": [
"id"
],
"name": "PaymentMethod"
}