JUjuspay
Routing Rules

Create routing rule

Changed on

Create a new Euclid declarative routing rule for a merchant. Supports advanced (full Euclid DSL), priority (ordered gateway list), single (fixed gateway), volume_split (percentage-based distribution), ab_test, and volume_contract (volume-commitment contract document, stored in the dedicated algorithm_for: volume_commitment slot; not evaluable by /routing/evaluate) algorithm types.

post/routing/create

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/routing/create
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

namestring required
descriptionstring
created_bystring required
algorithm_for'payment' | 'payout' | 'three_ds_authentication' | 'volume_commitment'

Activation slot for the rule. payment rules are evaluated by /routing/evaluate; volume_commitment holds the merchant's volume-contract configuration document and is required iff algorithm.type is volume_contract.

metadataobject nullable

Free-form metadata stored with the rule.

Example request

{
  "name": "default-priority",
  "created_by": "test_merchant",
  "algorithm": {
    "type": "priority"
  }
}

Response

Routing rule created

rule_idstring
namestring
algorithm_forstring
created_atstring
modified_atstring

Example response

{
  "rule_id": "routing_e641380c-6f24-4405-8454-5ae6cbceb7a0",
  "name": "priority rule",
  "algorithm_for": "payment",
  "created_at": "2026-04-26 10:00:00.000000",
  "modified_at": "2026-04-26 10:00:00.000000"
}

Changes

  • ac1bf3c6e928Revision changes
    • info

      added the new volume_commitment enum value to the request property

    • info

      added the new volume_contract enum value to the request property /

  • 36e7a0972ee6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new ab_test enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status