Skip to content

Orders

Note: The Orders endpoints are intended for single-merchant partners only. They rely on the buyer belonging to the sub-merchant, which is not the case for marketplace partners; marketplace partner credentials can list and fetch orders but cannot create, update, capture, or cancel them.

An order is an authorization against a buyer's credit line that is captured into an invoice later. Every order belongs to one of your sub-merchants, never to the partner account itself; the Orders endpoints let you act on your sub-merchants' orders on their behalf.

Orders reach your partner account in two ways:

  • Checkout SDK. A buyer completes checkout on a sub-merchant's storefront. The SDK authorizes the order under the sub-merchant's account and hands the order ID to your platform on the success redirect, with the order.created webhook as a fallback. Your platform then captures the order through this API. The sub-merchant's checkout has to be configured for order authorization; contact Resolve to enable it.
  • Partners API. You create the order with POST /orders for one of your sub-merchants' customers; it is placed with the sub-merchant the customer belongs to.

Capturing an order creates an invoice owned by the sub-merchant, which then follows the regular invoice lifecycle and is available through the Invoices endpoints.

List orders

Request

Return a paginated list of orders across your sub-merchants. Every order carries the merchant_id of the sub-merchant it belongs to; use the merchant_id filter to narrow the list to a single sub-merchant.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 1 .. 100 ]

Limit the number of orders returned.

Default:25
pagestring

Specify the page of orders returned.

Default:"1"
filterobject

Filter orders by the specified fields.

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

Available filter operators:

  • eq - equal (=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • merchant_id (eq) - the sub-merchant the order belongs to
  • status (eq)
  • order_number (eq)
  • po_number (eq)
  • customer_id (eq)
  • authorized_at (eq, gt, lt, gte, lte)
  • amount_authorized (eq, gt, lt, gte, lte)
  • amount_captured (eq, gt, lt, gte, lte)
  • amount_canceled (eq, gt, lt, gte, lte)
  • amount_remaining (eq, gt, lt, gte, lte)

Example: filter[merchant_id][eq]=MER456789&filter[status][eq]=authorized

Note: filter with the eq operator is equivalent to filter[field]=value

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/orders?limit=25&page=1&filter=%7B%22merchant_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22status%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22order_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22po_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22customer_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22authorized_at%22%3A%7B%22eq%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gte%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lte%22%3A%222019-08-24T14%3A15%3A22Z%22%7D%2C%22amount_authorized%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_captured%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_canceled%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_remaining%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of orders across your sub-merchants.

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