Get Started
Payments Core APIs
Account management APIs
Other APIs
curl --request GET \
--url https://sandbox.hyperswitch.io/accounts/{account_id} \
--header 'api-key: <api-key>'{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"enable_payment_response_hash": true,
"redirect_to_merchant_with_http_post": true,
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"organization_id": "org_q98uSGAYbjEwqs0mJwnz",
"is_recon_enabled": true,
"recon_status": "not_requested",
"merchant_account_type": "standard",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "[email protected]",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "[email protected]",
"website": "www.example.com",
"about_business": "Online Retail with a wide selection of organic products for North America",
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe",
"origin_zip": "08807"
},
"merchant_tax_registration_id": "123456789"
},
"webhook_details": {
"payment_statuses_enabled": [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
],
"refund_statuses_enabled": [
"success",
"failure"
],
"webhook_version": "1.0.2",
"webhook_username": "ekart_retail",
"webhook_password": "ekart@123",
"webhook_url": "www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payout_statuses_enabled": [
"success",
"failed"
]
},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": false,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"default_profile": "<string>",
"pm_collect_link_config": {
"allowed_domains": [
"<string>"
],
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]",
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>"
},
"product_type": "orchestration"
}Merchant Account - Retrieve
Retrieve a merchant account details.
curl --request GET \
--url https://sandbox.hyperswitch.io/accounts/{account_id} \
--header 'api-key: <api-key>'{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"enable_payment_response_hash": true,
"redirect_to_merchant_with_http_post": true,
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"organization_id": "org_q98uSGAYbjEwqs0mJwnz",
"is_recon_enabled": true,
"recon_status": "not_requested",
"merchant_account_type": "standard",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "[email protected]",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "[email protected]",
"website": "www.example.com",
"about_business": "Online Retail with a wide selection of organic products for North America",
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe",
"origin_zip": "08807"
},
"merchant_tax_registration_id": "123456789"
},
"webhook_details": {
"payment_statuses_enabled": [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
],
"refund_statuses_enabled": [
"success",
"failure"
],
"webhook_version": "1.0.2",
"webhook_username": "ekart_retail",
"webhook_password": "ekart@123",
"webhook_url": "www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payout_statuses_enabled": [
"success",
"failed"
]
},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": false,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"default_profile": "<string>",
"pm_collect_link_config": {
"allowed_domains": [
"<string>"
],
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]",
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>"
},
"product_type": "orchestration"
}Authorizations
Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.
Path Parameters
The unique identifier for the merchant account
Response
Merchant Account Retrieved
The identifier for the Merchant Account
64"y3oqhf46pyzuxjbcn2giaqnb44"
A boolean value to indicate if payment response hash needs to be enabled
true
A boolean value to indicate if redirect to merchant with http post needs to be enabled
true
Details about the primary business unit of the merchant account
Show child attributes
Show child attributes
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US "food"
The organization id merchant is associated with
1 - 64"org_q98uSGAYbjEwqs0mJwnz"
A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false
not_requested, requested, active, disabled standard, platform, connected Name of the Merchant Account
"NewAge Retailer"
The URL to redirect after completion of the payment
255"https://www.example.com/success"
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.
255"xkkdf909012sdjki2dkh5sdf"
Show child attributes
Show child attributes
The merchant's primary contact name
255"John Doe"
The merchant's primary phone number
255"999999999"
The merchant's secondary contact name
255"John Doe2"
The merchant's secondary phone number
255"999999988"
The business website of the merchant
255"www.example.com"
A brief description about merchant's business
255"Online Retail with a wide selection of organic products for North America"
Address details
Show child attributes
Show child attributes
The city, district, suburb, town, or village of the address.
50"New York"
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US The first line of the street address or P.O. Box.
200"123, King Street"
The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).
50"Powelson Avenue"
The third line of the street address, if applicable.
50"Bridgewater"
The zip/postal code for the address
50"08807"
The address state
"New York"
The first name for the address
255"John"
The last name for the address
255"Doe"
The zip/postal code of the origin
50"08807"
"123456789"
Show child attributes
Show child attributes
List of payment statuses that triggers a webhook for payment intents
Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).
succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, partially_captured_and_processing, conflicted, expired [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
]List of refund statuses that triggers a webhook for refunds
Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).
succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, partially_captured_and_processing, conflicted, expired ["success", "failure"]The version for Webhook
255"1.0.2"
The user name for Webhook login
255"ekart_retail"
The password for Webhook login
255"ekart@123"
The url for the webhook endpoint
"www.ekart.com/webhooks"
If this property is true, a webhook message is posted whenever a new payment is created
true
If this property is true, a webhook message is posted whenever a payment is successful
true
If this property is true, a webhook message is posted whenever a payment fails
true
List of payout statuses that triggers a webhook for payouts
success, failed, cancelled, initiated, expired, reversed, pending, ineligible, requires_creation, requires_confirmation, requires_payout_method_data, requires_fulfillment, requires_vendor_account_creation ["success", "failed"]- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
single Routable Connector chosen for a payment
Show child attributes
Show child attributes
RoutableConnectors are the subset of Connectors that are eligible for payments routing
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, 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, worldpayvantiv, worldpayxml, xendit, zen, zift, plaid, zsl, juspaythreedsserver, ctp_mastercard, ctp_visa, netcetera, cardinal, threedsecureio A boolean value to indicate if the merchant is a sub-merchant under a master or a parent merchant. By default, its value is false.
false
Refers to the Parent Merchant ID if the merchant being created is a sub-merchant
255"xkkdf909012sdjki2dkh5sdf"
API key that will be used for server side API access
"AH3423bkjbkjdsfbkj"
Metadata is useful for storing additional, unstructured information on an object.
An identifier for the vault used to store payment method information.
"locker_abc123"
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
single Routable Connector chosen for a payment
Show child attributes
Show child attributes
RoutableConnectors are the subset of Connectors that are eligible for payments routing
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, 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, worldpayvantiv, worldpayxml, xendit, zen, zift, plaid, zsl, juspaythreedsserver, ctp_mastercard, ctp_visa, netcetera, cardinal, threedsecureio The default profile that must be used for creating merchant accounts and payments
64Object for GenericLinkUiConfig
Show child attributes
Show child attributes
A list of allowed domains (glob patterns) where this link can be embedded / opened from
List of payment methods shown on collect UI
Show child attributes
Show child attributes
Indicates the type of payment method. Eg: 'card', 'wallet', etc.
card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment An array of associated payment method types
Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity, open_banking_pis, direct_carrier_billing, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
Merchant's display logo
255"https://hyperswitch.io/favicon.ico"
Custom merchant name for the link
255"Hyperswitch"
Primary color to be used in the form represented in hex format
255"#4285F4"
Custom domain name to be used for hosting the link
orchestration, vault, recon, recovery, cost_observability, dynamic_routing Was this page helpful?