Skip to main content
GET
/
commerce
/
settings
/
checkout
/
paymentsettings
/
thirdpartyworkflow
/
{fullyQualifiedName}
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "namespace": "<string>",
  "fullyQualifiedName": "<string>",
  "description": "<string>",
  "isEnabled": true,
  "isLegacy": true,
  "credentials": [
    {
      "displayName": "<string>",
      "apiName": "<string>",
      "value": "<string>",
      "vocabularyValues": [
        {
          "key": "<string>",
          "contents": [
            {
              "localeCode": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "inputType": "<string>",
      "isSensitive": true
    }
  ]
}

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

Success

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.

​
name
string | null

Should be one of Contracts.Constants.ThirdPartyWorkflowNames.

​
namespace
string | null
​
fullyQualifiedName
string | null
​
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

​
isEnabled
boolean
​
isLegacy
boolean | null

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

​
credentials
object[] | null