Routing - Retrieve Config

Retrieve active config

Authorizations

api-key

string

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.

Query Parameters

profile_id

string | null

The unique identifier for a merchant profile

Response

200 - application/json

• Option 1
• Option 2

Response of the retrieved routing configs for a merchant account

algorithm

object

Routing Algorithm specific to merchants

Show child attributes

algorithm.algorithm

object

required

Routing Algorithm kind

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

algorithm.algorithm.data

object

required

Routable Connector chosen for a payment

Show child attributes

algorithm.algorithm.data.connector

enum<string>

required

RoutableConnectors are the subset of Connectors that are 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,

bamboraapac,

bluesnap,

boku,

braintree,

cashtocode,

checkout,

coinbase,

cryptopay,

cybersource,

datatrans,

deutschebank,

digitalvirgo,

dlocal,

ebanx,

elavon,

fiserv,

fiservemea,

fiuu,

forte,

globalpay,

globepay,

gocardless,

helcim,

iatapay,

itaubank,

jpmorgan,

klarna,

mifinity,

mollie,

multisafepay,

nexinets,

nexixpay,

nmi,

noon,

novalnet,

nuvei,

opennode,

paybox,

payme,

payone,

paypal,

payu,

placetopay,

powertranz,

prophetpay,

rapyd,

razorpay,

riskified,

shift4,

signifyd,

square,

stax,

stripe,

trustpay,

tsys,

volt,

wellsfargo,

wise,

worldline,

worldpay,

zen,

plaid,

zsl

algorithm.algorithm.data.merchant_connector_id

string | null

algorithm.algorithm.type

enum<string>

required

Available options:

single

algorithm.algorithm_for

enum<string>

required

Available options:

payment,

payout

algorithm.created_at

integer

required

algorithm.description

string

required

algorithm.id

string

required

algorithm.modified_at

integer

required

algorithm.name

string

required

algorithm.profile_id

string

required