Skip to content

The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment

Description

The list_bonus_payments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

Usage

mturk_list_bonus_payments(HITId, AssignmentId, NextToken, MaxResults)

Arguments

  • HITId

    The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified

  • AssignmentId

    The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified

  • NextToken

    Pagination token

Value

A list with the following syntax:

list(
  NumResults = 123,
  NextToken = "string",
  BonusPayments = list(
    list(
      WorkerId = "string",
      BonusAmount = "string",
      AssignmentId = "string",
      Reason = "string",
      GrantTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_bonus_payments(
  HITId = "string",
  AssignmentId = "string",
  NextToken = "string",
  MaxResults = 123
)