List payment methods

Methods API v2
GEThttps://api.mollie.com/v2/methods

Retrieve all available 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

sequenceType

string
optional

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

locale

string
optional

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 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

amount

amount object
optional

An object containing value and currency. 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

resource

string
optional

Use the resource parameter to indicate if you will use the result with the Create Order or Create Payment API.

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. Default behaviour is returning all available payment methods for payments.

Possible values: orders payments.

billingCountry

string
optional

The billing country of your customer 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

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the following query string parameters are also available. With the profileId parameter, you must specify which profile you want to look at when listing payment methods. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileId

string
required
The website profile’s unique identifier, for example pfl_3RkSN1zuPE. This field is mandatory.

testmode

boolean
optional
Set this to true to list all payment methods available in testmode.

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

count

integer
The number of payment methods found in _embedded.

_embedded

object

The object containing the queried data.

methods

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

_links

object

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

self

object
The URL to the current set of methods.

documentation

object
The URL to the List payment methods endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/methods \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
1
2
3
4
5
6
7
8
9
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

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

// Methods for the Orders API
$methods = $mollie->methods->all(['resource' => 'orders']);
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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')
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

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
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 13,
    "_embedded": {
        "methods": [
            {
                 "resource": "method",
                 "id": "ideal",
                 "description": "iDEAL",
                 "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"
                 },
                 "_links": {
                     "self": {
                         "href": "https://api.mollie.com/v2/methods/ideal",
                         "type": "application/hal+json"
                     },
                     "documentation": {
                         "href": "https://mollie.com/en/docs/reference/methods/get",
                         "type": "text/html"
                     }
                 }
            },
            { },
            { }
        ]
    },
    "_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"
        }
    }
}