Routing - Update Default Config

Update the default routing configuration.

POST /routing/default

cURL

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/routing/default \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
[
  {
    "connector": "authipay",
    "merchant_connector_id": "<string>"
  }
]
'

Successful response (200)

application/json
[
  {
    "connector": "authipay",
    "merchant_connector_id": "<string>"
  }
]

Authorizations

  • api-key (required, header)

  • jwt_key (alternate)

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.

Body (application/json)

An array of routing entries. Each entry:

  • connector (string, required) — RoutableConnectors are the subset of Connectors that are eligible for payments routing. Available options include (but are not limited to):

    authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bankofamerica, barclaycard, billwerk, bitpay, bambora, blackhawknetwork, bamboraapac, bluesnap, calida, boku, braintree, breadpay, cashtocode, celero, chargebee, custombilling, checkbook, checkout, coinbase, coingate, cryptopay, cybersource, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, elavon, facilitapay, finix, fiserv, fiservemea, fiuu, flexiti, forte, getnet, gigadat, globalpay, globepay, gocardless, hipay, helcim, iatapay, inespay, itaubank, jpmorgan, klarna, loonio, mifinity, mollie, moneris, multisafepay, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, payme, payload, payone, paypal, paysafe, paystack, paytm, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, riskified, santander, shift4, signifyd, silverflow, square, stax, stripe, stripebilling, tesouro, trustpay, trustpayments, tokenio, tsys, volt, wells fargo, wise, worldline, worldpay, worldpaymodular, worldpayvantiv, worldpayxml, xendit, zen, zift, plaid, zsl, juspaythreedsserver, ctp_mastercard, ctp_visa, netcetera, cardinal, threedsecureio

  • merchant_connector_id (string | null) — optional merchant-specific connector identifier

Example body:

Response (200 — application/json)

Successfully updated default config. Returns an array of routing entries with the same fields as the request:

  • connector (string) — selected RoutableConnector

  • merchant_connector_id (string | null)

Example response:

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

PreviousPayments - Cancel Post CaptureNextRouting - Auth Rate Based