AIairtm
Bulk Payouts

Get bulk payout

Endpoint to retrieve the details of an existing bulk payout. The status RUNNING is the default after you have posted your bulk payout. It means that the individual payouts are being processed and not all of them have been processed yet. Once that has happened, the status will switch to DONE.

To list all payouts associated with a specific bulk payout, use the List Payouts endpoint and pass the bulk payout id as the bulkPayoutId query parameter.

get/bulk-payouts/{id}

Request

Path parameters

idstring required

The bulk payout id

Response

Ok

updatedAtstring date-time required

Timestamp of the last update made to the payout.

executionDatestring date-time

Timestamp of when the payout was executed.

createdAtstring date-time required

Timestamp of when the payout was created.

paidAmountnumber double required

Aggregated amount of all individual payouts in this bulk that were paid

totalAmountnumber double required

Aggregated amount of all individual payouts in this bulk

totalnumber double required

Number of individual payouts in this bulk

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

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
originalFileNamestring

The name of the file if the bulk payout was created uploading a CSV

enterpriseUserIdstring uuid required

Unique identifier of the enterprise who created this bulk payout

idstring uuid required

Unique identifier

Example response

{
  "paidAmount": 24,
  "totalAmount": 1234.56,
  "total": 24
}

Changes

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