List payment methods

Methods API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for listing payment methods in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/methods
Authentication:API keysApp access tokens

Retrieve all payment methods activated on the payment profile.

The results are paginated. See pagination for more information.

Parameters

includestringrequired
Include additional data. Must be a comma-separated list of one or more includes. See Get method for available includes.
recurringTypestringoptional

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.

Possible values: first recurring

localestringoptional

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

Possible values: en_US de_AT de_CH de_DE es_ES fr_BE fr_FR nl_BE nl_NL

offsetintegeroptional
The number of payment methods to skip.
countintegeroptional
The number of payment methods to return (with a maximum of 250).

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the only mandatory extra query string parameter is the profileId parameter. With it, you can specify which profile you want to list the methods of. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileIdstringrequired
testmodebooleanoptional

Includes

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

  • issuers Include issuer details if available, for instance for the iDEAL or gift card payment methods.

Response

200 application/json

totalCountinteger
The total number of payment methods available.
offsetinteger
The number of skipped payment methods as requested.
countinteger
The number of payment methods found in data, which is either the requested number (with a maximum of 250) or the default number.
dataarray
An array of payment method objects as described in Get payment method.
linksobject

Links to help navigate through the lists of payment methods, based on the given offset.

Show child parameters

previousstring
The previous set of payment methods, if available.
nextstring
The next set of payment methods, if available.
firststring
The first set of payment methods, if available.
laststring
The last set of payment methods, if available.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/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
HTTP/1.1 200 OK
Content-Type: application/json

{
    "totalCount": 2,
    "offset": 0,
    "count": 2,
    "data": [
        {
            "resource": "method",
            "id": "ideal",
            "description": "iDEAL",
            "amount": {
                "minimum": "0.53",
                "maximum": "50000.00"
            },
            "image": {
                "normal": "https://www.mollie.com/images/payscreen/methods/ideal.png",
                "bigger": "https://www.mollie.com/images/payscreen/methods/ideal%402x.png"
            }
        },
        {
            "resource": "method",
            "id": "paypal",
            "description": "PayPal",
            "amount": {
                "minimum": "0.13",
                "maximum": "8000.00"
            },
            "image": {
                "normal": "https://www.mollie.com/images/payscreen/methods/paypal.png",
                "bigger": "https://www.mollie.com/images/payscreen/methods/paypal%402x.png"
            }
        },
        { },
        { }
    ]
}