MOmollie
Methods API

Get payment method

Changed on

Retrieve a single payment method by its ID.

If a method is not available on this profile, a 404 Not Found response is returned. If the method is available but not enabled yet, a status 403 Forbidden is returned. You can enable payments methods via the Enable payment method endpoint of the Profiles API, or via the 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 wallet methods such as Apple Pay are enabled by passing the wallet ID (applepay) as the method ID.

get/v2/methods/{methodId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/methods/{methodId}
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: payments.read

Query parameters

locale'ca_ES' | 'cs_CZ' | 'da_DK' | 'de_AT' | 'de_CH' | 'de_DE' | 'de_LU' | 'el_GR' | 'en_BE' | 'en_GB' | 'en_NL' | 'en_US' | 'es_ES' | 'fi_FI' | 'fr_BE' | 'fr_FR' | 'fr_LU' | 'hu_HU' | 'is_IS' | 'it_IT' | 'lt_LT' | 'lv_LV' | 'nb_NO' | 'nl_BE' | 'nl_NL' | 'pl_PL' | 'pt_PT' | 'sk_SK' | 'sl_SI' | 'sv_SE' | 'tr_TR' | 'null' nullable

Sets the language for customer-facing content and communications.

Example:en_US

Response language

currencystring
Example:EUR

If provided, the minimumAmount and maximumAmount will be converted to the given currency. An error is returned if the currency is not supported by the payment method.

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

The identifier referring to the profile you wish to retrieve the resources for.

Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

includestring nullable

This endpoint allows you to include additional information via the include query string parameter.

sequenceType'oneoff' | 'first' | 'recurring'
Example:oneoff

Set this parameter to first to only return the methods that can be used for the first payment of a recurring sequence.

Set it to recurring to only return methods that can be used for recurring payments or subscriptions.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The payment method object.

resourcestring required

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

id'alma' | 'applepay' | 'bacs' | 'bancomatpay' | 'bancontact' | 'banktransfer' | 'belfius' | 'billie' | 'billink' | 'bizum' | 'blik' | 'creditcard' | 'directdebit' | 'eps' | 'giftcard' | 'ideal' | 'in3' | 'kbc' | 'klarna' | 'mbway' | 'mobilepay' | 'multibanco' | 'mybank' | 'paybybank' | 'paypal' | 'paysafecard' | 'przelewy24' | 'riverty' | 'satispay' | 'swish' | 'trustly' | 'twint' | 'vipps' | 'voucher' | 'wero' nullable required

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

descriptionstring required

The full name of the payment method.

If a locale parameter is provided, the name is translated to the given locale if possible.

status'activated' | 'pending-boarding' | 'pending-review' | 'pending-external' | 'rejected' | 'null' nullable required

The payment method's activation status for this profile.

Example response

{
  "resource": "method",
  "id": "ideal",
  "description": "iDeal",
  "minimumAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "maximumAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "image": {
    "size1x": "https://...",
    "size2x": "https://...",
    "svg": "https://..."
  },
  "status": "activated",
  "issuers": [
    {
      "resource": "issuer",
      "id": "ideal_ABNANL2A",
      "name": "ING Bank",
      "image": {
        "size1x": "https://...",
        "size2x": "https://...",
        "svg": "https://..."
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 9c1c6717ac7dRevision changes
    • info

      added the new enum value el_GR to the query request parameter locale

    • info

      added the new enum value sl_SI to the query request parameter locale

    • info

      added the new enum value tr_TR to the query request parameter locale

  • 7eb5bf6b29ddRevision changes
    • warning

      added the new undefined enum value to the ///// response property for the response status