Get Third Party Payment Workflow With Values

Gets a third party payment workflow specified by workflow definition. 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/thirdpartyworkflow/{fullyQualifiedName}

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.

Path Parameters

fullyQualifiedName · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

This class describes credentials and enablement for the various third-party payment workflows that we will integrate with. Examples include Paypal Express, Amazon Payments, Google Wallet, etc.

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