Get payment method

Methods API v2
GEThttps://api.mollie.com/v2/methods/*id*

Retrieve a single method by its ID. Note that if a method is not available on the payment profile a status 404 Not found is returned. When the method is not enabled, a status 403 Forbidden is returned.

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

Parameters

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

locale

string
optional

Passing a locale will translate the payment method name 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

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

Response

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

resource

string
Indicates the response contains a method object. Will always contain method for this endpoint.

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, translated in the optional locale passed.

image

image object

The URLs of images representing the payment method.

size1x

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

size2x

string
The URL for a payment method icon of 110x74 pixels. Use this for high resolution screens.

_links

object

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

self

URL object
The API resource URL of the payment method itself.

documentation

URL object
The URL to the payment method retrieval endpoint documentation.

Example

Request

1
2
curl -X GET https://api.mollie.com/v2/methods/ideal?include=issuers \
    -H "Authorization: Bearer live_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
42
43
44
HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=utf-8

{
     "resource": "method",
     "id": "ideal",
     "description": "iDEAL",
     "image": {
         "size1x": "https://www.mollie.com/images/payscreen/methods/ideal.png",
         "size2x": "https://www.mollie.com/images/payscreen/methods/ideal%402x.png"
     },
     "issuers": [
         {
             "resource": "issuer",
             "id": "ideal_ABNANL2A",
             "name": "ABN AMRO",
             "image": {
                 "size1x": "https://www.mollie.com/images/checkout/v2/ideal-issuer-icons/ABNANL2A.png",
                 "size2x": "https://www.mollie.com/images/checkout/v2/ideal-issuer-icons/ABNANL2A.png"
             }
         },
         {
             "resource": "issuer",
             "id": "ideal_ASNBNL21",
             "name": "ASN Bank",
             "image": {
                 "size1x": "https://www.mollie.com/images/checkout/v2/ideal-issuer-icons/ASNBNL21.png",
                 "size2x": "https://www.mollie.com/images/checkout/v2/ideal-issuer-icons/ASNBNL21.png"
             }
         },
         { },
         { }
     ],
     "_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"
         }
     }
 }