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

A charge represents an agreement by the customer to accept credit terms for a transaction. It consists of a charge amount, term length (i.e. 30, 60, 90), and reference to the merchant's original order or purchase order numbers.These endpoints are intended for merchants using the [Checkout SDK](/guides/checkout-sdk).If you are not using the Checkout SDK flow, these endpoints are generally not needed.

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

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

This API exposes 5 operations across 4 paths, and defines 9 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.

5 operations 4 paths 9 schemas 2 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 Charges 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 5

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

Charges 5

A charge represents an agreement by the customer to accept credit terms for a transaction. It consists of a charge amount, term length (i.e. 30, 60, 90), and reference to the merc…

GET
/charges
List charges
listCharges 6 params → 200400401429
GET
/charges/{charge_id}
Fetch a charge
fetchCharge 1 param → 200400401404429
PUT
/charges/{charge_id}
Update a charge
updateCharge 1 param body → 200400401404429
POST
/charges/{charge_id}/capture
Capture a charge
captureCharge 1 param body → 200400401404429
POST
/charges/{charge_id}/cancel
Cancel a charge
cancelCharge 1 param → 200400401404429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Charge (19 properties), ChargeUpdateRequest (8 properties), ChargeListResponse (4 properties), ChargeCaptureRequest (3 properties). Each schema is shown below with its type and property counts.

InvalidRequestError
object
1 property
NotFoundError
object
1 property
RateLimitError
object
1 property
ChargeUpdateRequest
object
8 properties
ValidationError
object
1 property
Charge
object
19 properties
ChargeListResponse
object
4 properties
ChargeCaptureRequest
object
3 properties
UnauthorizedError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-charges-api-openapi.yml Raw ↑

Other APIs Resolve publishes across the network.

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