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
In: header
Path Parameters
The unique identifier of the merchant account.
The unique identifier of the split configuration.
Request Body
application/json
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.
- ANY: Applies to all transactions, regardless of the processing and issuing country/region.
Value in
- "international"
- "intraRegional"
- "interRegional"
- "domestic"
- "ANY"
The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.
The funding source of the payment method.
Possible values:
- credit
- debit
- prepaid
- deferred_debit
- charged
- ANY
Value in
- "charged"
- "credit"
- "debit"
- "deferred_debit"
- "prepaid"
- "ANY"
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.
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.
Value in
- "Ecommerce"
- "ContAuth"
- "Moto"
- "POS"
- "ANY"
Contains the split logic that is applied if the rule conditions are met.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/merchants/string/splitConfigurations/string" \ -H "Content-Type: application/json" \ -d '{ "paymentMethod": "visa", "shopperInteraction": "POS", "fundingSource": "ANY", "currency": "USD", "splitLogic": { "paymentFee": "deductFromLiableAccount", "chargeback": "deductFromLiableAccount", "tip": "addToOneBalanceAccount", "remainder": "addToLiableAccount", "commission": { "fixedAmount": 10, "variablePercentage": 100 }, "additionalCommission": { "fixedAmount": 10, "variablePercentage": 50, "balanceAccountId": "BA3227C223222H5HQ2XX77VVH" } } }'Example response after creating a split configuration
{ "description": "My first 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": "USD", "fundingSource": "ANY", "paymentMethod": "visa", "ruleId": "SCRL4224P22322585HPCX5V4KV6L2R", "shopperInteraction": "POS", "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"}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
Update the description of the split configuration profile PATCH
Changes the description 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
