Get payment method

Methods API v2
GEThttps://api.mollie.com/v2/methods/*id*
Authentication:API keysOrganization access tokensApp access tokens

Retrieve a single method by its ID. Note that if a method is not available on the website profile a status 404 Not found is returned. When the method is not enabled, a status 403 Forbidden is returned. You can enable payments methods via the Enable payment method endpoint in the Profiles API, or via your Mollie Dashboard.

If you do not know the method’s ID, you can use the methods list endpoint to retrieve all payment methods that are available.

Additionally, it is possible to check if Wallets such as Apple Pay are enabled by passing the wallet ID (applepay) as the method ID.

Parameters

Replace id in the endpoint URL by the methods’s ID. For example: https://api.mollie.com/v2/methods/ideal.

localestringoptional

Passing a locale will translate the payment method name in the corresponding language.

Possible values: en_US en_GB 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

currencystringoptional
The currency to receiving the minimumAmount and maximumAmount in. We will return an error when the currency is not supported by the payment method.

Access token parameters

If you are using organization access tokens or are creating an OAuth app, you have to specify which profile you are retrieving the payment method details for using the profileId parameter. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

For these authentication methods the optional testmode parameter is available as well to enable test mode.

profileIdstringrequired for access tokens
testmodebooleanoptional

Includes

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

  • issuers Include issuers available for the payment method (for iDEAL, KBC/CBC payment button, gift cards, or meal vouchers).
  • pricing Include pricing for each payment method.

Response

200 application/hal+json

resourcestring
Indicates the response contains a method object. Will always contain method for this endpoint.
idstring
The unique identifier of the payment method. When used during payment creation, the payment method selection screen will be skipped.
descriptionstring
The full name of the payment method, translated in the optional locale passed.
minimumAmountamount object

The minimum payment amount required to use this payment method.

Show child parameters

currencystring
An ISO 4217 currency code.
valuestring
A string containing the exact amount in the given currency.
maximumAmountamount object

The maximum payment amount allowed when using this payment method.

Note

When there is no maximum amount for the payment method, this parameter will return null.

Show child parameters

currencystring
An ISO 4217 currency code.
valuestring
A string containing the exact amount in the given currency.
imageimage object

The URLs of images representing the payment method.

Show child parameters

size1xstring
The URL for a payment method icon of 32x24 pixels.
size2xstring
The URL for a payment method icon of 64x48 pixels.
svgstring
The URL for a payment method icon in vector format. Usage of this format is preferred since it can scale to any desired size.
statusstring

The status that the method is in.

Possible values:

  • activated: The payment method is activated and ready for use.
  • pending-boarding: Mollie is waiting for you to finish onboarding in the Merchant Dashboard before the payment method can be activated.
  • pending-review: Mollie needs to review your request for this payment method before it can be activated.
  • pending-external: Activation of this payment method relies on you taking action with an external party, for example signing up with PayPal or a giftcard issuer.
  • rejected: Your request for this payment method was rejected. Whenever Mollie rejects such a request, you will always be informed via email.
  • null: This payment method was not requested.
pricingarray

Pricing set of the payment method what will be include if you add the parameter.

Show child parameters

descriptionstring
The area or product-type where the pricing is applied for, translated in the optional locale passed.
fixedamount object

The fixed price per transaction.

Show child parameters

currencystring
The ISO 4217 currency code.
valuestring
A string containing the exact amount in the given currency.
variablestring
A string containing the percentage what will be charged over the payment amount besides the fixed price.
feeRegionstringoptional
This value is only available for credit card rates. It will correspond with the regions as documented in the Payments API.
_linksobject

An object with several URL objects relevant to the payment method. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the payment method itself.
documentationURL object
The URL to the payment method retrieval endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/methods/ideal?include=issuers \
   -H "Authorization: Bearer live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");
$mollie->methods->get("ideal", ["include" => "issuers,pricing"]);

1
2
3
4
5
6
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_api_key("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")

method = mollie_client.methods.get("ideal", include="issuers,pricing")

1
2
3
4
5
6
7
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

Mollie::Method.get('ideal', include: 'issuers,pricing')

1
2
3
4
const { createMollieClient } = require('@mollie/api-client');
const mollieClient = createMollieClient({ apiKey: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' });

const method = await mollieClient.methods.get('ideal', { include: ['issuers', 'pricing'] });

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
     "resource": "method",
     "id": "ideal",
     "description": "iDEAL",
     "minimumAmount": {
         "value": "0.01",
         "currency": "EUR"
     },
     "maximumAmount": {
         "value": "50000.00",
         "currency": "EUR"
     },
     "image": {
         "size1x": "https://www.mollie.com/external/icons/payment-methods/ideal.png",
         "size2x": "https://www.mollie.com/external/icons/payment-methods/ideal%402x.png",
         "svg": "https://www.mollie.com/external/icons/payment-methods/ideal.svg"
     },
     "issuers": [
         {
             "resource": "issuer",
             "id": "ideal_ABNANL2A",
             "name": "ABN AMRO",
             "image": {
                 "size1x": "https://www.mollie.com/external/icons/ideal-issuers/ABNANL2A.png",
                 "size2x": "https://www.mollie.com/external/icons/ideal-issuers/ABNANL2A%402x.png",
                 "svg": "https://www.mollie.com/external/icons/ideal-issuers/ABNANL2A.svg"
             }
         },
         {
             "resource": "issuer",
             "id": "ideal_ASNBNL21",
             "name": "ASN Bank",
             "image": {
                 "size1x": "https://www.mollie.com/external/icons/ideal-issuers/ASNBNL21.png",
                 "size2x": "https://www.mollie.com/external/icons/ideal-issuers/ASNBNL21%402x.png",
                 "svg": "https://www.mollie.com/external/icons/ideal-issuers/ASNBNL21.svg"
             }
         },
         { },
         { }
     ],
     "status": "activated",
     "pricing": [
         {
             "description": "The Netherlands",
             "fixed": {
                 "value": "0.29",
                 "currency": "EUR"
             },
             "variable": "0"
         }
     ],
     "_links": {
         "self": {
             "href": "https://api.mollie.com/v2/methods/ideal",
             "type": "application/hal+json"
         },
         "documentation": {
             "href": "https://docs.mollie.com/reference/v2/methods-api/get-method",
             "type": "text/html"
         }
     }
 }