List methods
Methods API

GET
https://api.mollie.nl/v1/methods?locale=nl_NL
Authentication: API keys OAuth access tokens

Retrieve all payment methods activated on the payment profile.

Parameters

include
string

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

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

Possible values: 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 de_AT de_CH de_DE es_ES fr_BE fr_FR nl_BE nl_NL

offset
integer

Optional – The number of objects to skip.

count
integer

Optional – The number of objects to return (with a maximum of 250).

Mollie Connect/OAuth parameters

If you're creating an app with Mollie Connect/OAuth, the only mandatory extra 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.

profileId
string

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

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

  • issuers Include issuer details such as which iDeal issuers are available.

Response

200
application/json; charset=utf-8
totalCount
integer

The total number of objects available.

offset
integer

The number of skipped objects as requested.

count
integer

The number of objects found in data, which is either the requested number (with a maximum of 250) or the default number.

data
array

A list of payment method objects as described in Get method.

links
object

Optional – Links to help navigate through the lists of objects, based on the given offset.

previous
string | null

Optional – The previous set of objects, if available.

next
string | null

Optional – The next set of objects, if available.

first
string | null

Optional – The first set of objects, if available.

last
string | null

Optional – The last set of objects, if available.

Example

Request code

require_once 'Mollie/API/Autoloader.php';

$mollie = new Mollie_API_Client;
$mollie->setApiKey('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM');

$methods = $mollie->methods->all();

foreach ($methods as $method)
{
    echo '<div style="line-height:40px; vertical-align:top">';
    echo '<img src="' . htmlspecialchars($method->image->normal) . '"> ';
    echo htmlspecialchars($method->description);
    echo ' (' .  htmlspecialchars($method->id). ')';
    echo '</div>';
}

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "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"
            }
        },
        { ... },
        { ... }
    ]
}