Amazon Mechanical Turk
API Reference (API Version 2017-01-17)

ListBonusPayments

Description

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

Request Syntax

{ "HITId": String, "AssignmentId": String, "NextToken": String, "MaxResults": Integer }

Request Parameters

The request accepts the following data in JSON format:

Name Description Required

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

Type: String

Conditional

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

Type: String

Conditional

NextToken

Pagination token

Type: String

No

MaxResults

Type: Integer

No

Response Elements

A successful request returns a paginated list of Bonuses with the following fields: WorkerId, BonusAmount, AssignmentId, Reason and GrantTime

Example

The following example shows how to use the ListBonusPayments operation:

Sample Request

POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { }

Sample Response

The following is an example response:

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { NextToken:PaginationToken, NumResults:10, BonusPayments:[Bonus] }