SUsumup
Checkouts

Get available payment methods

Changed on

Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filters to check eligibility for a particular payment before presenting payment options to the payer.

get/v0.1/merchants/{merchant_code}/payment-methods

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/payment-methods
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token

Path parameters

merchant_codestring required
Example:MH4H92C7

Short unique identifier for the merchant.

Query parameters

amountnumber
Example:9.99

Payment amount in major units, for example 9.99 for EUR 9.99. When filtering by amount, also provide currency.

currencystring
Example:EUR

Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example EUR.

Response

Available payment methods

Example response

{
  "available_payment_methods": [
    {
      "id": "apple_pay"
    },
    {
      "id": "blik"
    }
  ]
}

Changes

  • cd79d83b07e0Revision changes
    • info

      the security scope payments was removed from the endpoint's security scheme oauth2

    • info

      removed the non-success response with the status

  • cdadac3315a1Revision changes
    • info

      the endpoint scheme security apiKey was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API