ResellersReseller portfolio

List onboarding status for the reseller's merchants

post/v1/onboarding/reseller-merchants-onboarding-status

Returns the onboarding record of each of the reseller's merchants: business, owner, bank, payout, account and terms-of-service status, verification tier, outstanding errors, onboarding links and tags, plus every tag the reseller has defined. Set enablePagination: true to page, search, sort and filter; without it every merchant is returned and only isLiableOnly and sorting apply. For API key callers the reseller is always taken from the key; resellerId is optional and must match if sent.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/onboarding/reseller-merchants-onboarding-status

Authorization

ApiKeyAuth
headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

Request Body

application/json
  1. body

Keys may be camelCase or snake_case (reseller_id, enable_pagination, and so on).

resellerId?|

Optional for API key callers; must match the key's reseller if sent.

enablePagination?boolean

Turn on paging, search and the activeOnly/excludeMerchantId filters. When false every merchant is returned.

Defaultfalse
page?integer

Page number (pagination only).

Range1 <= value
Default1
limit?integer

Page size (pagination only). Not capped by the server.

Range1 <= value
Default20
search?string

Case-insensitive match on merchant name, trading name or merchant ID (pagination only).

Default""
isLiableOnly?boolean

Only merchants flagged as resellers (liable accounts).

Defaultfalse
activeOnly?boolean

Exclude closed or suspended merchants (account_status 0). Pagination only.

Defaultfalse
excludeMerchantId?integer

Leave this merchant out of the results. Pagination only.

sortField?"createdAt"

Sort by merchant creation time. When omitted, rows are ordered by onboarding record, newest first.

Value in"createdAt"
sortOrder?string
Default"desc"
Value in"asc""desc"

Response parameters & Errors

Response Body

Merchant onboarding rows, all tags defined by the reseller, and the total. With pagination, total is the number of matching merchants across all pages; without it, total is the number of rows returned.

application/json
  1. response
data*