---
title: "Gets the web payment method options for an in progress order base, based on the provided order type"
method: GET
path: "/ocapi/v1/web-payment-methods"
tags: ["Payments"]
---

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

`GET /ocapi/v1/web-payment-methods`

#### Licenses Required


- Vista.Ocapi

## Query parameters

- `orderType` 'Standard' | 'GiftShop' | 'Subscription', required
- `siteId` string

## Headers

- `Connect-Region-Code` string

## Response `200`

Success

- OcapiV1PaymentsMasterDataWebPaymentMethodListDetails — Represents a list of web payment method entities
  - `webPaymentMethods` OcapiV1PaymentsMasterDataWebPaymentMethod[], required — Gets the list of web payment method entities
    - `type` 'Redirect' | 'Embedded', required — Represents the type of a web payment method
    - `isDefault` boolean, required — Gets a value indicating whether this is the default web payment method
    - `id` integer, required — Gets the unique identifier
    - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
      - `text` string, required — Gets the text in the default language
      - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
        - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
        - `text` string, required — Gets the translated text
    - `displayPriority` integer, required — Gets the display priority used for sorting
    - `isRecurringBillingSupported` boolean, required — Gets a value indicating whether recurring billing is supported

## Other responses

- `400` — The provided order type, site, or gift shop does not exist.

---

[API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/versions/3a81c0aed14e/schema)