AIairtm
Bulk Payouts

List bulk payouts

Endpoint to receive all bulk payouts associated with your account.

get/bulk-payouts

Request

Query parameters

beforestring

Gets results before the specified cursor.

afterstring

Gets results after the specified cursor.

perPageinteger

The maximum number of items to fetch.

status'PENDING' | 'IN_PROGRESS' | 'UNCOMPLETED' | 'COMPLETED' | 'REJECTED'

The current status of the bulk payout

  • PENDING: The bulk payout was received, but it has yet to be started
  • IN_PROGRESS: Our system is currently processing all the individual payouts contained in this bulk payout.
  • COMPLETED: This doesn't mean all payouts were completed successfully, it may have guest or failed items. It means only that the processing, validations and creation of operations related to that task is completed.
  • REJECTED: The enterprise rejected the bulk payout
  • UNCOMPLETED: Reserved for future use

Response

Ok

startCursorstring

The cursor for the first item in the current page.

endCursorstring

The cursor for the last item in the current page.

Example response

{
  "items": [
    {
      "paidAmount": 24,
      "totalAmount": 1234.56,
      "total": 24
    }
  ]
}

Changes

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