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 Payout Transactions API

Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout. Each Payout is the sum of one or more transactions. Note that certain fields are only relevant to certain transaction types - e.g.: a Payout Transaction of type `monthly_fee` will have both `customer_id` and `invoice_id` set to `null`.

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

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

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

2 operations 2 paths 7 schemas 2 GET

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 Payout Transactions 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 2

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

Payout Transactions 2

Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout. Each Payout is the sum of one…

GET
/payout-transactions
List Payout Transactions
listPayoutTransactions 4 params → 200400401429
GET
/payout_transactions/{payout_transaction_id}
Get a Payout Transaction
getPayoutTransaction 1 param → 200400401404429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PayoutTransactionObject (14 properties), PayoutTransactionsLists (3 properties), RateLimitError (1 property), UnauthorizedError (1 property). Each schema is shown below with its type and property counts.

InvalidRequestError
object
1 property
NotFoundError
object
1 property
PayoutTransactionsLists
object
3 properties
ValidationError
object
1 property
UnauthorizedError
object
1 property
RateLimitError
object
1 property
PayoutTransactionObject
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-payout-transactions-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 Payments API
Resolve Payouts API
Resolve Shipments API
Resolve Webhooks API