Skip to content
/Payouts

Payouts

A Payout is a transfer of money between the Merchant and Resolve.

Operations

List Payouts

Request

Security
bearerAuth or basicAuth
Query
filterstring

Filter records 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:

  • status (eq)
  • expected_by (eq, gt, lt, gte, lte)
  • created_at (eq, gt, lt, gte, lte)

Example: filter[created_at][gt]=2022-10-30T14:00:00.000Z

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

sortstring

Sort records 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/merchant-api/openapi/payouts?filter=string&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object with an array of Payouts up to the specified limit.

Bodyapplication/json
limitinteger
Example:25
pageinteger
Example:1
resultsArray of objects(PayoutObject)
Response
{
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}