APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementSplit configuration merchant level

Update the split conditions

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

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

splitConfigurationId*string

The identifier of the split configuration.

ruleId*string

The unique identifier of the split configuration rule.

Request Body

application/json

currency*string

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

fundingSource*string

The funding source of the payment method.

Possible values:

  • credit
  • debit
  • prepaid
  • deferred_debit
  • charged
  • ANY
paymentMethod*string

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

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 Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/splitConfigurations/string/rules/string" \  -H "Content-Type: application/json" \  -d '{    "currency": "EUR",    "fundingSource": "ANY",    "paymentMethod": "visa",    "shopperInteraction": "ANY"  }'

Example response after updating a rule in a split configuration

{  "description": "Your description for the split configuration",  "rules": [    {      "currency": "ANY",      "fundingSource": "ANY",      "paymentMethod": "ANY",      "ruleId": "SCRL4224P22322585HPCX384JW65VW",      "shopperInteraction": "ANY",      "splitLogic": {        "additionalCommission": {          "fixedAmount": 10,          "variablePercentage": 50,          "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"        },        "chargeback": "deductFromLiableAccount",        "commission": {          "fixedAmount": 10,          "variablePercentage": 100        },        "splitLogicId": "SCLG4224P22322585HPCX384JX52M2",        "paymentFee": "deductFromLiableAccount",        "remainder": "addToOneBalanceAccount",        "tip": "addToOneBalanceAccount"      }    },    {      "currency": "EUR",      "fundingSource": "ANY",      "paymentMethod": "visa",      "ruleId": "SCRL4224P22322585HPCX5V4KV6L2R",      "shopperInteraction": "ANY",      "splitLogic": {        "additionalCommission": {          "fixedAmount": 10,          "variablePercentage": 50,          "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"        },        "chargeback": "deductFromLiableAccount",        "commission": {          "fixedAmount": 10,          "variablePercentage": 100        },        "splitLogicId": "SCLG4224P22322585HPCX5V4KW26C9",        "paymentFee": "deductFromLiableAccount",        "remainder": "addToLiableAccount",        "tip": "addToOneBalanceAccount"      }    }  ],  "splitConfigurationId": "SCNF4224P22322585HPCX384JV6JGX"}

Delete a split configuration profile DELETE

Deletes the split configuration profile specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write

Delete a rule DELETE

Deletes the rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write