v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Profile

Profile - Retrieve

Retrieve existing profile

get/account/{account_id}/business_profile/{profile_id}

Path parameters

account_idstring required

The unique identifier for the merchant account

profile_idstring required

The unique identifier for the profile

Response

Profile Updated

merchant_idstring required

The identifier for Merchant Account

profile_idstring required

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

profile_namestring required

Name of the profile

return_urlstring nullable

The URL to redirect after the completion of the operation

enable_payment_response_hashboolean required

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

payment_response_hash_keystring nullable

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_postboolean required

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

metadataobject nullable

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

routing_algorithmobject nullable

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

intent_fulfillment_timeinteger nullable

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

frm_routing_algorithmobject nullable

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

applepay_verified_domainsstring[] nullable

Verified Apple Pay domains for a particular profile

session_expiryinteger nullable

Client Secret Default expiry for all payments created under this profile

use_billing_as_payment_method_billingboolean nullable

collect_shipping_details_from_wallet_connectorboolean nullable

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)

collect_billing_details_from_wallet_connectorboolean nullable

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)

always_collect_shipping_details_from_wallet_connectorboolean nullable

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)

always_collect_billing_details_from_wallet_connectorboolean nullable

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)

is_connector_agnostic_mit_enabledboolean nullable

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.

outgoing_webhook_custom_http_headersobject nullable

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

tax_connector_idstring nullable

Merchant Connector id to be stored for tax_calculator connector

is_tax_connector_enabledboolean required

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

is_network_tokenization_enabledboolean required

Indicates if network tokenization is enabled or not.

is_auto_retries_enabledboolean required

Indicates if is_auto_retries_enabled is enabled or not.

max_auto_retries_enabledinteger nullable

Maximum number of auto retries allowed for a payment

always_request_extended_authorizationboolean nullable

Bool indicating if extended authentication must be requested for all payments

is_click_to_pay_enabledboolean required

Indicates if click to pay is enabled or not.

authentication_product_idsobject nullable

Product authentication ids

is_clear_pan_retries_enabledboolean required

Indicates if clear pan retries is enabled or not.

force_3ds_challengeboolean required

Indicates if 3ds challenge is forced

is_debit_routing_enabledboolean nullable

Indicates if debit routing is enabled or not

merchant_business_country'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_pre_network_tokenization_enabledboolean required

Indicates if pre network tokenization is enabled or not

is_iframe_redirection_enabledboolean nullable

Indicates if the redirection has to open in the iframe

merchant_category_codestring

merchant_country_codestring

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_intervalinteger nullable

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

is_manual_retry_enabledboolean nullable

Indicates if manual retry for payment is enabled or not

always_enable_overcaptureboolean nullable

Bool indicating if overcapture must be requested for all payments

is_external_vault_enabled'enable' | 'skip'

billing_processor_idstring nullable

Merchant Connector id to be stored for billing_processor connector

is_l2_l3_enabledboolean nullable

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