Get Third Party Payment Workflows

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.

GET /commerce/settings/checkout/paymentsettings/thirdpartyworkflows

Error

A valid request URL is required to generate request examples

200

[
  {
    "credentials": [
      {
        "apiName": "<string>",
        "displayName": "<string>",
        "inputType": "<string>",
        "isSensitive": true,
        "value": "<string>",
        "vocabularyValues": [
          {
            "contents": [
              {
                "localeCode": "<string>",
                "value": "<string>"
              }
            ],
            "key": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "fullyQualifiedName": "<string>",
    "isEnabled": true,
    "isLegacy": true,
    "name": "<string>",
    "namespace": "<string>"
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

credentials · object[] | null

Show child attributes

description · string | null

Information about this definition for display purposes in the 'Payment and Checkout Settings' admin ui. This field may contain valid html tags

fullyQualifiedName · string | null

isEnabled · boolean

isLegacy · boolean | null

Indicates if this is a legacy implementation using ARC only or using the new extensible implementation.

name · string | null

Should be one of Contracts.Constants.ThirdPartyWorkflowNames.

namespace · string | null