REresolvepay
Payouts

List Payouts

get/payouts

Request

Query parameters

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

Response

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

limitinteger
pageinteger

Example response

{
  "limit": 25,
  "page": 1,
  "results": [
    {
      "id": "PMMlaE5wbg0",
      "amount_gross": 120,
      "amount_fee": 20,
      "amount_net": 100,
      "status": "pending",
      "retry_payout_id": "PMMlaE5wbg0",
      "failed_at": "2022-09-06T03:08:37.508Z",
      "expected_by": "2022-09-06T03:08:37.508Z",
      "canceled_at": "2022-09-06T03:08:37.508Z",
      "created_at": "2022-09-06T03:08:37.508Z",
      "updated_at": "2022-09-06T03:08:37.508Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.