Routing - Elimination

POST /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create

Create a Routing Algorithm for elimination-based dynamic routing.

cURL

Create elimination routing (cURL)
curl --request POST \
  --url https://sandbox.hyperswitch.io/account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "decision_engine_configs": {
    "threshold": 123
  },
  "params": [
    "PaymentMethod"
  ],
  "elimination_analyser_config": {
    "bucket_size": 1,
    "bucket_leak_interval_in_secs": 1
  }
}
'

Sample successful response (200)

Authorization

  • Supported: api_key, jwt_key

  • Header: api-key (string) — required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

  • account_id (string) — required Merchant id

  • profile_id (string) — required Profile id under which Dynamic routing needs to be created

Query Parameters

  • enable (enum) — required Feature to enable for elimination based routing

    Available options: metrics, dynamic_connector_selection, none

Body (application/json)

  • decision_engine_configs (object) — required See child attributes in the API schema.

  • params (enum[] | null) Available options:

    • PaymentMethod

    • PaymentMethodType

    • AuthenticationType

    • Currency

    • Country

    • CardNetwork

    • CardBin

  • elimination_analyser_config (object) See child attributes in the API schema.

Response (200 — application/json)

Routing Algorithm created. Response fields:

  • id (string) — required

  • profile_id (string) — required

  • name (string) — required

  • kind (enum) — required Available options: single, priority, volume_split, advanced, dynamic, three_ds_decision_rule

  • description (string) — required

  • created_at (integer) — required

  • modified_at (integer) — required

  • algorithm_for (enum) Available options: payment, payout, three_ds_authentication

  • decision_engine_routing_id (string | null)

Was this page helpful? Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/routing/routing--elimination.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/routing/routing--elimination

PreviousPaymentMethods - CreateNextPayouts - Cancel