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

Create a split configuration profile

POST
/merchants/{merchantId}/splitConfigurations

Creates a split configuration profile to split payments automatically. After you associate it with a store in your merchant account, it splits the funds of all transactions processed through that store between your liable balance account and your user's balance account.

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.

Request Body

application/json

description*string

Your description for the split configuration.

Lengthlength <= 300
rules*array<>

Array of rules that define the split configuration behavior.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/merchants/string/splitConfigurations" \  -H "Content-Type: application/json" \  -d '{    "description": "Your description for the split configuration",    "rules": [      {        "paymentMethod": "ANY",        "shopperInteraction": "ANY",        "fundingSource": "ANY",        "currency": "ANY",        "splitLogic": {          "paymentFee": "deductFromLiableAccount",          "chargeback": "deductFromLiableAccount",          "tip": "addToOneBalanceAccount",          "remainder": "addToOneBalanceAccount",          "commission": {            "fixedAmount": 10,            "variablePercentage": 100          },          "additionalCommission": {            "fixedAmount": 10,            "variablePercentage": 50,            "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"          }        }      }    ]  }'

Example response after creating 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"      }    }  ],  "splitConfigurationId": "SCNF4224P22322585HPCX384JV6JGX"}

Get a list of split configuration profiles GET

Returns the list of split configuration profiles for the merchant account. 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

Get a split configuration profile GET

Returns the details of 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