Sign in
Split configuration - merchant level

Create a rule

Creates a rule in the split configuration specified in the path.

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

  • Management API - SplitConfiguration read and write
post/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

splitConfigurationIdstring required

The unique identifier of the split configuration.

Request body

currencystring required

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

fundingSource'credit' | 'debit' | 'ANY'

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

Possible values: credit, debit, or ANY.

paymentMethodstring required

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.
ruleIdstring

The unique identifier of the split configuration rule.

shopperInteraction'Ecommerce' | 'ContAuth' | 'Moto' | 'POS' | 'ANY' required

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.

Response

OK - the request has succeeded.

descriptionstring required

Your description for the split configuration.

splitConfigurationIdstring

Unique identifier of the split configuration.

storesstring[]

List of stores to which the split configuration applies.

Changes