ADadyen
Split configuration - merchant level

Update the split conditions

Changed on

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

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

  • Management API - SplitConfiguration read and write
patch/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

splitConfigurationIdstring required

The identifier of the split configuration.

ruleIdstring required

The unique identifier of the split configuration rule.

Request body

cardUsageType'commercial' | 'consumer' | 'ANY'

The card usage type condition that determines whether the split logic applies to commercial cards, consumer cards, or all cards.

  • ANY (default): The split logic applies to all cards, regardless of its usage type.
  • commercial: The split logic applies to commercial cards only.
  • consumer: The split logic applies to consumer cards only.
currencystring required

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

fundingSourcestring 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.
shopperInteractionstring 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.

Changes

  • v355cb8143ce0eRevision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • v3f634b6afa653Revision changes
    • info

      added the optional property /// to the response with the status