v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Merchant Account

Merchant Account - Create

Create a new account for a merchant and the merchant could be a seller or retailer or client who likes to receive and send payments.

post/accounts

Request body

merchant_idstring required

The identifier for the Merchant Account

merchant_namestring nullable

Name of the Merchant Account

return_urlstring nullable

The URL to redirect after the completion of the operation

sub_merchants_enabledboolean nullable

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.

parent_merchant_idstring nullable

Refers to the Parent Merchant ID if the merchant being created is a sub-merchant

enable_payment_response_hashboolean nullable

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 nullable

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

publishable_keystring nullable

API key that will be used for client side API access. A publishable key has to be always paired with a client_secret. A client_secret can be obtained by creating a payment with confirm set to false

locker_idstring nullable

An identifier for the vault used to store payment method information.

frm_routing_algorithmobject nullable

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

organization_idstring nullable

The id of the organization to which the merchant belongs to, if not passed an organization is created

merchant_account_type'standard' | 'platform' | 'connected'

Response

Merchant Account Created

merchant_idstring required

The identifier for the Merchant Account

merchant_namestring nullable

Name of the Merchant Account

return_urlstring nullable

The URL to redirect after completion of the payment

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

sub_merchants_enabledboolean nullable

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.

parent_merchant_idstring nullable

Refers to the Parent Merchant ID if the merchant being created is a sub-merchant

publishable_keystring nullable

API key that will be used for server side API access

metadataobject nullable

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

locker_idstring nullable

An identifier for the vault used to store payment method information.

organization_idstring required

The organization id merchant is associated with

is_recon_enabledboolean required

A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false

default_profilestring nullable

The default profile that must be used for creating merchant accounts and payments

recon_status'not_requested' | 'requested' | 'active' | 'disabled' required

merchant_account_type'standard' | 'platform' | 'connected' required