MOmollie
Methods API

Enable payment method

Changed on

Enable a payment method on a specific profile.

When using a profile-specific API credential, the alias me can be used instead of the profile ID to refer to the current profile.

Some payment methods require extra steps in order to be activated. In cases where a step at the payment method provider needs to be completed first, the status will be set to pending-external and the response will contain a link to complete the activation at the provider.

To enable voucher or gift card issuers, refer to the Enable payment method issuer endpoint.

post/v2/profiles/{profileId}/methods/{methodId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/profiles/{profileId}/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: profiles.write

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

  • 7eb5bf6b29ddRevision changes
    • warning

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

  • 489fede6d3d0Revision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status