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

Update the description of the split configuration profile

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

Changes the description of 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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

splitConfigurationId*string

The unique identifier of the split configuration.

Request Body

application/json

description*string

Your description for the split configuration.

Lengthlength <= 300

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/splitConfigurations/string" \  -H "Content-Type: application/json" \  -d '{    "description": "Updated description for the split configuration"  }'

Example response after updating the description of a split configuration

{  "description": "Updated 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": 100,          "variablePercentage": 0,          "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"        },        "chargeback": "deductFromLiableAccount",        "commission": {          "fixedAmount": 100,          "variablePercentage": 100        },        "splitLogicId": "SCLG4224P22322585HPCX5V4KW26C9",        "paymentFee": "deductFromLiableAccount",        "remainder": "addToLiableAccount",        "tip": "addToLiableAccount"      }    }  ],  "splitConfigurationId": "SCNF4224P22322585HPCX384JV6JGX"}

Create a rule POST

[Creates a rule](https://docs.adyen.com/platforms/automatic-split-configuration/manage-split-configurations/api/#create-rule) in 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 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