Payments

Gets the web payment method options for an in progress order base, based on the provided order type

Changed on

Licenses Required

  • Vista.Ocapi
get/ocapi/v1/web-payment-methods

Request

Query parameters

orderType'Standard' | 'GiftShop' | 'Subscription' | 'Tab' required

The type of the in progress order base that the web payment method entities are available for

siteIdstring

The unique identifier of the site Only valid for in progress standard order and in progress tab order entities

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "webPaymentMethods": [
    {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  ]
}

Changes