Update split conditions

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

Was this page helpful?

Changes the conditions of the split configuration rule specified in the path.

To make this request, your API credential must have the following role:

Management API - SplitConfiguration read and write

Endpoint destination URL

https://management-test.adyen.com/v1/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}

Path parameters

Required Optional

ruleId string Required

The unique identifier of the split configuration rule.

splitConfigurationId string Required

The identifier of the split configuration.

merchantId string Required

The unique identifier of the merchant account.

Request parameters

Required Optional

currency string Required

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 condition of the payment method (only for cards).

Possible values: credit, debit, or ANY.

paymentMethod string Required

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 Required

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 parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
description string

Max length: 300

Your description for the split configuration.

rules array [object]

Array of rules that define the split configuration behavior.

Show children Hide children

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 condition of the payment method (only for cards).

Possible values: credit, debit, or 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.

ruleId string

The unique identifier of the split configuration rule.

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.

splitLogic object

Contains the split logic that is applied if the rule conditions are met.

Show children Hide children

additionalCommission object

Contains the logic used to calculate your user's commission, booked directly to their balance account.

Show children Hide children

balanceAccountId string

Unique identifier of the balance account to which the additional commission is booked.

fixedAmount integer

A fixed commission fee, in minor units.

variablePercentage integer

A variable commission fee, in basis points.

chargeback string

Specifies the logic to apply when booking the chargeback amount.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

commission object

Contains the logic used to the calculate your platform's commission, booked to your liable balance account.

Show children Hide children

fixedAmount integer

A fixed commission fee, in minor units.

variablePercentage integer

A variable commission fee, in basis points.

paymentFee string

Specifies the logic to apply when booking the transaction fees.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

remainder string

Specifies the logic to apply when booking the amount left over after currency conversion.

Possible values: addToLiableAccount, addToOneBalanceAccount.

splitLogicId string

Unique identifier of the split logic that is applied when the split configuration conditions are met.

surcharge string

Specifies the logic to apply when booking the surcharge amount.

Possible values: addToLiableAccount, addToOneBalanceAccount

tip string

Specifies the logic to apply when booking tips (gratuity).

Possible values: addToLiableAccount, addToOneBalanceAccount.

splitConfigurationId string

Unique identifier of the split configuration.

stores array [string]

List of stores to which the split configuration applies.
204 - No Content

The request has been successfully processed, but there is no additional content.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error

The server could not process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Update split conditions

Endpoint destination URL

Path parameters

Request parameters

Response parameters

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error