Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Resolve Merchants API

Merchant-scoped operations for managing sub-merchant resources.The merchant document upload endpoint creates a document record and starts transfer into Resolve-managed storage for validation.

Resolve Merchants API is one of 12 APIs that Resolve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Merchants. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version V5.

Requests are made against a single base URL, https://app-sandbox.resolvepay.com/api.

6 operations 3 paths 19 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
V5
Base URL
https://app.resolvepay.com/api
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Resolve Merchants API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Auth using merchantid as username and the merchant secret key as password.
  • bearerAuth — Bearer token authentication using an OAuth access token minted for an API access key created in Merchant Dashboard.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Merchants 6

Merchant-scoped operations for managing sub-merchant resources. The merchant document upload endpoint creates a document record and starts transfer into Resolve-managed storage fo…

GET
/merchants
List Merchants
listMerchants 5 params → 200400401429
POST
/merchants
Create Merchant
createMerchant body → 200400401404429
GET
/merchants/{merchant_id}
Get Merchant
getMerchant 1 param → 200400401404429
PUT
/merchants/{merchant_id}
Update Merchant
updateMerchant 1 param body → 200400401404429
GET
/merchants/{merchant_id}/documents
List Merchant Documents
listMerchantDocuments 5 params → 200400401404429
POST
/merchants/{merchant_id}/documents
Create a Merchant Document Upload Request
createMerchantDocumentUploadRequest 1 param body → 200400401404429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are UpdateMerchantRequest (27 properties), CreateMerchantRequest (26 properties), Merchant (17 properties), MerchantDocumentUploadRequestObject (11 properties). Each schema is shown below with its type and property counts.

DocumentIngestionResult
object
Inline document dispatch result for merchant create/update responses. Post-commit queue dispatch failures are surfaced here as failed items without rolling bac…
7 properties
Address
object
6 properties 5 required
InlineDocumentDownloadRequest
object
3 properties 3 required
BeneficialOwner
object
6 properties 5 required
MerchantDocumentList
object
4 properties
CreateMerchantRequest
object
26 properties 7 required
MerchantDocument
object
Merchant document metadata and validation lifecycle status.
10 properties
AuthorizedSigner
object
5 properties
Merchant
object
17 properties
UnauthorizedError
object
1 property
MerchantDocumentUploadRequestObject
object
11 properties
NotFoundError
object
1 property
DocumentIngestionSummary
object
4 properties
ValidationError
object
1 property
CreateMerchantDocumentRequest
object
4 properties 3 required
InvalidRequestError
object
1 property
UpdateMerchantRequest
object
All fields are optional for update requests. For merchants whose latest underwriting decision has been finalized, updates to core legal/identity/banking fields…
27 properties
RateLimitError
object
1 property
MerchantList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-merchants-api-openapi.yml Raw ↑

Other APIs Resolve publishes across the network.

Resolve Access Keys API
Resolve Charges API
Resolve Credit Notes API
Resolve Customers API
Resolve Invoices API
Resolve Orders API
Resolve Payments API
Resolve Payout Transactions API
Resolve Payouts API
Resolve Shipments API
Resolve Webhooks API