Payments

List payment methods

List the payment methods activated for a site.

get/payment-methods

Query parameters

amountinteger
Example:1000

Filter payment methods by availability for a given order amount in eurocents.

countrystring
Example:NL

Filter payment methods by availability in a given country.

Format: ISO 3166-1 alpha-2 code.

currencystring
Example:EUR

Filter payment methods by availability for a given currency.

Format: ISO-4217 currency code.

localestring
Example:nl_NL

Display information about a payment method for a given locale, if possible.

group_cards0 | 1

Group credit and debit cards together in the response.

  • 0: Don't group cards in the results.
  • 1: Group cards in the results.
include_coupons0 | 1

Whether to include gift cards in the results.

  • 0: Don't include gift cards in the results.
  • 1: Include gift cards in the results.

Response

Request successful

successSuccess — unresolved $ref
dataData[] — unresolved $ref

The relevant activated payment methods.

Changes