Profile - Create

curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/profiles \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'api-key: <api-key>' \
  --data '{
  "profile_name": "shoe_business"
}'

{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "id": "pro_abcdefghijklmnopqrstuvwxyz",
  "profile_name": "<string>",
  "return_url": "https://www.example.com/success",
  "enable_payment_response_hash": true,
  "payment_response_hash_key": "<string>",
  "redirect_to_merchant_with_http_post": true,
  "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,
    "payment_statuses_enabled": [
      "succeeded",
      "failed",
      "partially_captured",
      "requires_merchant_action"
    ],
    "refund_statuses_enabled": [
      "success",
      "failure"
    ],
    "payout_statuses_enabled": [
      "success",
      "failed"
    ]
  },
  "metadata": {},
  "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": {}
      }
    ],
    "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>",
    "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>",
    "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_if_required": false,
  "collect_billing_details_from_wallet_connector_if_required": 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": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>",
    "allowed_domains": [
      "<string>"
    ],
    "form_layout": "tabs",
    "payout_test_mode": false
  },
  "outgoing_webhook_custom_http_headers": {},
  "order_fulfillment_time": 900,
  "order_fulfillment_time_origin": "create",
  "tax_connector_id": "<string>",
  "is_tax_connector_enabled": true,
  "is_network_tokenization_enabled": false,
  "should_collect_cvv_during_payment": true,
  "is_click_to_pay_enabled": false,
  "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
  },
  "is_clear_pan_retries_enabled": true,
  "is_debit_routing_enabled": true,
  "merchant_business_country": "AF",
  "is_iframe_redirection_enabled": false,
  "is_external_vault_enabled": true,
  "external_vault_connector_details": {
    "vault_connector_id": "<string>",
    "vault_sdk": "vgs_sdk"
  },
  "merchant_category_code": "5411",
  "merchant_country_code": "<string>",
  "split_txns_enabled": "enable",
  "revenue_recovery_retry_algorithm_type": "monitoring"
}

POST

profiles

Profile - Create

curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/profiles \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'api-key: <api-key>' \
  --data '{
  "profile_name": "shoe_business"
}'

{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "id": "pro_abcdefghijklmnopqrstuvwxyz",
  "profile_name": "<string>",
  "return_url": "https://www.example.com/success",
  "enable_payment_response_hash": true,
  "payment_response_hash_key": "<string>",
  "redirect_to_merchant_with_http_post": true,
  "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,
    "payment_statuses_enabled": [
      "succeeded",
      "failed",
      "partially_captured",
      "requires_merchant_action"
    ],
    "refund_statuses_enabled": [
      "success",
      "failure"
    ],
    "payout_statuses_enabled": [
      "success",
      "failed"
    ]
  },
  "metadata": {},
  "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": {}
      }
    ],
    "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>",
    "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>",
    "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_if_required": false,
  "collect_billing_details_from_wallet_connector_if_required": 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": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>",
    "allowed_domains": [
      "<string>"
    ],
    "form_layout": "tabs",
    "payout_test_mode": false
  },
  "outgoing_webhook_custom_http_headers": {},
  "order_fulfillment_time": 900,
  "order_fulfillment_time_origin": "create",
  "tax_connector_id": "<string>",
  "is_tax_connector_enabled": true,
  "is_network_tokenization_enabled": false,
  "should_collect_cvv_during_payment": true,
  "is_click_to_pay_enabled": false,
  "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
  },
  "is_clear_pan_retries_enabled": true,
  "is_debit_routing_enabled": true,
  "merchant_business_country": "AF",
  "is_iframe_redirection_enabled": false,
  "is_external_vault_enabled": true,
  "external_vault_connector_details": {
    "vault_connector_id": "<string>",
    "vault_sdk": "vgs_sdk"
  },
  "merchant_category_code": "5411",
  "merchant_country_code": "<string>",
  "split_txns_enabled": "enable",
  "revenue_recovery_retry_algorithm_type": "monitoring"
}

Authorizations

api-key

string

header

required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

Headers

X-Merchant-Id

string

required

Merchant ID of the profile.

Body

application/json

profile_name

string

required

The name of profile

Maximum length: 64

return_url

string | null

The URL to redirect after the completion of the operation

Maximum length: 255

Example:

"https://www.example.com/success"

enable_payment_response_hash

boolean | null

default:true

A boolean value to indicate if payment response hash needs to be enabled

Example:

true

payment_response_hash_key

string | null

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.

redirect_to_merchant_with_http_post

boolean | null

default:false

A boolean value to indicate if redirect to merchant with http post needs to be enabled

Example:

true

webhook_details

object

Show child attributes

metadata

object | null

Metadata is useful for storing additional, unstructured information on an object.

order_fulfillment_time

integer | null

Will be used to determine the time till which your payment will be active once the payment session starts

Required range: x >= 0

Example:

900

order_fulfillment_time_origin

enum<string>

Available options:

create,

confirm

applepay_verified_domains

string[] | null

Verified Apple Pay domains for a particular profile

session_expiry

integer | null

Client Secret Default expiry for all payments created under this profile

Required range: x >= 0

Example:

900

payment_link_config

object

Show child attributes

authentication_connector_details

object

Show child attributes

use_billing_as_payment_method_billing

boolean | null

Whether to use the billing details passed when creating the intent as payment method billing

collect_shipping_details_from_wallet_connector_if_required

boolean | null

default:false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

collect_billing_details_from_wallet_connector_if_required

boolean | null

default:false

A boolean value to indicate if customer billing details needs to be collected from wallet connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

always_collect_shipping_details_from_wallet_connector

boolean | null

default:false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

always_collect_billing_details_from_wallet_connector

boolean | null

default:false

A boolean value to indicate if customer billing details needs to be collected from wallet connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

is_connector_agnostic_mit_enabled

boolean | null

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.

payout_link_config

object

Object for GenericLinkUiConfig

Show child attributes

outgoing_webhook_custom_http_headers

object | null

These key-value pairs are sent as additional custom headers in the outgoing webhook request. It is recommended not to use more than four key-value pairs.

tax_connector_id

string | null

Merchant Connector id to be stored for tax_calculator connector

is_tax_connector_enabled

boolean

Indicates if tax_calculator connector is enabled or not. If set to true tax_connector_id will be checked.

is_network_tokenization_enabled

boolean

Indicates if network tokenization is enabled or not.

is_click_to_pay_enabled

boolean

default:false

Indicates if click to pay is enabled or not.

Example:

false

authentication_product_ids

object | null

Product authentication ids

card_testing_guard_config

object

Show child attributes

is_clear_pan_retries_enabled

boolean | null

Indicates if clear pan retries is enabled or not.

is_debit_routing_enabled

boolean | null

Indicates if debit routing is enabled or not

merchant_business_country

enum<string>

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

is_iframe_redirection_enabled

boolean | null

Indicates if the redirection has to open in the iframe

Example:

false

is_external_vault_enabled

boolean | null

Indicates if external vault is enabled or not.

external_vault_connector_details

object

Show child attributes

merchant_category_code

enum<string>

Available options:

5411,

7011,

0763,

8111,

5021,

4816,

5661

merchant_country_code

string

A wrapper type for merchant country codes that provides validation and conversion functionality.

This type stores a country code as a string and provides methods to validate it and convert it to a Country enum variant.

split_txns_enabled

enum<string>

default:skip

Available options:

enable,

skip

Response

Account Created

merchant_id

string

required

The identifier for Merchant Account

Maximum length: 64

Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

string

required

The identifier for profile. This must be used for creating merchant accounts, payments and payouts

Maximum length: 64

Example:

"pro_abcdefghijklmnopqrstuvwxyz"

profile_name

string

required

Name of the profile

Maximum length: 64

enable_payment_response_hash

boolean

default:true

required

A boolean value to indicate if payment response hash needs to be enabled

Example:

true

redirect_to_merchant_with_http_post

boolean

default:false

required

A boolean value to indicate if redirect to merchant with http post needs to be enabled

Example:

true

is_tax_connector_enabled

boolean

required

Indicates if tax_calculator connector is enabled or not. If set to true tax_connector_id will be checked.

is_network_tokenization_enabled

boolean

default:false

required

Indicates if network tokenization is enabled or not.

Example:

false

is_click_to_pay_enabled

boolean

default:false

required

Indicates if click to pay is enabled or not.

Example:

false

is_clear_pan_retries_enabled

boolean

required

Indicates if clear pan retries is enabled or not.

split_txns_enabled

enum<string>

default:skip

required

Available options:

enable,

skip

return_url

string | null

The URL to redirect after the completion of the operation

Maximum length: 255

Example:

"https://www.example.com/success"

payment_response_hash_key

string | null

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.

webhook_details

object

Show child attributes

metadata

object | null

Metadata is useful for storing additional, unstructured information on an object.

applepay_verified_domains

string[] | null

Verified Apple Pay domains for a particular profile

session_expiry

integer | null

Client Secret Default expiry for all payments created under this profile

Example:

900

payment_link_config

object

Show child attributes

authentication_connector_details

object

Show child attributes

use_billing_as_payment_method_billing

boolean | null

extended_card_info_config

object

Show child attributes

collect_shipping_details_from_wallet_connector_if_required

boolean | null

default:false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

collect_billing_details_from_wallet_connector_if_required

boolean | null

default:false

A boolean value to indicate if customer billing details needs to be collected from wallet connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

always_collect_shipping_details_from_wallet_connector

boolean | null

default:false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

always_collect_billing_details_from_wallet_connector

boolean | null

default:false

A boolean value to indicate if customer billing details needs to be collected from wallet connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

is_connector_agnostic_mit_enabled

boolean | null

payout_link_config

object

Object for GenericLinkUiConfig

Show child attributes

outgoing_webhook_custom_http_headers

object | null

These key-value pairs are sent as additional custom headers in the outgoing webhook request.

order_fulfillment_time

integer | null

Will be used to determine the time till which your payment will be active once the payment session starts

Required range: x >= 0

Example:

900

order_fulfillment_time_origin

enum<string>

Available options:

create,

confirm

tax_connector_id

string | null

Merchant Connector id to be stored for tax_calculator connector

should_collect_cvv_during_payment

boolean | null

Indicates if CVV should be collected during payment or not.

authentication_product_ids

object | null

Product authentication ids

card_testing_guard_config

object

Show child attributes

is_debit_routing_enabled

boolean | null

Indicates if debit routing is enabled or not

merchant_business_country

enum<string>

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

is_iframe_redirection_enabled

boolean | null

Indicates if the redirection has to open in the iframe

Example:

false

is_external_vault_enabled

boolean | null

Indicates if external vault is enabled or not.

external_vault_connector_details

object

Show child attributes

merchant_category_code

enum<string>

Available options:

5411,

7011,

0763,

8111,

5021,

4816,

5661

merchant_country_code

string

A wrapper type for merchant country codes that provides validation and conversion functionality.

This type stores a country code as a string and provides methods to validate it and convert it to a Country enum variant.

revenue_recovery_retry_algorithm_type

enum<string>

Available options:

monitoring,

smart,

cascading

Merchant Account - Profile List Profile - Update

Get Started [BETA]

Essentials [BETA]

Payments Core APIs [BETA]

Account management APIs [BETA]

Other APIs [BETA]

Profile - Create

Authorizations

Headers

Body

Response