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

A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amount of the payment. Payments can be made via various methods including ACH, credit card, check, or wire transfer. Each payment can be applied to one or more invoices.

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

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

This API exposes 3 operations across 2 paths, and defines 8 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.

3 operations 2 paths 8 schemas 2 GET1 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 Payments 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 3

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

Payments 3

A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amo…

GET
/payments
List payments
listPayments 4 params → 200400401429
POST
/payments
Create a payment
createPayment body → 200400401404422429
GET
/payments/{payment_id}
Fetch a payment
fetchPayment 1 param → 200400401404429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Payment (17 properties), PaymentListResponse (4 properties), PaymentCreateRequest (2 properties), UnauthorizedError (1 property). Each schema is shown below with its type and property counts.

PaymentCreateRequest
object
2 properties 2 required
InvalidRequestError
object
1 property
PaymentListResponse
object
4 properties
NotFoundError
object
1 property
ValidationError
object
1 property
Payment
object
17 properties
UnauthorizedError
object
1 property
RateLimitError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-payments-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 Orders API
Resolve Payout Transactions API
Resolve Payouts API
Resolve Shipments API
Resolve Webhooks API