POST /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
Creates a rule in the split configuration specified in the path.
To make this request, your API credential must have the following role:
- Management API - SplitConfiguration read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
Name | Type | Required | Description |
---|---|---|---|
splitConfigurationId |
String | Yes |
The unique identifier of the split configuration. |
merchantId |
String | Yes |
The unique identifier of the merchant account. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
paymentMethod |
String | Yes |
The payment method condition that defines whether the split logic applies. Possible values:
|
shopperInteraction |
String | Yes |
The sales channel condition that defines whether the split logic applies. Possible values:
Possible values:
|
ruleId |
String | No |
The unique identifier of the split configuration rule. |
fundingSource |
String | No |
The funding source condition of the payment method (only for cards). Possible values: credit, debit, or ANY. Possible values:
|
splitLogic |
Object | Yes |
Contains the split logic that is applied if the rule conditions are met. |
splitLogic.additionalCommission |
Object | No |
Defines whether to book an additional commission for payments to your user's balance account. The commission amount can be defined as a fixed amount (specified in minor units), a percentage (specified in basis points), or both. |
splitLogic.additionalCommission.fixedAmount |
Integer | No |
A fixed commission fee, in minor units. |
splitLogic.additionalCommission.variablePercentage |
Integer | No |
A variable commission fee, in basis points. |
splitLogic.additionalCommission.balanceAccountId |
String | No |
Unique identifier of the balance account to which the additional commission is booked. |
splitLogic.remainder |
String | No |
Books the amount left over after currency conversion to the specified balance account. Possible values: addToLiableAccount, addToOneBalanceAccount. Possible values:
|
splitLogic.splitLogicId |
String | No |
Unique identifier of the collection of split instructions that are applied when the rule conditions are met. |
splitLogic.refund |
String | No |
Specifies how and from which balance account(s) to deduct the refund amount. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio Possible values:
|
splitLogic.chargebackCostAllocation |
String | No |
Deducts the chargeback costs from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount Possible values:
|
splitLogic.adyenCommission |
String | No |
Deducts the transaction fee due to Adyen under blended rates from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.commission |
Object | Yes |
Defines your platform's commission for the processed payments as a fixed amount (specified in minor units), a percentage (specified in basis points), or both. The commission is booked to your platform's liable balance account. |
splitLogic.commission.fixedAmount |
Integer | No |
A fixed commission fee, in minor units. |
splitLogic.commission.variablePercentage |
Integer | No |
A variable commission fee, in basis points. |
splitLogic.tip |
String | No |
Books the tips (gratuity) to the specified balance account. Possible values: addToLiableAccount, addToOneBalanceAccount. Possible values:
|
splitLogic.interchange |
String | No |
Deducts the interchange fee from specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.schemeFee |
String | No |
Deducts the scheme fee from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.acquiringFees |
String | No |
Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.paymentFee |
String | No |
Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:
If you don't include at least one transaction fee type in the Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.refundCostAllocation |
String | No |
Deducts the refund costs from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount Possible values:
|
splitLogic.adyenMarkup |
String | No |
Deducts the transaction fee due to Adyen under Interchange ++ pricing from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
splitLogic.chargeback |
String | No |
Specifies how and from which balance account(s) to deduct the chargeback amount. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio. Possible values:
|
splitLogic.surcharge |
String | No |
Books the surcharge amount to the specified balance account. Possible values: addToLiableAccount, addToOneBalanceAccount Possible values:
|
splitLogic.adyenFees |
String | No |
Deducts the fees due to Adyen (markup or commission) from the specified balance account. Possible values: deductFromLiableAccount, deductFromOneBalanceAccount. Possible values:
|
currency |
String | Yes |
The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.