Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Session

Retrieve payment methods

Retrieves the ordered list of payment methods available for the specified session and checkout. Automatically filters unsupported methods and localizes the options for the buyer.

get/v2/checkouts/{checkoutPath}/sessions/{sessionId}/payment-methods

Path parameters

checkoutPathstring required

The unique identifier for the checkout instance, in the format store-id/checkout-id (e.g., fastspring/main).

Note: Target a specific checkout path to route the session to a single buyer experience and ensure accurate pricing. Stores frequently run multiple checkout variations simultaneously.

Example:fastspring/main
sessionIdstring required

The unique identifier of the order session.

Example:OS123456789012345ABC

Response

Successfully retrieved the available payment methods.

Example response

{
  "paymentMethods": [
    {
      "id": "CARD",
      "description": "PaymentMethodType.CreditCard",
      "variants": [
        "VISA",
        "MASTER_CARD",
        "AMEX"
      ]
    }
  ]
}