Organization - Merchant Account - List

List merchant accounts for an Organization

GET /v2/organizations/{id}/merchant-accounts

Try it

Organization - Merchant Account - List

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/organizations/{id}/merchant-accounts \
  --header 'api-key: <api-key>'

200

[
  {
    "id": "y3oqhf46pyzuxjbcn2giaqnb44",
    "merchant_name": "NewAge Retailer",
    "publishable_key": "AH3423bkjbkjdsfbkj",
    "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
    "recon_status": "not_requested",
    "merchant_details": {
      "primary_contact_person": "John Doe",
      "primary_phone": "999999999",
      "primary_email": "[e-mail]",
      "secondary_contact_person": "John Doe2",
      "secondary_phone": "999999988",
      "secondary_email": "[e-mail]",
      "website": "www.example.com",
      "about_business": "Online Retail with a wide selection of organic products for North America",
      "address": {
        "city": "New York",
        "country": "AF",
        "line1": "123, King Street",
        "line2": "Powelson Avenue",
        "line3": "Bridgewater",
        "zip": "08807",
        "state": "New York",
        "first_name": "John",
        "last_name": "Doe",
        "origin_zip": "08807"
      },
      "merchant_tax_registration_id": "123456789"
    },
    "metadata": {},
    "product_type": "orchestration"
  }
]

Authorizations

api-key · string · header · required

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

Path Parameters

id · string · required

The unique identifier for the Organization

Response

200

application/json

Merchant Account list retrieved successfully

id · string · required

The identifier for the Merchant Account

Maximum string length: 64

Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

merchant_name · string · required

Name of the Merchant Account

Example:

"NewAge Retailer"

publishable_key · string · required

API key that will be used for server side API access

Example:

"AH3423bkjbkjdsfbkj"

organization_id · string · required

The id of the organization which the merchant is associated with

Required string length: 1 - 64

Example:

"org_q98uSGAYbjEwqs0mJwnz"

recon_status · enum<string> · required

Available options: not_requested, requested, active, disabled

merchant_details · object

Show child attributes

merchant_details. primary_contact_person · string | null

The merchant's primary contact name

Maximum string length: 255

Example:

"John Doe"

merchant_details. primary_phone · string | null

The merchant's primary phone number

Maximum string length: 255

Example:

"999999999"

merchant_details. primary_email · string | null

The merchant's primary email address

Maximum string length: 255

Example:

"[e-mail]"

merchant_details. secondary_contact_person · string | null

The merchant's secondary contact name

Maximum string length: 255

Example:

"John Doe2"

merchant_details. secondary_phone · string | null

The merchant's secondary phone number

Maximum string length: 255

Example:

"999999988"

merchant_details. secondary_email · string | null

The merchant's secondary email address

Maximum string length: 255

Example:

"[e-mail]"

merchant_details. website · string | null

The business website of the merchant

Maximum string length: 255

Example:

"www.example.com"

merchant_details. about_business · string | null

A brief description about merchant's business

Maximum string length: 255

Example:

"Online Retail with a wide selection of organic products for North America"

merchant_details. address · object

Address details

Show child attributes

merchant_details.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

merchant_details.address. 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

merchant_details.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

merchant_details.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

merchant_details.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

merchant_details.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

merchant_details.address. state · string | null

The address state

Example:

"New York"

merchant_details.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

merchant_details.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

merchant_details.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

merchant_details. merchant_tax_registration_id · string | null

Example:

"123456789"

metadata · object

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

product_type · enum<string>

Available options: orchestration, vault, recon, recovery, cost_observability, dynamic_routing