OxaPay icon

OxaPay

OxaPay Crypto Payment gateway

Payout → Search Payouts

AI-generated

Summary

Search payout transactions using optional filters such as type, status, currency, network, address, date range, amount range, and pagination parameters.

Inputs

  • Type — Filter payouts by type, either 'internal' or 'external'.
  • Status — Filter payouts by status: processing, pending, confirming, confirmed, canceled, or rejected.
  • Currency — Filter payouts by a specific currency symbol.
  • Network — Filter payouts by the expected blockchain network for the specified cryptocurrency.
  • Address — Filter payouts by the expected address.
  • From Date — Start of the date window to query payouts, as a UNIX timestamp.
  • To Date — End of the date window to query payouts, as a UNIX timestamp.
  • From Amount — Filter payouts with amounts greater than or equal to this value (minimum 0).
  • To Amount — Filter payouts with amounts less than or equal to this value (minimum 0).
  • Sort By — Sort the results by create date, pay date, or amount.
  • Sort Type — Order results ascending or descending.
  • Page — Page number of results to retrieve (minimum 1). Defaults to 1.
  • Page Size — Number of records per page (between 1 and 200). Defaults to 10.

Output shape

a JSON object representing a list of payouts matching the applied filters.

Results respect pagination parameters 'Page' and 'Page Size'. Outputs return the raw response from the OxaPay payouts endpoint (/payout GET). Errors are returned as NodeApiError instances with details.

Examples

Example 1: List confirmed external payouts in BTC sorted by pay date descending on page 1 with 20 records per page

Type: External; Status: Confirmed; Currency: BTC; Sort By: Pay Date; Sort Type: Descending; Page: 1; Page Size: 20

Links

Discussion