Payout Transactions

Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout for a sub-merchant or the partner. 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.

Operations

List Payout Transactions

Request

Security

bearerAuth or basicAuth

Query

limitinteger, [ 25 .. 100 ]

Limit the number of payout transactions returned.

Default:25

pagestring

Specify the page of payout transactions returned.

Default:"1"

filterstring

Filter Payout Transactions by the specified fields.

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

Available filter operators:

eq - equal (=)
ne - not 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) - filter by sub-merchant ID
customer_id (eq, ne)
created_at (eq, gt, lt, gte, lte)
payout_id (eq, ne)
invoice_id (eq, ne)

Example: filter[created_at][gte]=2021-01-01T00:00:00.000Z

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

sortstring

Sort Payout Transactions by the specified fields.

The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.

Multiple sort fields supported by allowing comma-separated sort fields. Sort fields will be applied in the order specified.

Sorting is allowed by the following fields: id, created_at.

Example: sort=id,-created_at

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/payout-transactions?limit=25&page=1&filter=string&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object with an array of results containing up to the limit. If no payout transactions are found, the results array will be empty.

Bodyapplication/json

limitinteger

Example:25

pageinteger

Example:1

resultsArray of objects(PayoutTransactionObject)

Response

{
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}