screener-responses endpoints to allow invited participants to be paid the projects incentive amount up to 5 times. For instances where the second, third, forth, and fifth payments may need to be higher than the initial incentive, there is a tip field that allows for a payment to a participant to exceed the incentive defined in the project.
Payouts cannot be lower than the incentive defined on the project. It is important to keep the project incentive the lowest dollar amount a participant may get paid.
How to use multiple payments
The first payment behavior depends on the project’sautomations.autopay setting:
autopay: true(the default when omitted at project creation): the first payment fires automatically when the participant is marked as Attended/Complete via Mark as attended. Do not also call the payout endpoint withpayoutCount: 1— that produces a duplicate first payment.autopay: false: Mark as attended records attendance but does not pay the participant. Issue the first payment yourself withPOST /v1/projects/{projectId}/screener-responses/{screenerResponseId}/payoutsandpayoutCount: 1(or process it from the Respondent dashboard).
- /v1/projects/{projectId}/screener-responses/payouts
- /v1/projects/{projectId}/screener-responses/{screenerResponseId}/payouts
/v1/projects/{projectId}/screener-responses/payouts
- To begin a followup payment, you must first call the payouts GET with the desired project ID
- You should receive a response like this:
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/payouts
- After confirming the current number of payments for a profile ID, you can POST the next payment