Skip to main content
GET
Profile - Connector Accounts List

Authorizations

Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Headers

X-Merchant-Id
string
required

Merchant ID of the profile.

X-Profile-Id
string
required

Authenticated business profile. Must match the profile ID in the path.

Path Parameters

id
string
required

The unique identifier for the business profile

Response

Merchant Connector list retrieved successfully

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,
surcharge_processor,
billing_processor,
vault_processor
connector_name
enum<string>
required
Available options:
absa_sanlam,
authipay,
adyenplatform,
stripe_billing_test,
phonypay,
fauxpay,
pretendpay,
stripe_test,
adyen_test,
checkout_test,
paypal_test,
aci,
adyen,
affirm,
airwallex,
amazonpay,
archipel,
authorizedotnet,
bambora,
bamboraapac,
bankofamerica,
barclaycard,
betterpayment,
billwerk,
bitpay,
bluesnap,
blackhawknetwork,
calida,
boku,
braintree,
breadpay,
cardinal,
cashtocode,
celero,
chargebee,
checkbook,
checkout,
citigate,
coinbase,
coingate,
custombilling,
cryptopay,
ctp_mastercard,
ctp_visa,
cybersource,
cybersourcedecisionmanager,
d24,
datatrans,
deutschebank,
digitalvirgo,
dlocal,
dwolla,
ebanx,
ecommpay,
envoy,
elavon,
etisalat,
elavon_pg,
facilitapay,
finix,
fiserv,
fiservemea,
fiservcommercehub,
fiuu,
flexiti,
forte,
getnet,
gigadat,
givepayments,
globalpay,
globalpayments_heartland,
globalpayments_realex,
globepay,
gocardless,
gotyme_sanlam,
gpayments,
hipay,
helcim,
hyperpg,
hyperswitch_vault,
interpayments,
inespay,
iatapay,
ilixium,
imerchantsolutions,
itaubank,
jpmorgan,
jpmorgan_orbital,
juspay,
juspaythreedsserver,
klarna,
loonio,
merchante,
mifinity,
mollie,
moneris,
multisafepay,
netcetera,
nexinets,
nexixpay,
nmi,
nomupay,
noon,
nordea,
novalnet,
nuvei,
opennode,
paybox,
paydotcom,
payhound,
payload,
payme,
paynearme,
payone,
paypal,
paysafe,
paystack,
paytm,
payconex,
payu,
peachpayments,
payjustnow,
payjustnowinstore,
phonepe,
placetopay,
powertranz,
prophetpay,
rapyd,
razorpay,
recurly,
redsys,
revolv3,
saferpay,
santander,
shift4,
silverflow,
square,
stax,
stripe,
stripebilling,
taxjar,
threedsecureio,
tesouro,
tokenex,
tokenio,
trustly,
truelayer,
trustpay,
trustpayments,
tsys,
tsys_transit,
vgs,
volt,
wellsfargo,
wise,
worldline,
worldpay,
worldpayraft,
worldpayvantiv,
worldpayxml,
worldpaymodular,
signifyd,
nsure,
plaid,
riskified,
sanlam_payshield,
xendit,
zen,
zift,
zsl
id
string
required

Unique ID of the merchant connector account

Example:

"mca_5apGeP94tMts6rg3U3kR"

profile_id
string
required

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

Maximum string length: 64
payment_methods_enabled
object[]
required

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

status
enum<string>
required
Available options:
inactive,
active
connector_label
string | null

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

Example:

"stripe_US_travel"

connector_account_details
object | null
connector_webhook_details
object | null
metadata
object | null

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

disabled
boolean | null
default:false

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

Example:

false

frm_configs
object[] | null

Contains the frm configs for the merchant connector

Example:

"\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n"

applepay_verified_domains
string[] | null

identifier for the verified domains of a particular connector account

pm_auth_config
object | null

pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt

additional_merchant_data
object | null
connector_wallets_details
object | null
feature_metadata
object | null

Feature metadata for merchant connector account