Skip to content

List Merchant Documents

Request

Returns document presence and validation lifecycle status for a specific sub-merchant.

This endpoint is metadata-only and does not return file bodies or signed retrieval URLs.

Supported query options:

  • Pagination: limit, page
  • Sorting: sort
  • Field filters: filter[field][eq]=value

Supported filter fields:

  • document_type
  • status

Supported sort fields:

  • created_at

Use - prefix for descending sort, for example sort=-created_at.

Security
bearerAuth or basicAuth
Path
merchant_idstringrequired

ID of the sub-merchant under your partner account.

Example:mrc_1234567890abcdef
Query
limitinteger, [ 1 .. 100 ]

Maximum number of document records to return.

Default:25
Example:limit=25
pageinteger, >= 1

Page number for paginated document results.

Default:1
Example:page=1
sortstring

Sort field for merchant document results.

Prefix with - for descending order.

Enum:"created_at""-created_at"
Example:sort=-created_at
filterobject

Filter merchant documents by type or validation status.

Filter semantics: filter[field][operator]=value.

Supported filters:

  • filter[document_type][eq]=bank_statements
  • filter[status][eq]=accepted
curl -i -X GET \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/merchants/mrc_1234567890abcdef/documents?limit=25&page=1&sort=-created_at&filter=%7B%22document_type%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22status%22%3A%7B%22eq%22%3A%22pending_upload%22%7D%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of merchant document metadata.

Bodyapplication/json
countinteger
Example:2
pageinteger
Example:1
limitinteger
Example:25
resultsArray of objects(MerchantDocument)
Response
{ "count": 2, "page": 1, "limit": 25, "results": [ { … }, { … } ] }