Organization - Merchant Account - List

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

Retrieve the list of Merchant Accounts for an Organization.

Example cURL

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

Example response (200)

application/json
[
  {
    "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": "[email protected]",
      "secondary_contact_person": "John Doe2",
      "secondary_phone": "999999988",
      "secondary_email": "[email protected]",
      "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 (header, required) — string

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

Response fields:

  • 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, required) Available options: not_requested, requested, active, disabled

  • merchant_details (object) See nested attributes in the example response (primary/secondary contact info, website, about_business, address, merchant_tax_registration_id)

  • metadata (object) Metadata is useful for storing additional, unstructured information on an object.

  • product_type (enum) Available options: orchestration, vault, recon, recovery, cost_observability, dynamic_routing

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/organization/organization--merchant-account--list.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/organization/organization--merchant-account--list

Related:

  • Organization - Update: https://api-reference.hyperswitch.io/v2/organization/organization--update

  • Merchant Account - Create: https://api-reference.hyperswitch.io/v2/merchant-account/merchant-account--create

PreviousRouting - Activate configNextGsm - Update