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 Orders API

An order represents an authorization of credit for a customer transaction. Once authorized, an order can be partially or fully captured as goods or services are fulfilled, or canceled if the transaction does not proceed.

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

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

This API exposes 6 operations across 4 paths, and defines 14 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 4 paths 14 schemas 2 GET3 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 Orders 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 4 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 6

An order represents an authorization of credit for a customer transaction. Once authorized, an order can be partially or fully captured as goods or services are fulfilled, or canc…

GET
/orders
List orders
listOrders 3 params → 200400401429
POST
/orders
Create an order
createOrder body → 200400401429
GET
/orders/{order_id}
Fetch an order
fetchOrder 1 param → 200400401404429
PUT
/orders/{order_id}
Update an order
updateOrder 1 param body → 200400401404429
POST
/orders/{order_id}/capture
Capture an order
captureOrder 1 param body → 200400401404429
POST
/orders/{order_id}/cancel
Cancel an order
cancelOrder 1 param → 200400401404429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Order (19 properties), OrderListItem (18 properties), OrderCreateRequest (8 properties), OrderLineItem (7 properties). Each schema is shown below with its type and property counts.

OrderListResponse
object
4 properties
OrderCaptureEvent
object
4 properties
OrderCreateRequest
object
8 properties 3 required
OrderLineItem
object
7 properties
OrderListItem
object
18 properties
UnauthorizedError
object
1 property
NotFoundError
object
1 property
ValidationError
object
1 property
OrderCaptureRequest
object
5 properties 2 required
OrderCustomer
object
3 properties
InvalidRequestError
object
1 property
OrderUpdateRequest
object
4 properties
Order
object
19 properties
RateLimitError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-orders-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 Merchants API
Resolve Payments API
Resolve Payout Transactions API
Resolve Payouts API
Resolve Shipments API
Resolve Webhooks API