Merchant Connector - Retrieve

GET

accounts

{account_id}

connectors

{connector_id}

Authorizations

api-key

string

header

required

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

Path Parameters

account_id

string

required

The unique identifier for the merchant account

connector_id

integer

required

The unique identifier for the Merchant Connector

Response

200 - application/json

Response of creating a new Merchant Connector for the merchant account."

connector_name

enum<string>

required

Available options:

adyenplatform,

phonypay,

fauxpay,

pretendpay,

stripe_test,

adyen_test,

checkout_test,

paypal_test,

aci,

adyen,

airwallex,

authorizedotnet,

bambora,

bamboraapac,

bankofamerica,

billwerk,

bitpay,

bluesnap,

boku,

braintree,

cashtocode,

checkout,

coinbase,

cryptopay,

ctp_mastercard,

cybersource,

datatrans,

deutschebank,

digitalvirgo,

dlocal,

ebanx,

elavon,

fiserv,

fiservemea,

fiuu,

forte,

globalpay,

globepay,

gocardless,

gpayments,

helcim,

iatapay,

itaubank,

jpmorgan,

klarna,

mifinity,

mollie,

multisafepay,

netcetera,

nexinets,

nexixpay,

nmi,

noon,

novalnet,

nuvei,

opennode,

paybox,

payme,

payone,

paypal,

payu,

placetopay,

powertranz,

prophetpay,

rapyd,

razorpay,

shift4,

square,

stax,

stripe,

taxjar,

threedsecureio,

trustpay,

tsys,

volt,

wellsfargo,

wise,

worldline,

worldpay,

signifyd,

plaid,

riskified,

zen,

zsl

connector_type

enum<string>

required

Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.

Available options:

payment_processor,

payment_vas,

fin_operations,

fiz_operations,

networks,

banking_entities,

non_banking_finance,

payout_processor,

payment_method_auth,

authentication_processor,

tax_processor

merchant_connector_id

string

required

Unique ID of the merchant connector account

profile_id

string

required

Identifier for the profile, if not provided default will be chosen from merchant account

Maximum length: 64

status

enum<string>

required

Available options:

inactive,

active

additional_merchant_data

object

applepay_verified_domains

string[] | null

identifier for the verified domains of a particular connector account

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

business_label

string | null

The business label to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead

business_sub_label

string | null

The business sublabel to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead

connector_account_details

object

connector_label

string | null

A unique label to identify the connector account created under a profile

connector_wallets_details

object

connector_webhook_details

object

disabled

boolean | null

default:

false

A boolean value to indicate if the connector is disabled. By default, its value is false.

frm_configs

object[] | null

Contains the frm configs for the merchant connector

frm_configs.gateway

enum<string>

required

Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.

Available options:

payment_processor,

payment_vas,

fin_operations,

fiz_operations,

networks,

banking_entities,

non_banking_finance,

payout_processor,

payment_method_auth,

authentication_processor,

tax_processor

frm_configs.payment_methods

object[]

required

payment methods that can be used in the payment

frm_configs.payment_methods.payment_method

enum<string>

required

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options:

card,

card_redirect,

pay_later,

wallet,

bank_redirect,

bank_transfer,

crypto,

bank_debit,

reward,

real_time_payment,

upi,

voucher,

gift_card,

open_banking,

mobile_payment

frm_configs.payment_methods.flow

enum<string>

Available options:

pre,

post

frm_configs.payment_methods.payment_method_types

object[] | null

payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility.

metadata

object | null

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

payment_methods_enabled

object[] | null

An object containing the details about the payment methods that need to be enabled under this merchant connector account

payment_methods_enabled.payment_method

enum<string>

required

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options:

card,

card_redirect,

pay_later,

wallet,

bank_redirect,

bank_transfer,

crypto,

bank_debit,

reward,

real_time_payment,

upi,

voucher,

gift_card,

open_banking,

mobile_payment

payment_methods_enabled.payment_method_types

object[] | null

Subtype of payment method

payment_methods_enabled.payment_method_types.installment_payment_enabled

boolean

default:

true

required

Boolean to enable installment / EMI / BNPL payments. Default is true.

payment_methods_enabled.payment_method_types.payment_method_type

enum<string>

required

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options:

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,

paze,

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,

open_banking_pis,

direct_carrier_billing

payment_methods_enabled.payment_method_types.recurring_enabled

boolean

default:

true

required

Boolean to enable recurring payments / mandates. Default is true.

payment_methods_enabled.payment_method_types.accepted_countries

object

Object to filter the customer countries for which the payment method is displayed

payment_methods_enabled.payment_method_types.accepted_currencies

object

payment_methods_enabled.payment_method_types.card_networks

enum<string>[] | null

Available options:

Visa,

Mastercard,

AmericanExpress,

JCB,

DinersClub,

Discover,

CartesBancaires,

UnionPay,

Interac,

RuPay,

Maestro

payment_methods_enabled.payment_method_types.maximum_amount

integer

This Unit struct represents MinorUnit in which core amount works

payment_methods_enabled.payment_method_types.minimum_amount

integer

This Unit struct represents MinorUnit in which core amount works

payment_methods_enabled.payment_method_types.payment_experience

enum<string>

To indicate the type of payment experience that the customer would go through

Available options:

redirect_to_url,

invoke_sdk_client,

display_qr_code,

one_click,

link_wallet,

invoke_payment_app,

display_wait_screen,

collect_otp

pm_auth_config

object | null

test_mode

boolean | null

default:

false

A boolean value to indicate if the connector is in Test mode. By default, its value is false.

Merchant Connector - Create Merchant Connector - Update

Payments

Payment Methods

Customers

Mandates

Refunds

Disputes

Organization

Merchant Account

Business Profile

API Key

Merchant Connector Account

Payouts

Event

GSM (Global Status Mapping)

Poll

Blocklist

Routing

Relay

Schemas

Merchant Connector - Retrieve

Authorizations

Path Parameters

Response