Get a list of available payment methods

POST/paymentMethods

Use it in a workflow

Add a step and choose the Adyen connector.
Pick the Get a list of available payment methods action (under Payments).
Fill in the fields below, then reference the result from later steps as {{getAListOfAvailablePaymentMethods.response.data}}.

Request

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

Enter the body as JSON in the step's Body field.

additionalDataobject

This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.

allowedPaymentMethodsarray<string>

List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPaymentMethods":["ideal","applepay"]`

amountobject

currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

blockedPaymentMethodsarray<string>

List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaymentMethods":["ideal","applepay"]`

browserInfoobject

acceptHeaderstringrequired

The accept header value of the shopper's browser.

colorDepthinteger (int32)required

The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.

javaEnabledbooleanrequired

Boolean value indicating if the shopper's browser is able to execute Java.

javaScriptEnabledboolean

Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.

Default true

languagestringrequired

The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).

screenHeightinteger (int32)required

The total height of the shopper's device screen in pixels.

screenWidthinteger (int32)required

The total width of the shopper's device screen in pixels.

timeZoneOffsetinteger (int32)required

Time difference between UTC time and the shopper's browser local time, in minutes.

userAgentstringrequired

The user agent value of the shopper's browser.

channelstring

The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web

One ofiOSAndroidWeb

countryCodestring

The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE

merchantAccountstringrequired

The merchant account identifier, with which you want to process the transaction.

orderobject

orderDatastringrequired

The encrypted order data.

pspReferencestringrequired

The `pspReference` that belongs to the order.

shopperConversionIdstring

A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.

shopperEmailstring

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.

shopperIPstring

The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).

shopperLocalestring

The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.

shopperReferencestring

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.

splitCardFundingSourcesboolean

Boolean value indicating whether the card payment method should be split into separate debit and credit options.

Default false

storestring

Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.

storeFiltrationModestring

Specifies how payment methods should be filtered based on the `store` parameter: - **exclusive**: Only payment methods belonging to the specified `store` are returned. - **inclusive**: Payment methods from the `store` and those not associated with any other store are returned.

One ofexclusiveinclusiveskipFilter

telephoneNumberstring

The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.

json

{
  "merchantAccount": "string",
  "additionalData": {},
  "allowedPaymentMethods": [
    "string"
  ],
  "amount": {
    "currency": "string",
    "value": 0
  },
  "blockedPaymentMethods": [
    "string"
  ],
  "browserInfo": {
    "acceptHeader": "string",
    "colorDepth": 0,
    "javaEnabled": false,
    "language": "string",
    "screenHeight": 0,
    "screenWidth": 0,
    "timeZoneOffset": 0,
    "userAgent": "string",
    "javaScriptEnabled": true
  },
  "channel": "iOS",
  "countryCode": "string",
  "order": {
    "orderData": "string",
    "pspReference": "string"
  },
  "shopperConversionId": "string",
  "shopperEmail": "string",
  "shopperIP": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{getAListOfAvailablePaymentMethods.response.data.<field>}}.

paymentMethodsarray<object>

Detailed list of payment methods required to generate payment forms.

appsarray<object>3 fields

A list of apps for this payment method.

brandstring

Brand for the selected gift card. For example: plastix, hmclub.

brandsarray<string>

List of possible brands. For example: visa, mc.

configurationobject

The configuration of the payment method.

fundingSourcestring

The funding source of the payment method.

One ofcreditdebitprepaid

groupobject3 fields

inputDetailsarray<object>9 fields

All input details to be provided to complete the payment with this payment method.

issuersarray<object>3 fields

A list of issuers for this payment method.

namestring

The displayable name of this payment method.

promotedboolean

Indicates whether this payment method should be promoted or not.

typestring

The unique payment method code.

storedPaymentMethodsarray<object>

List of all stored payment methods.

bankAccountNumberstring

The bank account number (without separators).

bankLocationIdstring

The location id of the bank. The field value is `nil` in most cases.

brandstring

The brand of the card.

cashtagstring

The shopper’s Cash App Pay Cashtag.

expiryMonthstring

The two-digit month when the card expires

expiryYearstring

The last two digits of the year the card expires. For example, **22** for the year 2022.

externalTokenstring

The token issued by an external tokenization service representing the shopper's payment method

holderNamestring

The name of the payment method holder.

ibanstring

The IBAN of the bank account.

idstring

A unique identifier of this stored payment method.

labelstring

The shopper’s issuer account label

lastFourstring

The last four digits of the PAN.

namestring

The display name of the stored payment method.

networkTxReferencestring

Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.

ownerNamestring

The name of the bank account holder.

shopperEmailstring

The shopper’s email address.

supportedRecurringProcessingModelsarray<string>

The supported recurring processing models for this stored payment method.

supportedShopperInteractionsarray<string>

The supported shopper interactions for this stored payment method.

typestring

The type of payment method.

json

{
  "paymentMethods": [
    {
      "apps": [
        {
          "id": "string",
          "name": "string",
          "appIdentifierInfo": {
            "androidPackageId": "string",
            "iosScheme": "string"
          }
        }
      ],
      "brand": "string",
      "brands": [
        "string"
      ],
      "configuration": {},
      "fundingSource": "credit",
      "group": {
        "name": "string",
        "paymentMethodData": "string",
        "type": "string"
      },
      "inputDetails": [
        {
          "configuration": {},
          "details": [
            {
              "configuration": null,
              "items": null,
              "key": null,
              "optional": null,
              "type": null,
              "value": null
            }
          ],
          "inputDetails": [
            {
              "configuration": null,
              "items": null,
              "key": null,
              "optional": null,
              "type": null,
              "value": null
            }
          ],
          "itemSearchUrl": "string",
          "items": [
            {
              "id": null,
              "name": null
            }
          ],
          "key": "string",
          "optional": false,
          "type": "string",
          "value": "string"
        }
      ],
      "issuers": [
        {
          "id": "string",
          "name": "string",
          "disabled": false
        }
      ],
      "name": "string",
      "promoted": false,
      "type": "string"
    }
  ],
  "storedPaymentMethods": [
    {
      "bankAccountNumber": "string",
      "bankLocationId": "string",
      "brand": "string",
      "cashtag": "string",
      "expiryMonth": "string",
      "expiryYear": "string",
      "externalToken": "string",
      "holderName": "string",
      "iban": "string",
      "id": "string",
      "label": "string",
      "lastFour": "string"
    }
  ]
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Was this page helpful?