Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Split configuration - merchant level

Create a rule

Creates a rule in the split configuration profile 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

cardRegion'international' | 'intraEEA' | 'intraRegional' | 'interRegional' | 'domestic' | 'ANY'

The card region condition that determines whether the split logic applies to the transaction.

This condition is in pilot phase, and not yet available for all platforms.

Possible values:

  • domestic: The card issuer and the store where the transaction is processed are registered in the same country.
  • international: The card issuer and the store where the transaction is processed are registered in different countries or regions. Includes all interRegional and intraRegional transactions.
  • interRegional: The card issuer and the store where the transaction is processed are registered in different regions.
  • intraRegional: The card issuer and the store where the transaction is processed are registered in different countries, but in the same region.
  • intraEEA: The card issuer and the store where the transaction is processed are registered in different countries, but in the European Economic Area (EEA).
  • ANY: Applies to all transactions, regardless of the processing and issuing country/region.
currencystring required

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

fundingSource'charged' | 'credit' | 'debit' | 'deferred_debit' | 'prepaid' | 'ANY' required

The funding source of the payment method.

Possible values:

  • credit
  • debit
  • prepaid
  • deferred_debit
  • charged
  • 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.