v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Connect

Get Connect sub-merchant account

Returns the full sub-merchant profile, custodial wallet pointers, suspension flag, and flattened KYC state. 404s if the sub-merchant does not belong to the authenticated marketplace.

get/api/connect/accounts/{subMerchantId}

Path parameters

subMerchantIdstring required
Example:usr_01JABCDEF0123456789XYZ

Sub-merchant user id

Response

Get Connect sub-merchant account successful

idstring required
emailstring required
merchantNamestring nullable required
firstNamestring nullable required
lastNamestring nullable required
accountType'INDIVIDUAL' | 'MARKETPLACE' | 'SUB_MERCHANT' required
marketplaceUserIdstring required
marketplaceMetadataobject nullable required
customerIdstring nullable required

KYC provider customer id linked to this sub-merchant

custodialWalletAddressstring nullable required

Custodial wallet address for this sub-merchant

stopProcessingSettlementboolean required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "usr_01JABCDEF0123456789XYZ",
  "email": "seller@example.com",
  "merchantName": "Seller Alpha",
  "firstName": "John",
  "lastName": "Doe",
  "marketplaceUserId": "usr_marketplace123",
  "customerId": "cus_abc123",
  "custodialWalletAddress": "0xABC123…"
}