Payouts

Trigger manual payout

Used to payout a participant multiple times. Must pass payoutCount to ensure the intended number of payouts occur. Will pay them the same incentive amount again based on the project. Use GET /projects/:projectId/payouts to get the payout counts per participant for a project.

Projects Autopay(true): The first time participants are paid automatically when they are marked as attended.

Projects Autopay(false): The first time payment should be done by using the POST /projects/:projectId/screener-responses/:screenerResponseId/payouts endpoint.

POST

projects

{projectId}

screener-responses

{screenerResponseId}

payouts

Trigger manual payout

curl --request POST \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses/{screenerResponseId}/payouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '{
  "payoutCount": 123,
  "tip": 123
}'

Headers

x-api-key

string

required

x-api-secret

string

required

Path Parameters

projectId

string

required

screenerResponseId

string

required

Body

application/json

Retrieve payout countsReturns the payout counts for participants which have been paid for a project.

Trigger manual payout

curl --request POST \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses/{screenerResponseId}/payouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '{
  "payoutCount": 123,
  "tip": 123
}'

Getting started

Project Setup

Screener Response Handling

Messaging

Lookup and Reference Data

Webhooks

Team Tools

Trigger manual payout

Headers

Path Parameters

Body