Filter payment methods

If you’re using v33 or above of the API, you can choose which payment methods are available to shoppers via your payments form.
There are two ways you can do this:
  • Only allowing specific payment methods to appear.
  • Blocking specific payment methods from appearing.

This is done when you create the payment session. Here we explain how.

Allow specific payment methods

If you only want specific payment methods to appear in your payments form, specify them when you make a /paymentSession call. You'll need to additionally pass allowPaymentMethods, specifying the payment methods that are allowed to appear with the paymentMethod.type. You can find the paymentMethod.type for each payment method on our Payment methods overview.

In the following example iDEAL and SEPA Direct Debit will be the only payment methods that can appear in the payment form.

curl -H "Content-Type: application/json" -H "X-API-Key: Checkout_API_key" -X POST -d '{ 
       "amount": { 
          "currency": "EUR", 
          "value": "17408"
       }, 
       "reference": "Your order number",
       "merchantAccount": "YOUR_MERCHANT_ACCOUNT_NAME",
       "shopperReference": "yourShopperId_IOfW3k9G2PvXFu2j",
       "channel": "Android",
       "token": "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
       "sessionValidity": "2017-04-06T13:09:13Z",
       "returnUrl": "app://", 
       "countryCode": "NL",
       "shopperLocale": "nl_NL",
       "allowedPaymentMethods":[
          "ideal",
          "sepadirectdebit"
       ]
    }' https://checkout-test.adyen.com/v40/paymentSession
The payment methods available to a shopper also depend on their countryCode and shopperLocale, currency, and the payment methods that have been configured for your account.
For example, iDEAL will only appear on your payment form if this is available to your shopper.

Block specific payment methods

If you want to block specific payment methods from appearing in your payment form, specify them when you make a /paymentSession call. You'll need to additionally pass blockPaymentMethods, specifying the payment methods that are blocked with the paymentMethod.type. You can find the paymentMethod.type for each payment method on our Payment methods overview.

In the following example, the Bancontact card (bcmc) and app (bcmc_mobile) payment methods will be blocked from appearing on the payment form.

curl -H "Content-Type: application/json" -H "X-API-Key: Checkout_API_key" -X POST -d '{ 
       "amount": { 
          "currency": "EUR", 
          "value": "17408"
       }, 
       "reference": "Your order number",
       "merchantAccount": "YOUR_MERCHANT_ACCOUNT_NAME",
       "shopperReference": "yourShopperId_IOfW3k9G2PvXFu2j",
       "channel": "Android",
       "token": "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
       "sessionValidity": "2017-04-06T13:09:13Z",
       "returnUrl": "app://", 
       "countryCode": "NL",
       "shopperLocale": "nl_NL",       
       "blockedPaymentMethods":[
          "bcmc",
          "bcmc_mobile"
       ]
    }' https://checkout-test.adyen.com/v40/paymentSession