commerce/settings/checkout/paymentsettings

Use the Payment Settings resource to specify settings when creating payments for order checkout on the site.

JSON Example

PaymentSettings Properties

Property	Description
auditInfo	type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.
auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
externalPaymentWorkflowDefinitions	type: list of externalPaymentWorkflowDefinition The external payment workflwo definitions configured for the site's payment settings. At this time, only PayPal Express is supported.
externalPaymentWorkflowDefinition.credentials	type: list of thirdPartyCredentialField The credential fields required to communicate with the external payment processor.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.apiName	type: string System-supplied API name required to communicate with the external payment processor.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.displayName	type: string The name that displays for the payment gateway or third-party credentials field.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.inputType	type: string The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.isSensitive	type: bool A flag to determine if the field holds sensitive information.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.value	type: string The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.vocabularyValues	type: list of vocabularyValue List of valid vocabulary values defined for an attribute.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.vocabularyValue.contents	type: list of localizedContent Contents of the vocabulary values that have been defined for an attribute.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.vocabularyValue.localizedContent.localeCode	type: string The two character locale code, per the country code provided. This code determines the localized content to use and display.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.vocabularyValue.localizedContent.value	type: string The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.
externalPaymentWorkflowDefinition.thirdPartyCredentialField.vocabularyValue.key	type: string Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.
externalPaymentWorkflowDefinition.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
externalPaymentWorkflowDefinition.fullyQualifiedName	type: string Fully qualified name of the attribute for the order or customer.
externalPaymentWorkflowDefinition.isEnabled	type: bool Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order.
externalPaymentWorkflowDefinition.isLegacy	type: bool Whether this is a legacy process.
externalPaymentWorkflowDefinition.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
externalPaymentWorkflowDefinition.namespace	type: string The namespace for the accessible APIs and source capabilities in the core of Kibo eCommerce APIs.
gateways	type: list of gateway List of name and account information for a payment gateway.
gateway.areGatewayCredentialFieldsSet	type: bool If true, the credential fields for the gateway are configured with valid values. For security purposes, Kibo eCommerce does not return the credential fields for the gateway subresource.
gateway.gatewayAccount	type: gatewayAccount Account information for the payment gateway.
gateway.gatewayAccount.binPatterns	type: list of string The bin patterns for a branded credit card.
gateway.gatewayAccount.countryCode	type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.
gateway.gatewayAccount.credentialFields	type: list of gatewayCredentialFieldValue List of credential fields for the payment gateway account.
gateway.gatewayAccount.gatewayCredentialFieldValue.isValueSet	type: bool A list of KeyValueTuples containing the configuration from the application setup.
gateway.gatewayAccount.gatewayCredentialFieldValue.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
gateway.gatewayAccount.gatewayCredentialFieldValue.value	type: string The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.
gateway.gatewayAccount.gatewayDefinitionId	type: string Identifier of the payment gateway.
gateway.gatewayAccount.isActive	type: bool Indicates if the object or feature is active.
gateway.gatewayAccount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
gateway.gatewayDefinition	type: gatewayDefinition Properties of the payment gateway.
gateway.gatewayDefinition.administationUi	type: Mozu.Core.Api.Contracts.Json
gateway.gatewayDefinition.countryCode	type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.
gateway.gatewayDefinition.credentialDefinitions	type: list of gatewayCredentialFieldDefinition Credential fields for the payment gateway. For security purposes, Kibo eCommerce does not return these credential fields.
gateway.gatewayDefinition.gatewayCredentialFieldDefinition.adminDisplayOrder	type: int The sequential display order of the gateway in Admin.
gateway.gatewayDefinition.gatewayCredentialFieldDefinition.displayName	type: string The name that displays for the payment gateway or third-party credentials field.
gateway.gatewayDefinition.gatewayCredentialFieldDefinition.isPublic	type: bool Whether or not the field is public.
gateway.gatewayDefinition.gatewayCredentialFieldDefinition.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
gateway.gatewayDefinition.features	type: list of string features ApiType DOCUMENT_HERE
gateway.gatewayDefinition.id	type: string Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 or bba0a1a8-85e2-413b-b097-ceacf7bac366. For email templates, the ID must be one of the following values: BackInStock OrderChanged OrderShipped OrderFulfillmentDetailsChanged ShopperLoginCreated ShopperPasswordReset ReturnCreated ReturnAuthorized ReturnUpdated ReturnRejected ReturnCancelled ReturnClosed RefundCreated StoreCreditCreated StoreCreditUpdated GiftCardCreated
gateway.gatewayDefinition.integrationImplTypeName	type: string The implementing type name of the integration with the payment gateway.
gateway.gatewayDefinition.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
gateway.gatewayDefinition.prodServiceURL	type: string URL of the production payment service.
gateway.gatewayDefinition.supportedCards	type: list of supportedCard The types of credit cards supported by the payment gateway.
gateway.gatewayDefinition.supportedCard.friendlyName	type: string Company-defined friendly name that identifies the supported card.
gateway.gatewayDefinition.supportedCard.paymentType	type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases.
gateway.gatewayDefinition.supportedCard.type	type: string The type of scope, which is a developer account or production tenant.
gateway.gatewayDefinition.testServiceURL	type: string URL of the test payment service environment.
gateway.siteGatewaySupportedCards	type: list of siteGatewaySupportedCard The cards supported by the payment gateway enabled for the site.
gateway.siteGatewaySupportedCard.cardTypeId	type: string An identifier for the type of payment card being used in the gateway.
gateway.siteGatewaySupportedCard.gatewayAccountId	type: string The identifier of the account for the gateway.
gateway.siteGatewaySupportedCard.paymentType	type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases.
gateway.siteGatewaySupportedCard.processingGatewayAccountId	type: string The identifier of the account for the processing gateway.
gateway.supportedCards	type: list of string The types of credit cards supported by the payment gateway.
payByMail	type: bool Settings that provide for the ability to pay for an order by mail.
purchaseOrder	type: purchaseOrderPaymentDefinition The purchase order payment type settings associated with a site. Refer to Enable the Purchase Order Payment Type in the Purchase Orders guides topic for more information.
purchaseOrderPaymentDefinition.allowSplitPayment	type: bool Specifies whether another payment can be used with the purchase order. Note: Split payment is currently not supported with purchase orders.
purchaseOrderPaymentDefinition.customFields	type: list of purchaseOrderCustomField The details of the custom fields associated with the purchase order payment type for the specific site. You can create custom text fields that customers or CSRs can fill out when they use the purchase order payment method before submitting the order. Refer to Custom Text Fields in the Purchase Orders guides topic for more information.
purchaseOrderPaymentDefinition.purchaseOrderCustomField.code	type: string The unique identifier of the object.
purchaseOrderPaymentDefinition.purchaseOrderCustomField.isEnabled	type: bool Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order.
purchaseOrderPaymentDefinition.purchaseOrderCustomField.isRequired	type: bool Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value.
purchaseOrderPaymentDefinition.purchaseOrderCustomField.label	type: string Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.
purchaseOrderPaymentDefinition.purchaseOrderCustomField.sequenceNumber	type: int The order/sequence position in which Admin displays the custom field.
purchaseOrderPaymentDefinition.isEnabled	type: bool Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order.
purchaseOrderPaymentDefinition.paymentTerms	type: list of purchaseOrderPaymentTerm The complete set of payment terms details for which all your customers are possibly applicable on that specific site. Refer to Payment Terms in the Purchase Orders guides topic for more information.
purchaseOrderPaymentDefinition.purchaseOrderPaymentTerm.code	type: string The unique identifier of the object.
purchaseOrderPaymentDefinition.purchaseOrderPaymentTerm.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
purchaseOrderPaymentDefinition.purchaseOrderPaymentTerm.sequenceNumber	type: int The order/sequence position in which Admin displays the payment term.

Operations

Operation Name	Request URI	Description
AddThirdPartyPaymentWorkflow	PUT paymentsettings%2fthirdpartyworkflows	Adds a third-party payment workflow to the site. 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 Kibo eCommerce platform.
DeleteThirdPartyPaymentWorkflow	DELETE paymentsettings%2fthirdpartyworkflows%2f%7bfullyQualifiedName%7d	Deletes a third-party payment workflow. 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 Kibo eCommerce platform.
GetThirdPartyPaymentWorkflows	GET paymentsettings%2fthirdpartyworkflows	Retrieves the schema and definition of all third-party payment service workflows configured for the site.
GetThirdPartyPaymentWorkflowWithValues	GET paymentsettings%2fthirdpartyworkflow%2f%7bfullyQualifiedName%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieves the schema and definition along with the actual instance values of the third-party payment service workflow configured for the corresponding fully qualified name.