Skip to main content
POST
Trigger manual payout

When to call this endpoint

Which call you make depends on the project’s automations.autopay setting. Read it with Get a project if you are unsure.
  • First payment, autopay: true: do not call this endpoint. Mark as attended already fires the first payment. Calling this endpoint with payoutCount: 1 on top of that produces a duplicate payment.
  • First payment, autopay: false: call this endpoint with payoutCount: 1 to issue the first payment. Mark as attended does not pay the participant when autopay is off.
  • Payments 2–5 (any project): call this endpoint with payoutCount set to the intended payment number (2, 3, 4, or 5). Use Retrieve payout counts first to confirm how many payments the participant has already received.
payoutCount is required and is the sequence number of the payment being made, not a delta. See How to use multiple payments for the full flow and the optional tip field.
402 Payment Required — no default payment card on file.Payouts are charged to the team’s default payment card. If the team has no default card configured, this endpoint returns a 402 with an explanatory error message instead of completing the payout. This is not a transient error — retrying will keep failing until a default payment card is added to the team in Respondent. Add a default card, then re-run the payout.

Headers

x-api-key
string
required
x-api-secret
string
required

Path Parameters

projectId
string
required
screenerResponseId
string
required

Body

application/json
payoutCount
number
required

Number Limit: Min 1 and Max 5

tip
number

Tip amount for the participant. In cents. USD. Dollars Limit: Min 0.

Response

Last modified on September 14, 2026