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 Credit Notes API

Credit Notes are issued to customers to reduce the amount they owe.

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

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

This API exposes 4 operations across 3 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.

4 operations 3 paths 9 schemas 2 GET2 POST

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 Credit Notes 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 4

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

Credit Notes 4

Credit Notes are issued to customers to reduce the amount they owe.

GET
/credit-notes
List credit notes
listCreditNotes 4 params → 200400401429
POST
/credit-notes
Create a credit note
createCreditNote body → 200400401404429
POST
/credit-notes/{credit_note_id}/void
Request to void a credit note
voidCreditNote → 200400401404429
GET
/credit-notes/{credit_note_id}
Fetch a credit note
fetchCreditNote 1 param → 200400401404429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CreditNote (20 properties), CreditNoteCreateRequest (6 properties), CreditNoteListResponse (4 properties), CreditNoteAction (1 property). Each schema is shown below with its type and property counts.

InvalidRequestError
object
1 property
NotFoundError
object
1 property
CreditNoteCreateRequest
object
6 properties 3 required
CreditNoteAction
object
1 property
ValidationError
object
1 property
CreditNoteListResponse
object
4 properties
UnauthorizedError
object
1 property
RateLimitError
object
1 property
CreditNote
object
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-credit-notes-api-openapi.yml Raw ↑

Other APIs Resolve publishes across the network.

Resolve Access Keys API
Resolve Charges 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