Create a rule

post/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}

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
Endpoint destination URL
https://management-test.adyen.com/v1/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}
splitConfigurationIdstringRequired

The unique identifier of the split configuration.

merchantIdstringRequired

The unique identifier of the merchant account.

cardRegionstring

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.
currencystringRequired

The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.

fundingSourcestringRequired

The funding source of the payment method.

Possible values:

  • credit
  • debit
  • prepaid
  • deferred_debit
  • charged
  • ANY
paymentMethodstringRequired

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.
shopperInteractionstringRequired

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.
splitLogicobjectRequired

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

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.

  • 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.

  • 401 - Unauthorized

    Authentication required.

  • 403 - Forbidden

    Insufficient permissions to process the request.

  • 422 - Unprocessable Entity

    A request validation error.

  • 500 - Internal Server Error

    The server could not process the request.