Get available payment methods

Get payment methods available for the given merchant to use with a checkout.

Path Parameters

• merchant_code string required

  The SumUp merchant code.

Query Parameters

• amount number

  The amount for which the payment methods should be eligible, in major units. Note that currency must also be provided when filtering by amount.

• currency string

  The currency for which the payment methods should be eligible.

Responses

• 200
• 400
• 401

---

Available payment methods

application/json

• Schema
• Example (from schema)
• Success

---

Schema

• available_payment_methods object[]

  id string

  The ID of the payment method.

{
  "available_payment_methods": [
    {
      "id": "string"
    }
  ]
}

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

Bad Request

application/json

• Invalid_ Parameter

---

{
  "failed_constraints": [
    {
      "message": "Currency must also be specified when filtering by amount",
      "reference": "currency"
    }
  ],
  "status": 400,
  "title": "Bad Request"
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Invalid_ Token
• Not_ Authorized_ Token
• Missing_ Token

---

Schema

• message string

  Short description of the error.

• error_code string

  Platform code for the error.

{
  "message": "string",
  "error_code": "string"
}

{
  "error_message": "invalid access token",
  "error_code": "NOT_AUTHORIZED"
}

{
  "error_message": "NOT_AUTHORIZED",
  "error_code": "NOT_AUTHORIZED"
}

{
  "message": "access token required",
  "error_code": "NOT_AUTHORIZED"
}