- 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
Merchant Account - Update
Merchant Account - Update
Updates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc
Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.
The unique identifier for the merchant account
The identifier for the Merchant Account
Name of the Merchant Account
The merchant's primary contact name
The merchant's primary phone number
The merchant's primary email address
The merchant's secondary contact name
The merchant's secondary phone number
The merchant's secondary email address
The business website of the merchant
A brief description about merchant's business
Address details
The address city
The first line of the address
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The URL to redirect after the completion of the operation
The version for Webhook
The user name for Webhook login
The password for Webhook login
The url for the webhook endpoint
If this property is true, a webhook message is posted whenever a new payment is created
If this property is true, a webhook message is posted whenever a payment is successful
If this property is true, a webhook message is posted whenever a payment fails
Routing Algorithm kind
Routable Connector chosen for a payment
Connectors eligible for payments routing
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.
Refers to the Parent Merchant ID if the merchant being created is a sub-merchant
A boolean value to indicate if payment response hash needs to be enabled
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a default value is used.
A boolean value to indicate if redirect to merchant with http post needs to be enabled
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
API key that will be used for server side API access
An identifier for the vault used to store payment method information.
Details about the primary business unit of the merchant account
The frm routing algorithm to be used for routing payments to desired FRM's
The default business profile that must be used for creating merchant accounts and payments To unset this field, pass an empty string
Object for GenericLinkUiConfig
Merchant's display logo
Custom merchant name for the link
Primary color to be used in the form represented in hex format
Custom domain name to be used for hosting the link
List of payment methods shown on collect UI
curl --request POST \
--url https://sandbox.hyperswitch.io/accounts/{account_id} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"merchant_id": "merchant_abc",
"merchant_name": "merchant_name"
}'
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"enable_payment_response_hash": true,
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"redirect_to_merchant_with_http_post": true,
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "johndoe@test.com",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "johndoe2@test.com",
"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"
}
},
"webhook_details": {
"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_routing_algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": true,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"organization_id": "<string>",
"is_recon_enabled": true,
"default_profile": "<string>",
"recon_status": "not_requested",
"pm_collect_link_config": {
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
}
}
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
Body
The identifier for the Merchant Account
Name of the Merchant Account
The merchant's primary contact name
The merchant's primary phone number
The merchant's primary email address
The merchant's secondary contact name
The merchant's secondary phone number
The merchant's secondary email address
The business website of the merchant
A brief description about merchant's business
Address details
The address city
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 address
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The URL to redirect after the completion of the operation
The version for Webhook
The user name for Webhook login
The password for Webhook login
The url for the webhook endpoint
If this property is true, a webhook message is posted whenever a new payment is created
If this property is true, a webhook message is posted whenever a payment is successful
If this property is true, a webhook message is posted whenever a payment fails
Routing Algorithm kind
single
Routable Connector chosen for a payment
Connectors eligible for payments routing
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
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.
Refers to the Parent Merchant ID if the merchant being created is a sub-merchant
A boolean value to indicate if payment response hash needs to be enabled
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a default value is used.
A boolean value to indicate if redirect to merchant with http post needs to be enabled
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
API key that will be used for server side API access
An identifier for the vault used to store payment method information.
Details about the primary business unit of the merchant account
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 frm routing algorithm to be used for routing payments to desired FRM's
The default business profile that must be used for creating merchant accounts and payments To unset this field, pass an empty string
Object for GenericLinkUiConfig
Merchant's display logo
Custom merchant name for the link
Primary color to be used in the form represented in hex format
Custom domain name to be used for hosting the link
List of payment methods shown on collect UI
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
An array of associated payment method types
ach
, affirm
, afterpay_clearpay
, alfamart
, ali_pay
, ali_pay_hk
, alma
, apple_pay
, atome
, bacs
, bancontact_card
, becs
, benefit
, bizum
, blik
, boleto
, bca_bank_transfer
, bni_va
, bri_va
, card_redirect
, cimb_va
, classic
, credit
, crypto_currency
, cashapp
, dana
, danamon_va
, debit
, duit_now
, efecty
, eps
, 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
, paypal
, pix
, pay_safe_card
, przelewy24
, prompt_pay
, pse
, red_compra
, red_pagos
, samsung_pay
, sepa
, sofort
, swish
, touch_n_go
, trustly
, twint
, upi_collect
, upi_intent
, vipps
, viet_qr
, venmo
, walley
, we_chat_pay
, seven_eleven
, lawson
, mini_stop
, family_mart
, seicomart
, pay_easy
, local_bank_transfer
, mifinity
Response
The identifier for the Merchant Account
Name of the Merchant Account
The URL to redirect after completion of the payment
A boolean value to indicate if payment response hash needs to be enabled
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a default value is used.
A boolean value to indicate if redirect to merchant with http post needs to be enabled
The merchant's primary contact name
The merchant's primary phone number
The merchant's primary email address
The merchant's secondary contact name
The merchant's secondary phone number
The merchant's secondary email address
The business website of the merchant
A brief description about merchant's business
Address details
The address city
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 address
The second line of the address
The third line of the address
The zip/postal code for the address
The address state
The first name for the address
The last name for the address
The version for Webhook
The user name for Webhook login
The password for Webhook login
The url for the webhook endpoint
If this property is true, a webhook message is posted whenever a new payment is created
If this property is true, a webhook message is posted whenever a payment is successful
If this property is true, a webhook message is posted whenever a payment fails
Routing Algorithm kind
single
Routable Connector chosen for a payment
Connectors eligible for payments routing
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
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.
Refers to the Parent Merchant ID if the merchant being created is a sub-merchant
API key that will be used for server side API access
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
An identifier for the vault used to store payment method information.
Details about the primary business unit of the merchant account
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
Routing Algorithm kind
single
Routable Connector chosen for a payment
Connectors eligible for payments routing
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
The organization id merchant is associated with
A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false
The default business profile that must be used for creating merchant accounts and payments
not_requested
, requested
, active
, disabled
Object for GenericLinkUiConfig
Merchant's display logo
Custom merchant name for the link
Primary color to be used in the form represented in hex format
Custom domain name to be used for hosting the link
List of payment methods shown on collect UI
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
An array of associated payment method types
ach
, affirm
, afterpay_clearpay
, alfamart
, ali_pay
, ali_pay_hk
, alma
, apple_pay
, atome
, bacs
, bancontact_card
, becs
, benefit
, bizum
, blik
, boleto
, bca_bank_transfer
, bni_va
, bri_va
, card_redirect
, cimb_va
, classic
, credit
, crypto_currency
, cashapp
, dana
, danamon_va
, debit
, duit_now
, efecty
, eps
, 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
, paypal
, pix
, pay_safe_card
, przelewy24
, prompt_pay
, pse
, red_compra
, red_pagos
, samsung_pay
, sepa
, sofort
, swish
, touch_n_go
, trustly
, twint
, upi_collect
, upi_intent
, vipps
, viet_qr
, venmo
, walley
, we_chat_pay
, seven_eleven
, lawson
, mini_stop
, family_mart
, seicomart
, pay_easy
, local_bank_transfer
, mifinity
curl --request POST \
--url https://sandbox.hyperswitch.io/accounts/{account_id} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"merchant_id": "merchant_abc",
"merchant_name": "merchant_name"
}'
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"enable_payment_response_hash": true,
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"redirect_to_merchant_with_http_post": true,
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "johndoe@test.com",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "johndoe2@test.com",
"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"
}
},
"webhook_details": {
"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_routing_algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": true,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "adyenplatform",
"merchant_connector_id": "<string>"
}
},
"organization_id": "<string>",
"is_recon_enabled": true,
"default_profile": "<string>",
"recon_status": "not_requested",
"pm_collect_link_config": {
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
}
}