v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
bonuses

Pay bonuses

Bonus payments are made asynchronously. The payment will be done in the following minutes and your balance will be updated accordingly.

<Warning> This endpoint is **not idempotent**. Sending multiple requests with the same bulk bonus payment ID will result in participants being paid multiple times. Ensure you send this request only once per bulk payment. </Warning>
post/api/v1/bulk-bonus-payments/{id}/pay/

Path parameters

idstring required

Bulk bonus payment id

Headers

Authorizationstring required

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Response

Successfully received bonus payments request. The bonuses will be paid asynchronously.

string required