Skip to main content
GET
/
v2
/
connector-accounts
/
{id}
Connector Account - Retrieve
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/connector-accounts/{id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://sandbox.hyperswitch.io/v2/connector-accounts/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/v2/connector-accounts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/v2/connector-accounts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sandbox.hyperswitch.io/v2/connector-accounts/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/v2/connector-accounts/{id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/v2/connector-accounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "<string>",
  "payment_methods_enabled": [
    {
      "payment_method_subtypes": [
        {
          "card_networks": [],
          "accepted_currencies": {
            "type": "enable_only",
            "list": []
          },
          "accepted_countries": {
            "type": "enable_only",
            "list": []
          },
          "minimum_amount": 123,
          "maximum_amount": 123,
          "recurring_enabled": false,
          "installment_payment_enabled": true
        }
      ]
    }
  ],
  "connector_label": "stripe_US_travel",
  "connector_account_details": {
    "connector_account_details": {},
    "metadata": {}
  },
  "connector_webhook_details": {
    "merchant_secret": "12345678900987654321",
    "additional_secret": "12345678900987654321"
  },
  "metadata": {},
  "disabled": false,
  "frm_configs": "\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>"
  ],
  "pm_auth_config": {},
  "additional_merchant_data": {
    "open_banking_recipient_data": {
      "connector_recipient_id": "<string>"
    }
  },
  "connector_wallets_details": {
    "apple_pay_combined": {},
    "apple_pay": {},
    "amazon_pay": {},
    "samsung_pay": {},
    "paze": {},
    "google_pay": {}
  },
  "feature_metadata": {
    "revenue_recovery": {
      "max_retry_count": "15",
      "billing_connector_retry_threshold": "10",
      "billing_account_reference": "{ \"mca_vDSg5z6AxnisHq5dbJ6g\": \"stripe_123\", \"mca_vDSg5z6AumisHqh4x5m1\": \"adyen_123\" }"
    }
  }
}

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.

Path Parameters

id
integer<int32>
required

The unique identifier for the Merchant Connector

Response

Merchant Connector retrieved successfully

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

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,
billwerk,
bitpay,
bluesnap,
blackhawknetwork,
calida,
boku,
braintree,
breadpay,
cardinal,
cashtocode,
celero,
chargebee,
checkbook,
checkout,
coinbase,
coingate,
custombilling,
cryptopay,
ctp_mastercard,
ctp_visa,
cybersource,
cybersourcedecisionmanager,
datatrans,
deutschebank,
digitalvirgo,
dlocal,
dwolla,
ebanx,
envoy,
elavon,
facilitapay,
finix,
fiserv,
fiservemea,
fiservcommercehub,
fiuu,
flexiti,
forte,
getnet,
gigadat,
globalpay,
globepay,
gocardless,
gpayments,
hipay,
helcim,
hyperpg,
hyperswitch_vault,
interpayments,
inespay,
iatapay,
imerchantsolutions,
itaubank,
jpmorgan,
juspaythreedsserver,
klarna,
loonio,
mifinity,
mollie,
moneris,
multisafepay,
netcetera,
nexinets,
nexixpay,
nmi,
nomupay,
noon,
nordea,
novalnet,
nuvei,
opennode,
paybox,
payload,
payme,
payone,
paypal,
paysafe,
paystack,
paytm,
payconex,
payu,
peachpayments,
payjustnow,
payjustnowinstore,
phonepe,
placetopay,
powertranz,
prophetpay,
rapyd,
razorpay,
recurly,
redsys,
revolv3,
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,
worldpayvantiv,
worldpayxml,
worldpaymodular,
signifyd,
plaid,
riskified,
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