List payment methods

Methods API v2
GEThttps://api.mollie.com/v2/methods
Authentication:API keysOrganization access tokensApp access tokens

Retrieve all enabled payment methods. The results are not paginated.

  • For test mode, payment methods are returned that are enabled in the Dashboard (or the activation is pending).
  • For live mode, payment methods are returned that have been activated on your account and have been enabled in the Dashboard.

New payment methods can be activated via the Enable payment method endpoint in the Profiles API.

When using the first sequence type, methods will be returned if they can be used as a first payment in a recurring sequence and if they are enabled in the Dashboard.

When using the recurring sequence type, payment methods that can be used for recurring payments or subscriptions will be returned. Enabling / disabling methods in the dashboard does not affect how they can be used for recurring payments.

Parameters

sequenceTypestringoptional

Passing first will only show payment methods eligible for making a first payment. Passing recurring shows payment methods which can be used to automatically charge your customer’s account when authorization has been given.

Set to oneoff by default, which indicates the payment method is available for a regular non-recurring payment.

Possible values: oneoff first recurring

localestringoptional

Passing a locale will sort the payment methods in the preferred order for the country, and translate the payment method names in the corresponding language.

Possible values: en_US en_GB nl_NL nl_BE fr_FR fr_BE de_DE de_AT de_CH es_ES ca_ES pt_PT it_IT nb_NO sv_SE fi_FI da_DK is_IS hu_HU pl_PL lv_LV lt_LT

amountamount objectoptional

If supplied, only payment methods that support the amount and currency are returned.

Example: https://api.mollie.com/v2/methods?amount[value]=100.00&amount[currency]=USD

Show child parameters

currencystring
An ISO 4217 currency code.
valuestring
A string containing the exact amount in the given currency.
resourcestringoptional

Use the resource parameter to indicate if you will use the result with the Create order or Create payment endpoints.

For example: when passing orders the result will include payment methods that can only be used in conjunction with orders, such as Klarna Pay later and meal vouchers. Default behaviour is returning all available payment methods for payments.

Possible values: orders payments

billingCountrystringoptional

The country taken from your customer’s billing address in ISO 3166-1 alpha-2 format. This parameter can be used to check whether your customer is eligible for certain payment methods, for example Klarna Slice it.

Example: https://api.mollie.com/v2/methods?resource=orders&billingCountry=DE

includeWalletsstringoptional

A comma-separated list of the wallets you support in your checkout. Wallets often require wallet specific code to check if they are available on the shoppers device, hence the need to indicate your support.

Example: https://api.mollie.com/v2/methods?includeWallets=applepay

Possible values: applepay

orderLineCategoriesstringoptional

A comma-separated list of the order line categories you support in your checkout. The available categories can be found on the Create order endpoint.

Example: https://api.mollie.com/v2/methods?resource=orders&orderLineCategories=eco,meal

Access token parameters

If you are using organization access tokens or are creating an OAuth app, you have to specify which profile you are retrieving payment method details for using the profileId parameter. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

For these authentication methods the optional testmode parameter is available as well to enable test mode.

profileIdstringrequired for access tokens
testmodebooleanoptional

Includes

This endpoint allows you to include additional information by appending the following values via the include querystring parameter.

  • issuers Include issuer details such as which iDEAL or gift card issuers are available.
  • pricing Include pricing for each payment method.

Response

200 application/hal+json

countinteger
The number of payment methods found in _embedded.
_embeddedobject

The object containing the queried data.

Hide child parameters

methodsarray
An array of methods objects as described in Get method.
_linksobject

Links related to the lists of payment methods. Every URL object will contain an href and a type field.

Show child parameters

selfobject
The URL to the current set of methods.
documentationobject
The URL to the List payment methods endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/methods?include=pricing \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

// Methods for the Payments API
$methods = $mollie->methods->allActive();

// Methods for the Orders API
$methods = $mollie->methods->allActive(['resource' => 'orders']);

// Methods including pricing
$methods = $mollie->methods->allActive(['include' => 'pricing']);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_api_key("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")

# Methods for the Payments API
methods = mollie_client.methods.list()

# Methods for the Orders API
methods = mollie_client.methods.list(resource="orders")

# Methods including pricing
methods = mollie_client.methods.list(include="pricing")

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

# Methods for the Payments API
methods = Mollie::Method.all

# Methods for the Orders API
methods = Mollie::Method.all(resource: 'orders')

# Methods including pricing
methods = Mollie::Method.all(include: 'pricing')

1
2
3
4
5
6
7
8
const { createMollieClient } = require('@mollie/api-client');
const mollieClient = createMollieClient({ apiKey: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' });

// Methods for the Payments API.
let methods = await mollieClient.methods.list();

// Methods for the Orders API.
methods = await mollieClient.methods.list({ resource: 'orders' });

Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 13,
    "_embedded": {
        "methods": [
            {
                 "resource": "method",
                 "id": "ideal",
                 "description": "iDEAL",
                 "minimumAmount": {
                     "value": "0.01",
                     "currency": "EUR"
                 },
                 "maximumAmount": {
                     "value": "50000.00",
                     "currency": "EUR"
                 },
                 "image": {
                     "size1x": "https://mollie.com/external/icons/payment-methods/ideal.png",
                     "size2x": "https://mollie.com/external/icons/payment-methods/ideal%402x.png",
                     "svg": "https://mollie.com/external/icons/payment-methods/ideal.svg"
                 },
                 "status": "activated",
                 "pricing": [
                     {
                         "description": "Netherlands",
                         "fixed": {
                             "value": "0.29",
                             "currency": "EUR"
                         },
                         "variable": "0"
                     }
                 ],
                 "_links": {
                     "self": {
                         "href": "https://api.mollie.com/v2/methods/ideal",
                         "type": "application/hal+json"
                     }
                 }
            },
            {
                 "resource": "method",
                 "id": "creditcard",
                 "description": "Credit card",
                 "minimumAmount": {
                     "value": "0.01",
                     "currency": "EUR"
                 },
                 "maximumAmount": {
                     "value": "2000.00",
                     "currency": "EUR"
                 },
                 "image": {
                     "size1x": "https://mollie.com/external/icons/payment-methods/creditcard.png",
                     "size2x": "https://mollie.com/external/icons/payment-methods/creditcard%402x.png",
                     "svg": "https://mollie.com/external/icons/payment-methods/creditcard.svg"
                 },
                 "status": "activated",
                 "pricing": [
                     {
                         "description": "Commercial & non-European cards",
                         "fixed": {
                             "value": "0.25",
                             "currency": "EUR"
                         },
                         "variable": "2.8",
                         "feeRegion": "other"
                     },
                     {
                         "description": "European cards",
                         "fixed": {
                             "value": "0.25",
                             "currency": "EUR"
                         },
                         "variable": "1.8",
                         "feeRegion": "eu-cards"
                     },
                     {
                         "description": "American Express",
                         "fixed": {
                             "value": "0.25",
                             "currency": "EUR"
                         },
                         "variable": "2.8",
                         "feeRegion": "amex"
                     }
                 ],
                 "_links": {
                     "self": {
                         "href": "https://api.mollie.com/v2/methods/creditcard",
                         "type": "application/hal+json"
                     }
                 }
            },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/methods",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/methods-api/list-methods",
            "type": "text/html"
        }
    }
}