curl --request POST \
--url https://sandbox.hyperswitch.io/account/{account_id}/business_profile \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{}'
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
"profile_name": "<string>",
"enable_payment_response_hash": true,
"redirect_to_merchant_with_http_post": true,
"is_tax_connector_enabled": true,
"is_network_tokenization_enabled": false,
"is_auto_retries_enabled": false,
"is_click_to_pay_enabled": false,
"is_clear_pan_retries_enabled": true,
"force_3ds_challenge": true,
"is_pre_network_tokenization_enabled": false,
"return_url": "https://www.example.com/success",
"payment_response_hash_key": "xkkd",
"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": "https://www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payout_statuses_enabled": [
"success",
"failed"
],
"dispute_statuses_enabled": [
"dispute_opened",
"dispute_won"
],
"mandate_statuses_enabled": [
"active",
"inactive"
],
"invoice_statuses_enabled": [
"invoice_paid"
]
},
"metadata": {},
"routing_algorithm": {},
"intent_fulfillment_time": 900,
"frm_routing_algorithm": {},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
},
"applepay_verified_domains": [
"<string>"
],
"session_expiry": 900,
"payment_link_config": {
"theme": "#4E6ADD",
"logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
"seller_name": "hyperswitch",
"sdk_layout": "accordion",
"display_sdk_only": true,
"enabled_saved_payment_method": true,
"hide_card_nickname_field": true,
"show_card_form_by_default": true,
"transaction_details": [
{
"key": "Policy-Number",
"value": "297472368473924",
"ui_configuration": {
"position": 5,
"is_key_bold": true,
"is_value_bold": true
}
}
],
"background_image": {
"url": "https://hyperswitch.io/favicon.ico",
"position": "left",
"size": {
"Variants": "cover"
}
},
"details_layout": "layout1",
"payment_button_text": "<string>",
"custom_message_for_card_terms": "<string>",
"custom_message_for_payment_method_types": [
{
"payment_method": "card",
"payment_method_types": [
{
"message": {
"display_mode": "custom",
"value": "Sample message"
},
"payment_method_type": "credit"
}
]
}
],
"payment_button_colour": "<string>",
"skip_status_screen": true,
"payment_button_text_colour": "<string>",
"background_colour": "<string>",
"sdk_ui_rules": {},
"payment_link_ui_rules": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"is_setup_mandate_flow": true,
"color_icon_card_cvc_error": "<string>",
"show_merchant_name": true,
"payment_methods_separator_text": "Or pay with",
"redirect_delay_seconds": 10,
"domain_name": "<string>",
"business_specific_configs": {},
"allowed_domains": [
"<string>"
],
"branding_visibility": true
},
"authentication_connector_details": {
"authentication_connectors": [
"threedsecureio"
],
"three_ds_requestor_url": "<string>",
"three_ds_requestor_app_url": "<string>"
},
"use_billing_as_payment_method_billing": true,
"extended_card_info_config": {
"public_key": "<string>",
"ttl_in_secs": 900
},
"collect_shipping_details_from_wallet_connector": false,
"collect_billing_details_from_wallet_connector": false,
"always_collect_shipping_details_from_wallet_connector": false,
"always_collect_billing_details_from_wallet_connector": false,
"is_connector_agnostic_mit_enabled": true,
"payout_link_config": {
"allowed_domains": [
"<string>"
],
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"form_layout": "tabs",
"payout_test_mode": false
},
"outgoing_webhook_custom_http_headers": {},
"tax_connector_id": "<string>",
"max_auto_retries_enabled": 123,
"always_request_extended_authorization": true,
"authentication_product_ids": {},
"card_testing_guard_config": {
"card_ip_blocking_status": "enabled",
"card_ip_blocking_threshold": 123,
"guest_user_card_blocking_status": "enabled",
"guest_user_card_blocking_threshold": 123,
"customer_id_blocking_status": "enabled",
"customer_id_blocking_threshold": 123,
"card_testing_guard_expiry": 123,
"guest_ip_blocking_status": "enabled",
"guest_ip_blocking_threshold": 10
},
"is_debit_routing_enabled": true,
"merchant_business_country": "AF",
"acquirer_configs": [
{
"profile_acquirer_id": "pro_acq_LCRdERuylQvNQ4qh3QE0",
"profile_id": "pro_ky0yNyOXXlA5hF8JzE5q",
"is_default": true,
"acquirer_assigned_merchant_id": "M123456789",
"merchant_name": "NewAge Retailer",
"network": "VISA",
"acquirer_bin": "456789",
"acquirer_ica": "401288",
"acquirer_fraud_rate": 0.01,
"acquirer_country_code": "US"
}
],
"acquirer_config_bucket": {
"configs": {},
"default_acquirer_config": "pro_acq_LCRdERuylQvNQ4qh3QE0"
},
"is_iframe_redirection_enabled": false,
"merchant_category_code": "5411",
"merchant_country_code": "<string>",
"dispute_polling_interval": 2,
"is_manual_retry_enabled": true,
"auto_fallback_capture_method": true,
"always_enable_overcapture": true,
"is_external_vault_enabled": "enable",
"external_vault_connector_details": {
"vault_connector_id": "<string>",
"vault_sdk": "vgs_sdk",
"vault_token_selector": [
{
"token_type": "card_number"
}
]
},
"billing_processor_id": "<string>",
"surcharge_connector_details": {
"surcharge_connector_id": "<string>"
},
"is_l2_l3_enabled": true,
"network_tokenization_credentials": {
"internal_network_token_service": {
"token_service_api_key": "MDRFRDU3Mzc1Q0Q0N2893727712QzQjJEQzlENTBCOg==",
"public_key": "-----BEGIN PUBLIC KEY-----\nsom8723hj1bajhgd123==\n-----END PUBLIC KEY-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n897238huhbsdbjh12==\n-----END RSA PRIVATE KEY-----",
"key_id": "key_1ac9895a6d85414897213gahdac838a8"
}
},
"payment_method_blocking": {
"card": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
},
"wallet": {
"card_types": [
"credit"
],
"apple_pay": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
},
"google_pay": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
}
}
}
}Business Profile
Profile - Create
Creates a new profile for a merchant
POST
/
account
/
{account_id}
/
business_profile
curl --request POST \
--url https://sandbox.hyperswitch.io/account/{account_id}/business_profile \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{}'
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
"profile_name": "<string>",
"enable_payment_response_hash": true,
"redirect_to_merchant_with_http_post": true,
"is_tax_connector_enabled": true,
"is_network_tokenization_enabled": false,
"is_auto_retries_enabled": false,
"is_click_to_pay_enabled": false,
"is_clear_pan_retries_enabled": true,
"force_3ds_challenge": true,
"is_pre_network_tokenization_enabled": false,
"return_url": "https://www.example.com/success",
"payment_response_hash_key": "xkkd",
"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": "https://www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payout_statuses_enabled": [
"success",
"failed"
],
"dispute_statuses_enabled": [
"dispute_opened",
"dispute_won"
],
"mandate_statuses_enabled": [
"active",
"inactive"
],
"invoice_statuses_enabled": [
"invoice_paid"
]
},
"metadata": {},
"routing_algorithm": {},
"intent_fulfillment_time": 900,
"frm_routing_algorithm": {},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
},
"applepay_verified_domains": [
"<string>"
],
"session_expiry": 900,
"payment_link_config": {
"theme": "#4E6ADD",
"logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
"seller_name": "hyperswitch",
"sdk_layout": "accordion",
"display_sdk_only": true,
"enabled_saved_payment_method": true,
"hide_card_nickname_field": true,
"show_card_form_by_default": true,
"transaction_details": [
{
"key": "Policy-Number",
"value": "297472368473924",
"ui_configuration": {
"position": 5,
"is_key_bold": true,
"is_value_bold": true
}
}
],
"background_image": {
"url": "https://hyperswitch.io/favicon.ico",
"position": "left",
"size": {
"Variants": "cover"
}
},
"details_layout": "layout1",
"payment_button_text": "<string>",
"custom_message_for_card_terms": "<string>",
"custom_message_for_payment_method_types": [
{
"payment_method": "card",
"payment_method_types": [
{
"message": {
"display_mode": "custom",
"value": "Sample message"
},
"payment_method_type": "credit"
}
]
}
],
"payment_button_colour": "<string>",
"skip_status_screen": true,
"payment_button_text_colour": "<string>",
"background_colour": "<string>",
"sdk_ui_rules": {},
"payment_link_ui_rules": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"is_setup_mandate_flow": true,
"color_icon_card_cvc_error": "<string>",
"show_merchant_name": true,
"payment_methods_separator_text": "Or pay with",
"redirect_delay_seconds": 10,
"domain_name": "<string>",
"business_specific_configs": {},
"allowed_domains": [
"<string>"
],
"branding_visibility": true
},
"authentication_connector_details": {
"authentication_connectors": [
"threedsecureio"
],
"three_ds_requestor_url": "<string>",
"three_ds_requestor_app_url": "<string>"
},
"use_billing_as_payment_method_billing": true,
"extended_card_info_config": {
"public_key": "<string>",
"ttl_in_secs": 900
},
"collect_shipping_details_from_wallet_connector": false,
"collect_billing_details_from_wallet_connector": false,
"always_collect_shipping_details_from_wallet_connector": false,
"always_collect_billing_details_from_wallet_connector": false,
"is_connector_agnostic_mit_enabled": true,
"payout_link_config": {
"allowed_domains": [
"<string>"
],
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"form_layout": "tabs",
"payout_test_mode": false
},
"outgoing_webhook_custom_http_headers": {},
"tax_connector_id": "<string>",
"max_auto_retries_enabled": 123,
"always_request_extended_authorization": true,
"authentication_product_ids": {},
"card_testing_guard_config": {
"card_ip_blocking_status": "enabled",
"card_ip_blocking_threshold": 123,
"guest_user_card_blocking_status": "enabled",
"guest_user_card_blocking_threshold": 123,
"customer_id_blocking_status": "enabled",
"customer_id_blocking_threshold": 123,
"card_testing_guard_expiry": 123,
"guest_ip_blocking_status": "enabled",
"guest_ip_blocking_threshold": 10
},
"is_debit_routing_enabled": true,
"merchant_business_country": "AF",
"acquirer_configs": [
{
"profile_acquirer_id": "pro_acq_LCRdERuylQvNQ4qh3QE0",
"profile_id": "pro_ky0yNyOXXlA5hF8JzE5q",
"is_default": true,
"acquirer_assigned_merchant_id": "M123456789",
"merchant_name": "NewAge Retailer",
"network": "VISA",
"acquirer_bin": "456789",
"acquirer_ica": "401288",
"acquirer_fraud_rate": 0.01,
"acquirer_country_code": "US"
}
],
"acquirer_config_bucket": {
"configs": {},
"default_acquirer_config": "pro_acq_LCRdERuylQvNQ4qh3QE0"
},
"is_iframe_redirection_enabled": false,
"merchant_category_code": "5411",
"merchant_country_code": "<string>",
"dispute_polling_interval": 2,
"is_manual_retry_enabled": true,
"auto_fallback_capture_method": true,
"always_enable_overcapture": true,
"is_external_vault_enabled": "enable",
"external_vault_connector_details": {
"vault_connector_id": "<string>",
"vault_sdk": "vgs_sdk",
"vault_token_selector": [
{
"token_type": "card_number"
}
]
},
"billing_processor_id": "<string>",
"surcharge_connector_details": {
"surcharge_connector_id": "<string>"
},
"is_l2_l3_enabled": true,
"network_tokenization_credentials": {
"internal_network_token_service": {
"token_service_api_key": "MDRFRDU3Mzc1Q0Q0N2893727712QzQjJEQzlENTBCOg==",
"public_key": "-----BEGIN PUBLIC KEY-----\nsom8723hj1bajhgd123==\n-----END PUBLIC KEY-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n897238huhbsdbjh12==\n-----END RSA PRIVATE KEY-----",
"key_id": "key_1ac9895a6d85414897213gahdac838a8"
}
},
"payment_method_blocking": {
"card": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
},
"wallet": {
"card_types": [
"credit"
],
"apple_pay": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
},
"google_pay": {
"issuing_country": [
"AF"
],
"card_types": [
"credit"
],
"card_subtypes": [
"<string>"
],
"issuers": [
"<string>"
],
"block_if_bin_info_unavailable": true,
"card_networks": [
"Visa"
],
"funding_sources": [
"CREDIT"
],
"card_segment_types": [
"business"
],
"block_virtual_cards": true,
"block_non_reloadable_prepaid_cards": true,
"gambling_blocked": true
}
}
}
}Authorizations
Body
application/json
Indicates if the MIT (merchant initiated transaction) payments can be made connector
agnostic, i.e., MITs may be processed through different connector than CIT (customer
initiated transaction) based on the routing rules.
If set to false, MIT will go through the same connector as the CIT.
Available options:
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 Response
Profile Created
Indicates if the MIT (merchant initiated transaction) payments can be made connector
agnostic, i.e., MITs may be processed through different connector than CIT (customer
initiated transaction) based on the routing rules.
If set to false, MIT will go through the same connector as the CIT.
Available options:
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 Was this page helpful?