v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Payments

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

Licenses Required

Vista.Ocapi

get/ocapi/v1/web-payment-methods

Query parameters

orderType'Standard' | 'GiftShop' | 'Subscription' 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 order type Standard

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

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