---
title: "Get Third Party Payment Workflows"
method: GET
path: "/commerce/settings/checkout/paymentsettings/thirdpartyworkflows"
tags: ["CheckoutSettings"]
---

# Get Third Party Payment Workflows

`GET /commerce/settings/checkout/paymentsettings/thirdpartyworkflows`

Retrieves list of external payment workflow definitions. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the Unified eCommerce platform.

## Query parameters

- `responseFields` string

## Response `200`

OK

- ExternalPaymentWorkflowDefinition[]
  - `credentials` ThirdPartyCredentialField[], nullable
    - `apiName` string, nullable — The name of this credential that should be used for web requests.
    - `displayName` string, nullable — The displayable name of this credential field
    - `inputType` string, nullable — The input field type for the value.
    - `isSensitive` boolean, nullable — the value holds sensitive information.
    - `value` string, nullable — The value for this credential that should be used for web requests.
    - `vocabularyValues` VocabularyValue[], nullable
      - `contents` LocalizedContent[], nullable
        - `localeCode` string, nullable
        - `value` string, nullable
      - `key` string, nullable
  - `description` string, nullable — Information about this definition for display purposes in the 'Payment and Checkout Settings' admin ui. This field may contain valid html tags
  - `fullyQualifiedName` string, nullable
  - `isEnabled` boolean
  - `isLegacy` boolean, nullable — Indicates if this is a legacy implementation using ARC only or using the new extensible implementation.
  - `name` string, nullable — Should be one of Contracts.Constants.ThirdPartyWorkflowNames.
  - `namespace` string, nullable

---

[API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)