Skip to main content
GET
/
commerce
/
settings
/
checkout
Error
A valid request URL is required to generate request examples
{
  "paymentSettings": {
    "gateways": [
      {
        "gatewayDefinition": {
          "id": "<string>",
          "countryCode": "<string>",
          "name": "<string>",
          "prodServiceURL": "<string>",
          "testServiceURL": "<string>",
          "integrationImplTypeName": "<string>",
          "supportedCards": [
            {
              "type": "<string>",
              "friendlyName": "<string>",
              "paymentType": "<string>"
            }
          ],
          "features": [
            "<string>"
          ],
          "credentialDefinitions": [
            {
              "name": "<string>",
              "displayName": "<string>",
              "adminDisplayOrder": 123,
              "isPublic": true
            }
          ],
          "preAuthorizeDefinition": {
            "id": 123,
            "preAuthorizeTestUrl": "<string>",
            "preAuthorizeProdUrl": "<string>",
            "type": {
              "id": 123,
              "type": "<string>",
              "description": "<string>"
            }
          },
          "administationUi": [
            {}
          ]
        },
        "areGatewayCredentialFieldsSet": true,
        "gatewayAccount": {
          "id": "<string>",
          "name": "<string>",
          "gatewayDefinitionId": "<string>",
          "countryCode": "<string>",
          "isActive": true,
          "credentialFields": [
            {
              "name": "<string>",
              "value": "<string>",
              "isValueSet": true
            }
          ],
          "binPatterns": [
            "<string>"
          ]
        },
        "supportedCards": [
          "<string>"
        ],
        "siteGatewaySupportedCards": [
          {
            "gatewayAccountId": "<string>",
            "processingGatewayAccountId": "<string>",
            "cardTypeId": "<string>",
            "paymentType": "<string>"
          }
        ]
      }
    ],
    "externalPaymentWorkflowDefinitions": [
      {
        "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
          }
        ]
      }
    ],
    "payByMail": true,
    "purchaseOrder": {
      "isEnabled": true,
      "paymentTerms": [
        {
          "code": "<string>",
          "sequenceNumber": 123,
          "description": "<string>"
        }
      ],
      "allowSplitPayment": true,
      "customFields": [
        {
          "code": "<string>",
          "label": "<string>",
          "sequenceNumber": 123,
          "isEnabled": true,
          "isRequired": true
        }
      ]
    },
    "jobSettings": {
      "autoCaptureJob": {
        "isEnabled": true,
        "interval": 123,
        "flexibleCapture": {
          "sthFlow": {
            "captureBy": "<string>",
            "captureOn": [
              "<string>"
            ]
          },
          "bopisFlow": {
            "captureBy": "<string>",
            "captureOn": [
              "<string>"
            ]
          }
        },
        "forceCaptureOnFirstCapture": true
      },
      "forceCaptureJob": {
        "isEnabled": true,
        "interval": 123,
        "captureAfterDays": 123
      }
    },
    "paymentRanking": "<string>",
    "refundRanking": "<string>",
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    }
  },
  "customerCheckoutSettings": {
    "customerCheckoutType": "<string>",
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    }
  },
  "orderProcessingSettings": {
    "paymentProcessingFlowType": "<string>",
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    },
    "useOverridePriceToCalculateDiscounts": true,
    "abandonedOrderThresholdInMinutes": 123,
    "giftCardProcessingType": "<string>",
    "giftCardRefundCreditProcessingType": "<string>",
    "thirdPartyPaymentSettings": [
      {
        "type": "<string>",
        "paymentProcessingFlowType": "<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

Success

Checkout and payment settings defined for this site. Can set which payment gateway to use, whether a shopper is required to login to place an order, when credit cards are authorized and charged (when the order is placed or shipped), and, in the future, whether the checkout page displays an option for shoppers to receive your email marketing campaigns.

​
paymentSettings
object

Payment gateway settings defined for this site. A payment gateway is an e-commerce application service provider that authorizes payments for e-businesses and online retailers. You can define multiple payment gateway settings but only one is active at a time. Authorize.net is the only payment gateway supported currently.

​
customerCheckoutSettings
object

Checkout requirements for customers, for example, whether they must login before purchasing from your store. Other customized checkout requirements can be defined.

​
orderProcessingSettings
object

Order processing (credit card payment authorization) setting defined for this site. Can choose when the shopper’s credit card is authorized and charged. Possibilities include, "authorize and charge the shopper's credit card for the full order amount when the order is placed," "authorize the shopper's credit card for the full amount when the order is placed and charge the credit card when the order is shipped," or "authorize and charge the shopper's credit card for the full amount when the order is shipped."