Get method
Methods API

GET
https://api.mollie.nl/v1/methods/id
Authentication: API keys OAuth access tokens

Retrieve a payment method object by specifying a payment method identifier.

Parameters

Replace id in the endpoint URL by the payment method's ID, for example creditcard.

include
string

Optional – Include additional data. Must be a comma separated list of one or more includes.

locale
string

Optional – Passing a locale will translate the payment method names and order the payment methods to suit the locale.

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

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 get a payment method in test mode.

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 issuers available for the payment method (e.g. for iDEAL, KBC/CBC payment button or gift cards).

Response

200
application/json; charset=utf-8
resource
string

Indicates the response contains a payment method object.

Possible values: method

id
string

The unique identifier of the payment method. When used during payment creation, the payment method selection screen will be skipped.

description
string

The full name of the payment method.

amount
object

The minimum and maximum allowed payment amount will differ between payment methods.

minimum
decimal

The minimum payment amount in EUROs required to use this payment method.

maximum
decimal

The maximum payment amount in EUROs allowed when using this payment method. For gift cards, you can ignore the maximum amount.

image
object

URLs of images representing the payment method.

normal
string

The URL for a payment method icon of 55x37 pixels.

bigger
string

The URL for a payment method icon of 110x74 pixels.

Example

Request code

require_once 'Mollie/API/Autoloader.php';

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

$method = $mollie->methods->get("creditcard");

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

{
    "resource": "method",
    "id": "creditcard",
    "description": "Credit card",
    "amount": {
        "minimum": "0.31",
        "maximum": "10000.00"
    },
    "image": {
        "normal": "https://www.mollie.com/images/payscreen/methods/creditcard.png",
        "bigger": "https://www.mollie.com/images/payscreen/methods/creditcard%402x.png"
    }
}