Profile - Create

curl --request POST \
  --url https://sandbox.birrpay.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": "<string>",
  "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"
    ]
  },
  "metadata": {},
  "routing_algorithm": {},
  "intent_fulfillment_time": 900,
  "frm_routing_algorithm": {},
  "payout_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "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://birrpay.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>",
    "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://birrpay.io/favicon.ico",
    "merchant_name": "BirrPay",
    "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
  },
  "is_debit_routing_enabled": true,
  "merchant_business_country": "AF",
  "acquirer_configs": [
    {
      "profile_acquirer_id": "pro_acq_LCRdERuylQvNQ4qh3QE0",
      "acquirer_assigned_merchant_id": "M123456789",
      "merchant_name": "NewAge Retailer",
      "network": "VISA",
      "acquirer_bin": "456789",
      "acquirer_fraud_rate": 0.01,
      "profile_id": "pro_ky0yNyOXXlA5hF8JzE5q",
      "acquirer_ica": "401288"
    }
  ],
  "is_iframe_redirection_enabled": false,
  "merchant_category_code": "5411",
  "merchant_country_code": "<string>",
  "dispute_polling_interval": 2,
  "is_manual_retry_enabled": 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>",
  "is_l2_l3_enabled": true
}

POST

account

{account_id}

business_profile

curl --request POST \
  --url https://sandbox.birrpay.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": "<string>",
  "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"
    ]
  },
  "metadata": {},
  "routing_algorithm": {},
  "intent_fulfillment_time": 900,
  "frm_routing_algorithm": {},
  "payout_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "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://birrpay.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>",
    "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://birrpay.io/favicon.ico",
    "merchant_name": "BirrPay",
    "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
  },
  "is_debit_routing_enabled": true,
  "merchant_business_country": "AF",
  "acquirer_configs": [
    {
      "profile_acquirer_id": "pro_acq_LCRdERuylQvNQ4qh3QE0",
      "acquirer_assigned_merchant_id": "M123456789",
      "merchant_name": "NewAge Retailer",
      "network": "VISA",
      "acquirer_bin": "456789",
      "acquirer_fraud_rate": 0.01,
      "profile_id": "pro_ky0yNyOXXlA5hF8JzE5q",
      "acquirer_ica": "401288"
    }
  ],
  "is_iframe_redirection_enabled": false,
  "merchant_category_code": "5411",
  "merchant_country_code": "<string>",
  "dispute_polling_interval": 2,
  "is_manual_retry_enabled": 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>",
  "is_l2_l3_enabled": true
}

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.

Path Parameters

account_id

string

required

The unique identifier for the merchant account

Body

application/json

profile_name

string | null

The name of profile

Maximum string length: 64

return_url

string | null

The URL to redirect after the completion of the operation

Maximum string 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 | null

Show child attributes

metadata

object | null

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

routing_algorithm

object | null

The routing algorithm to be used for routing payments to desired connectors

intent_fulfillment_time

integer<int32> | 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

frm_routing_algorithm

object | null

The frm routing algorithm to be used for routing payments to desired FRM's

payout_routing_algorithm

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

applepay_verified_domains

string[] | null

Verified Apple Pay domains for a particular profile

session_expiry

integer<int32> | null

Client Secret Default expiry for all payments created under this profile

Required range: x >= 0

Example:

900

payment_link_config

object | null

Show child attributes

authentication_connector_details

object | null

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

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

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 | null

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_auto_retries_enabled

boolean | null

Indicates if is_auto_retries_enabled is enabled or not.

max_auto_retries_enabled

integer<int32> | null

Maximum number of auto retries allowed for a payment

Required range: x >= 0

always_request_extended_authorization

boolean | null

Bool indicating if extended authentication must be requested for all payments

is_click_to_pay_enabled

boolean

Indicates if click to pay is enabled or not.

authentication_product_ids

object | null

Product authentication ids

card_testing_guard_config

object | null

Show child attributes

is_clear_pan_retries_enabled

boolean | null

Indicates if clear pan retries is enabled or not.

force_3ds_challenge

boolean | null

Indicates if 3ds challenge is forced

is_debit_routing_enabled

boolean | null

Indicates if debit routing is enabled or not

merchant_business_country

enum<string> | null

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_pre_network_tokenization_enabled

boolean | null

Indicates if pre network tokenization is enabled or not

merchant_category_code

string | null

Example:

"5411"

merchant_country_code

string | null

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.

dispute_polling_interval

integer<int32> | null

Time interval (in hours) for polling the connector to check for new disputes

Example:

2

is_manual_retry_enabled

boolean | null

Indicates if manual retry for payment is enabled or not

always_enable_overcapture

boolean | null

Bool indicating if overcapture must be requested for all payments

is_external_vault_enabled

enum<string> | null

Available options:

enable,

skip

external_vault_connector_details

object | null

Show child attributes

billing_processor_id

string | null

Merchant Connector id to be stored for billing_processor connector

is_l2_l3_enabled

boolean | null

Flag to enable Level 2 and Level 3 processing data for card transactions

Response

Profile Created

merchant_id

string

required

The identifier for Merchant Account

Maximum string length: 64

Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

profile_id

string

required

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

Maximum string length: 64

Example:

"pro_abcdefghijklmnopqrstuvwxyz"

profile_name

string

required

Name of the profile

Maximum string 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_auto_retries_enabled

boolean

default:false

required

Indicates if is_auto_retries_enabled 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.

force_3ds_challenge

boolean

required

Indicates if 3ds challenge is forced

is_pre_network_tokenization_enabled

boolean

default:false

required

Indicates if pre network tokenization is enabled or not

Example:

false

return_url

string | null

The URL to redirect after the completion of the operation

Maximum string 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 | null

Show child attributes

metadata

object | null

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

routing_algorithm

object | null

The routing algorithm to be used for routing payments to desired connectors

intent_fulfillment_time

integer<int64> | null

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

Example:

900

frm_routing_algorithm

object | null

The routing algorithm to be used to process the incoming request from merchant to outgoing payment processor or payment method. The default is 'Custom'

payout_routing_algorithm

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

applepay_verified_domains

string[] | null

Verified Apple Pay domains for a particular profile

session_expiry

integer<int64> | null

Client Secret Default expiry for all payments created under this profile

Example:

900

payment_link_config

object | null

Show child attributes

authentication_connector_details

object | null

Show child attributes

use_billing_as_payment_method_billing

boolean | null

extended_card_info_config

object | null

Show child attributes

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 only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

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 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 | null

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.

tax_connector_id

string | null

Merchant Connector id to be stored for tax_calculator connector

max_auto_retries_enabled

integer<int32> | null

Maximum number of auto retries allowed for a payment

always_request_extended_authorization

boolean | null

Bool indicating if extended authentication must be requested for all payments

authentication_product_ids

object | null

Product authentication ids

card_testing_guard_config

object | null

Show child attributes

is_debit_routing_enabled

boolean | null

Indicates if debit routing is enabled or not

merchant_business_country

enum<string> | null

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

acquirer_configs

object[] | null

Acquirer configs

Show child attributes

is_iframe_redirection_enabled

boolean | null

Indicates if the redirection has to open in the iframe

Example:

false

merchant_category_code

string | null

Example:

"5411"

merchant_country_code

string | null

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.

dispute_polling_interval

integer<int32> | null

Time interval (in hours) for polling the connector to check dispute statuses

Required range: x >= 0

Example:

2

is_manual_retry_enabled

boolean | null

Indicates if manual retry for payment is enabled or not

always_enable_overcapture

boolean | null

Bool indicating if overcapture must be requested for all payments

is_external_vault_enabled

enum<string> | null

Available options:

enable,

skip

external_vault_connector_details

object | null

Show child attributes

billing_processor_id

string | null

Merchant Connector id to be stored for billing_processor connector

is_l2_l3_enabled

boolean | null

Flag to enable Level 2 and Level 3 processing data for card transactions

Get Started

Essentials

Payments Core APIs

Account management APIs

Other APIs

Profile - Create

Authorizations

Path Parameters

Body

Response