Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Connect

List Connect sub-merchant accounts

Paginated list of sub-merchants owned by the authenticated marketplace. Results are ordered by creation date (newest first) and are always scoped to the caller, so cross-marketplace reads are structurally impossible.

get/api/connect/accounts

Query parameters

pagenumber

Page number, 1-indexed. Defaults to 1.

limitnumber

Items per page. Defaults to 20, max 100.

emailstring
Example:seller@example.com

Exact-match email filter (case-insensitive). Useful to resolve a sub-merchant by the email the marketplace signed it up with.

merchantNamestring
Example:Acme

Case-insensitive substring match on merchantName. Matches either the full name or any prefix/suffix.

Response

List Connect sub-merchant accounts 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…"
  }
]