PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}

Changes the conditions of the split configuration rule specified in the path.

To make this request, your API credential must have the following role:

Servers

Path parameters

Name Type Required Description
splitConfigurationId String Yes

The identifier of the split configuration.

ruleId String Yes

The unique identifier of the split configuration rule.

merchantId String Yes

The unique identifier of the merchant account.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
paymentMethod String Yes

The payment method condition that defines whether the split logic applies.

Possible values:

  • Payment method variant: Apply the split logic for a specific payment method.
  • ANY: Apply the split logic for all available payment methods.
shopperInteraction String Yes

The sales channel condition that defines whether the split logic applies.

Possible values:

  • Ecommerce: Online transactions where the cardholder is present.
  • ContAuth: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).
  • Moto: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.
  • POS: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.
  • ANY: All sales channels.
fundingSource String No

The funding source condition of the payment method (only for cards).

Possible values: credit, debit, or ANY.

currency String Yes

The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.