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.

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

object
optional

An object containing value and currency. Only methods that support the amount and currency are returned.

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

Mollie Connect/OAuth parameters

If you’re creating an app with Mollie Connect/OAuth, the following parameters are also available. With the profileId parameter, you must specify which profile you want to look at when listing methods. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileId

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

testmode

boolean
optional
Set this to true to list all 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 issuers are available.

Response

200 application/hal+json; charset=utf-8

count

integer
The number of 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 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 methods list endpoint documentation.

Example

Request

1
2
curl -X GET https://api.mollie.com/v2/methods \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

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

{
    "count": 13,
    "_embedded": {
        "methods": [
            {
                 "resource": "method",
                 "id": "ideal",
                 "description": "iDEAL",
                 "image": {
                     "size1x": "https://mollie.com/images/payscreen/methods/ideal.png",
                     "size2x": "https://mollie.com/images/payscreen/methods/ideal%402x.png"
                 },
                 "_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"
        }
    }
}