REresolvepay
Payout Transactions

List Payout Transactions

get/payout-transactions

Request

Query parameters

limitinteger

Limit the number of payout transactions returned.

pagestring

Specify the page of payout transactions returned.

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

Response

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

limitinteger
pageinteger

Example response

{
  "limit": 25,
  "page": 1,
  "results": [
    {
      "id": "AOncfxMnm",
      "merchant_id": "MER456789",
      "payout_id": "gQxGLAowY",
      "type": "advance",
      "customer_id": "voArW2nSs",
      "customer_name": "Test name",
      "invoice_id": "C2vBqxfZ4",
      "invoice_number": "R334-097R",
      "order_id": "u5WRraCYY",
      "po_number": "PO-09785",
      "amount_gross": 100,
      "amount_fee": 3,
      "amount_net": 97,
      "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.