Routing - Update Default For Profile

POST /routing/default/profile/{profile_id}

Description

Update the default routing configuration for a profile.

cURL

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

Success Response (200)

Authorizations

  • api-key (header) — 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

  • profile_id (string) — required The unique identifier for a profile

Body (application/json)

Request body is an array of connector objects.

Attributes:

  • connector (string, enum) — 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, wellsfargo, wise, worldline, worldpay, worldpaymodular, worldpayvantiv, worldpayxml, xendit, zen, zift, plaid, zsl, juspaythreedsserver, ctp_mastercard, ctp_visa, netcetera, cardinal, threedsecureio

  • merchant_connector_id (string | null)

Response (200)

application/json — Successfully updated default config for profile

Response fields:

  • profile_id (string)

  • connectors (object[])

Showchild attributes are present for connector objects (see examples above).

  • Routing — Retrieve Default For Profile: https://api-reference.hyperswitch.io/v1/routing/routing--retrieve-default-for-profile

  • Routing — Retrieve: https://api-reference.hyperswitch.io/v1/routing/routing--retrieve

Edit / Report

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/routing/routing--update-default-for-profile.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/routing/routing--update-default-for-profile


Responses are generated using AI and may contain mistakes.