Routing
Routing - Deactivate
- POSTPayments - Create
- POSTPayments - Update
- POSTPayments - Confirm
- GETPayments - Retrieve
- POSTPayments - Cancel
- POSTPayments - Capture
- POSTPayments - Incremental Authorization
- POSTPayments - Session token
- GETPayments Link - Retrieve
- GETPayments - List
- POSTPayments - External 3DS Authentication
- POSTPayments - Complete Authorize
- POSTPaymentMethods - Create
- GETPayment Method - Retrieve
- POSTPayment Method - Update
- DELPayment Method - Delete
- GETPayment Method - Set Default Payment Method for Customer
- GETList payment methods for a Merchant
- GETList customer saved payment methods for a Payment
- GETList payment methods for a Customer
- GETPayment Method - Set Default Payment Method for Customer
- POSTCustomers - Create
- GETCustomers - Retrieve
- POSTCustomers - Update
- DELCustomers - Delete
- POSTCustomers - List
- POSTMandates - Revoke Mandate
- GETMandates - Retrieve Mandate
- POSTMandates - Customer Mandates List
- POSTMerchant Account - Create
- GETMerchant Account - Retrieve
- POSTMerchant Account - Update
- DELMerchant Account - Delete
- POSTMerchant Account - KV Status
- POSTBusiness Profile - Create
- POSTBusiness Profile - Update
- GETBusiness Profile - Retrieve
- DELBusiness Profile - Delete
- GETBusiness Profile - List
- POSTMerchant Connector - Create
- GETMerchant Connector - Retrieve
- POSTMerchant Connector - Update
- DELMerchant Connector - Delete
- GETMerchant Connector - List
- POSTPayouts - Create
- GETPayouts - Retrieve
- POSTPayouts - Update
- POSTPayouts - Cancel
- POSTPayouts - Fulfill
- GETPayouts - List
- POSTPayouts - Filter
- GETRouting - List
- POSTRouting - Create
- GETRouting - Retrieve Config
- POSTRouting - Deactivate
- GETRouting - Retrieve Default Config
- POSTRouting - Update Default Config
- GETRouting - Retrieve Default For Profile
- POSTRouting - Update Default For Profile
- GETRouting - Retrieve
- POSTRouting - Activate config
- Outgoing webhook
Payments
Payment Methods
Customers
Mandates
Merchant Account
Business Profile
Merchant Connector Account
Payouts
Routing
Schemas
Routing
Routing - Deactivate
Routing - Deactivate
Deactivates a routing config
POST
/
routing
/
deactivate
api-key
string
*
api-key
Required
string
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.
object
*
name
string
name
string
description
string
description
string
algorithm
Option 1 · object
algorithm
object
Routing Algorithm kind
type
enum<string>
*
type
Required
enum<string>
data
object
*
data
Required
object
Routable Connector chosen for a payment
connector
enum<string>
*
connector
Required
enum<string>
Connectors eligible for payments routing
merchant_connector_id
string
merchant_connector_id
string
profile_id
string
profile_id
string
curl --request POST \
--url https://sandbox.hyperswitch.io/routing/deactivate \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"profile_id": "<string>"
}'
{
"id": "<string>",
"profile_id": "<string>",
"name": "<string>",
"kind": "single",
"description": "<string>",
"created_at": 123,
"modified_at": 123,
"algorithm_for": "payment"
}
Authorizations
api-key
string
headerrequiredUse 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
name
string | null
description
string | null
algorithm
object
Routing Algorithm kind
algorithm.type
enum<string>
requiredAvailable options:
single
algorithm.data
object
requiredRoutable Connector chosen for a payment
algorithm.data.connector
enum<string>
requiredConnectors eligible for payments routing
Available options:
adyenplatform
, phonypay
, fauxpay
, pretendpay
, stripe_test
, adyen_test
, checkout_test
, paypal_test
, aci
, adyen
, airwallex
, authorizedotnet
, bankofamerica
, billwerk
, bitpay
, bambora
, bluesnap
, boku
, braintree
, cashtocode
, checkout
, coinbase
, cryptopay
, cybersource
, dlocal
, ebanx
, fiserv
, forte
, globalpay
, globepay
, gocardless
, helcim
, iatapay
, klarna
, mifinity
, mollie
, multisafepay
, nexinets
, nmi
, noon
, nuvei
, opennode
, payme
, payone
, paypal
, payu
, placetopay
, powertranz
, prophetpay
, rapyd
, riskified
, shift4
, signifyd
, square
, stax
, stripe
, trustpay
, tsys
, volt
, wise
, worldline
, worldpay
, zen
, zsl
algorithm.data.merchant_connector_id
string | null
profile_id
string | null
Response
200 - application/json
id
string
requiredprofile_id
string
requiredname
string
requiredkind
enum<string>
requiredAvailable options:
single
, priority
, volume_split
, advanced
description
string
requiredcreated_at
integer
requiredmodified_at
integer
requiredalgorithm_for
enum<string>
Available options:
payment
curl --request POST \
--url https://sandbox.hyperswitch.io/routing/deactivate \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"profile_id": "<string>"
}'
{
"id": "<string>",
"profile_id": "<string>",
"name": "<string>",
"kind": "single",
"description": "<string>",
"created_at": 123,
"modified_at": 123,
"algorithm_for": "payment"
}