GET

Get merchant details

https://api.kustom.co/accountmanagement/v1/merchants/{merchantId}

Retrieves full details for a given merchant, including status, business information, store information, bank accounts, and settlement schedule.

Parameters1 field

merchantIdstringrequiredin path
The unique Kustom merchant identifier (e.g. A100001).

200

Response99 fields

Merchant details returned successfully.

merchant_idstringoptional
emailstringoptional
phonestringoptional
typestringoptional
countrystringoptional
business_informationobjectoptional
Business information in response payloads.
47 fields in business_information
- organization_is_registeredbooleanoptional
- organization_entity_typestringoptional
- organization_namestringoptional
- organization_registration_idstringoptional
- organization_registration_authoritystringoptional
- vat_idstringoptional
- subject_to_vatbooleanoptional
- ownerobjectoptional
  Owner details in response payloads.
  12 fields in owner
  - idinteger · int32optional
    Internal owner ID.
  - given_namestringoptional
  - family_namestringoptional
  - personal_idstring · uuidoptional
  - titlestringoptional
  - date_of_birthstringoptional
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
- owners[]array<object>optional
  Same shape as owner — 12 fields, identical. Anchors under this path still resolve.
  12 fields in owners
  - idinteger · int32optional
    Internal owner ID.
  - given_namestringoptional
  - family_namestringoptional
  - personal_idstring · uuidoptional
  - titlestringoptional
  - date_of_birthstringoptional
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
- registered_addressobjectoptional
  Address in response payloads.
  6 fields in registered_address
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
- operating_addressobjectoptional
  Address in response payloads.
  Same shape as registered_address — 6 fields, identical. Anchors under this path still resolve.
  6 fields in operating_address
  - street_addressstringoptional
  - street_address2stringoptional
  - postal_codestringoptional
  - citystringoptional
  - regionstringoptional
  - countrystringoptional
store_informationobjectoptional
Store information container in response payloads.
9 fields in store_information
- stores[]array<object>optional
  8 fields in stores
  - idinteger · int64optional
    Internal store ID.
  - countrystringoptional
  - store_namestringoptional
  - organization_categorystringoptional
  - homepage_urlstringoptional
  - logo_urlstringoptional
  - support_emailstringoptional
  - support_phonestringoptional
platformstringoptional
created_atstring · date-timeoptional
last_modified_atstring · date-timeoptional
transactions_requested_atstring · date-timeoptional
payouts_requested_atstring · date-timeoptional
price_planstringoptional
custom_dataobjectoptional
1 field in custom_data
- keyanyoptional
  Any additional property. The key is free-form; the value has this shape.
stakeholders[]array<object>optional
bank_accounts[]array<object>optional
8 fields in bank_accounts
- idinteger · int32optional
  Internal bank account ID.
- currency_codestringoptional
- countrystringoptional
- account_typestringoptional
- account_holderstringoptional
- routing_numberstringoptional
- account_numberstringoptional
- is_defaultbooleanoptional
special_offerobjectoptional
Special pricing offer details.
5 fields in special_offer
- idstringoptional
- valid_untilstring · date-timeoptional
- percentage_feenumber · doubleoptional
- fixed_feenumber · doubleoptional
- consumedbooleanoptional
settlement_scheduleobjectoptional
Settlement payout schedule.
3 fields in settlement_schedule
- delayinteger · int32optional
  Number of days delay before settlement.
- intervalstringoptional
  Settlement interval (e.g. DAILY, WEEKLY).
- daystringoptional
  Day of the week for weekly settlements.
  - MONDAY
  - TUESDAY
  - WEDNESDAY
  - THURSDAY
  - FRIDAY
  - SATURDAY
  - SUNDAY
statusobjectoptional
Current merchant status with full history.
7 fields in status
- currentstringoptional
  The current merchant status.
  - PENDING
  - TRANSACTIONS_DISABLED
  - TRANSACTIONS_ENABLED
  - PAYOUTS_ENABLED
  - ADDITIONAL_REVIEW_1
  - ADDITIONAL_REVIEW_2
  - SUSPENDED
  - PRE_ASSESSMENT_PENDING
  - DORMANT
- reasonstringoptional
  Reason for the current status.
  - ACCEPTED
  - APPROVED
  - MISSING_INFO
  - UNETHICAL
  - CREDIT
  - NOREACH
  - OTHER
  - TEST
  - UNIDENT
  - TIMEOUT
  - APPLICATION_REVOKED
  - SUSPICION
  - +6 more
- last_modified_atstring · date-timeoptional
- history[]array<object>optional
  Full status change history.
  3 fields in history
  - to_statusstringoptional
    PENDING
    TRANSACTIONS_DISABLED
    TRANSACTIONS_ENABLED
    PAYOUTS_ENABLED
    ADDITIONAL_REVIEW_1
    ADDITIONAL_REVIEW_2
    SUSPENDED
    PRE_ASSESSMENT_PENDING
    DORMANT
  - reasonstringoptional
    ACCEPTED
    APPROVED
    MISSING_INFO
    UNETHICAL
    CREDIT
    NOREACH
    OTHER
    TEST
    UNIDENT
    TIMEOUT
    APPLICATION_REVOKED
    SUSPICION
    +6 more
  - modified_atstring · date-timeoptional

401

Response0 fields

Unauthorized — missing or invalid access token.

No response body — this status returns headers only.

404

Response0 fields

Merchant not found.

No response body — this status returns headers only.

GET https://api.kustom.co/accountmanagement/v1/merchants/{merchantId}

Response 200· Merchant details returned successfully.

{
  "merchant_id": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "type": "<string>",
  "country": "<string>",
  "business_information": {
    "organization_is_registered": false,
    "organization_entity_type": "<string>",
    "organization_name": "<string>",
    "organization_registration_id": "<string>",
    "organization_registration_authority": "<string>",
    "vat_id": "<string>",
    "subject_to_vat": false,
    "owner": {
      "id": 0,
      "given_name": "<string>",
      "family_name": "<string>",
      "personal_id": "<uuid>",
      "title": "<string>",
      "date_of_birth": "<string>",
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "owners": [
      {
        "id": 0,
        "given_name": "<string>",
        "family_name": "<string>",
        "personal_id": "<uuid>",
        "title": "<string>",
        "date_of_birth": "<string>",
        "street_address": "<string>",
        "street_address2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
      }
    ],
    "registered_address": {
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "operating_address": {
      "street_address": "<string>",
      "street_address2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>"
    }
  },
  "store_information": {
    "stores": [
      {
        "id": 0,
        "country": "<string>",
        "store_name": "<string>",
        "organization_category": "<string>",
        "homepage_url": "<string>",
        "logo_url": "<string>",
        "support_email": "<string>",
        "support_phone": "<string>"
      }
    ]
  },
  "platform": "<string>",
  "created_at": "<date-time>",
  "last_modified_at": "<date-time>",
  "transactions_requested_at": "<date-time>",
  "payouts_requested_at": "<date-time>",
  "price_plan": "<string>",
  "custom_data": {
    "key": "<string>"
  },
  "stakeholders": [
    {}
  ],
  "bank_accounts": [
    {
      "id": 0,
      "currency_code": "<string>",
      "country": "<string>",
      "account_type": "<string>",
      "account_holder": "<string>",
      "routing_number": "<string>",
      "account_number": "<string>",
      "is_default": false
    }
  ],
  "special_offer": {
    "id": "<string>",
    "valid_until": "<date-time>",
    "percentage_fee": 0,
    "fixed_fee": 0,
    "consumed": false
  },
  "settlement_schedule": {
    "delay": 0,
    "interval": "<string>",
    "day": "MONDAY"
  },
  "status": {
    "current": "PENDING",
    "reason": "ACCEPTED",
    "last_modified_at": "<date-time>",
    "history": [
      {
        "to_status": "PENDING",
        "reason": "ACCEPTED",
        "modified_at": "<date-time>"
      }
    ]
  }
}

124 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.