Sign in

v1

latestOpenAPI 3.0.02026-08-0631139237.5 KB
Payment Methods

Get Client Payment Methods

Retrieve available payment methods from the client side. No authentication required.

You must provide either an accountId or a paymentId as a query parameter.

When providing a paymentId, the response includes payment-specific information such as amount and currency.

If countryCode is not provided, it is automatically detected from the client's IP address to filter payment methods by geographic availability.

You can also filter by amount or currency.

get/client-payment-methods

Query parameters

accountIdstring

The ID of the account to get payment methods for. Either accountId or paymentId must be provided.

paymentIdstring

The ID of the payment to get payment methods for. Either accountId or paymentId must be provided.

amountinteger

Amount in the smallest currency unit (e.g. cents). Used to filter payment methods by amount limits.

currencystring

Three-letter ISO 4217 currency code, in uppercase. Used to filter payment methods by currency support.

countryCodestring

Two-letter ISO 3166-1 alpha-2 country code. Used to filter payment methods by country availability. If not provided, the country is automatically detected from the client's IP address.

Response

Available payment methods

livemodeboolean required

Has the value true if the resource exists in live mode or the value false if the resource exists in test mode.

paymentMethodsstring[] required

An array of available payment methods for the account or payment. Possible values include:

  • alipay - Alipay
  • applePay - Apple Pay
  • bancontact - Bancontact
  • bizum - Bizum
  • blik - BLIK
  • card - Credit or debit card
  • cardPresent - Card present (physical POS)
  • clickToPay - Click to Pay
  • eps - EPS
  • giropay - Giropay
  • googlePay - Google Pay
  • iDeal - iDEAL
  • klarna - Klarna
  • mbway - MB WAY
  • multibanco - Multibanco
  • paypal - PayPal
  • sepa - SEPA Direct Debit
  • sofort - Sofort
  • trustly - Trustly
merchantNamestring required

The name of the merchant

merchantUrlstring required

The URL of the merchant's website

countryCodestring required

Two-letter country code (ISO 3166-1 alpha-2).

accountIdstring

MONEI Account identifier.

amountinteger

The amount of the payment in the smallest currency unit. For example, 10 EUR = 1000 cents. Only present when querying by paymentId.

currencystring

Three-letter ISO currency code, in uppercase. Only present when querying by paymentId.

Example response

{
  "paymentMethods": [
    "bizum",
    "applePay",
    "googlePay",
    "alipay",
    "bancontact",
    "blik",
    "eps",
    "iDeal",
    "mbway",
    "multibanco",
    "sofort",
    "trustly",
    "sepa",
    "klarna",
    "giropay",
    "card"
  ],
  "metadata": {
    "alipay": {
      "countries": [
        "CN"
      ]
    },
    "bancontact": {
      "countries": [
        "BE"
      ]
    },
    "bizum": {
      "countries": [
        "ES"
      ]
    },
    "blik": {
      "countries": [
        "PL"
      ]
    },
    "card": {
      "brands": [
        "visa",
        "mastercard"
      ]
    },
    "eps": {
      "countries": [
        "AT"
      ]
    },
    "iDeal": {
      "countries": [
        "NL"
      ]
    },
    "mbway": {
      "countries": [
        "PT"
      ]
    },
    "multibanco": {
      "countries": [
        "PT"
      ]
    },
    "sofort": {
      "countries": [
        "AT",
        "BE",
        "DE",
        "ES",
        "IT",
        "NL",
        "CH",
        "PL"
      ]
    },
    "trustly": {
      "countries": [
        "DE",
        "DK",
        "EE",
        "ES",
        "FI",
        "GB",
        "LT",
        "LV",
        "NL",
        "NO",
        "PL",
        "SE",
        "SK"
      ]
    },
    "sepa": {
      "countries": [
        "AT",
        "BE",
        "BG",
        "HR",
        "CY",
        "CZ",
        "DK",
        "EE",
        "FI",
        "FR",
        "DE",
        "GR",
        "HU",
        "IE",
        "IT",
        "LV",
        "LT",
        "LU",
        "MT",
        "NL",
        "PL",
        "PT",
        "RO",
        "SK",
        "SI",
        "ES",
        "SE",
        "IS",
        "LI",
        "NO",
        "AD",
        "SM",
        "MC",
        "VA",
        "PF",
        "TF",
        "GI",
        "GG",
        "IM",
        "JE",
        "BL",
        "PM",
        "CH",
        "GB",
        "WF"
      ]
    },
    "klarna": {
      "countries": [
        "AT",
        "BE",
        "CH",
        "DE",
        "DK",
        "ES",
        "FI",
        "FR",
        "GB",
        "IT",
        "NL",
        "NO",
        "SE"
      ]
    },
    "giropay": {
      "countries": [
        "DE"
      ]
    },
    "googlePay": {
      "merchantId": "12345678901234567890"
    },
    "applePay": {
      "merchantId": "merchant.com.monei"
    },
    "clickToPay": {
      "tokenSupport": true,
      "visa": {
        "srciDpaId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "srcInitiatorId": "550e8400-e29b-41d4-a716-446655440000"
      },
      "mastercard": {
        "srciDpaId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "srcInitiatorId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
      },
      "discover": {
        "srciDpaId": "71f0c4d5-9947-4d1c-9cb3-d6a3f7c4e701",
        "srcInitiatorId": "c2d06c25-9ddb-4a5e-9d5a-3ff1c8d98467"
      }
    }
  },
  "merchantName": "MONEI",
  "merchantUrl": "https://monei.com/",
  "countryCode": "ES",
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "amount": 10,
  "currency": "EUR"
}