Accruals
An accrual is a payment to one creator. Your system decides the amount.
POST /accruals
Section titled “POST /accruals”curl -s https://suly.gg/api/partner/v1/accruals \ -H "Authorization: Bearer $SULY_KEY" \ -H 'Content-Type: application/json' \ -d '{"participantId":"…","amount":"125.40","externalId":"2026-10-ANDRY","comment":"October 2026"}'| Field | Rules |
|---|---|
participantId |
An active participant of the offer |
amount |
From 0.01 to 1000000, a string in US dollars |
externalId |
Your own operation number: 1–100 characters of A–Z a–z 0–9 . _ : -, unique within the offer |
comment |
Optional, up to 200 characters. The creator sees it |
{ "accrualId": "…", "participantId": "…", "creatorName": "Andry", "externalId": "2026-10-ANDRY", "amount": "125.400000", "fee": "12.540000", "charged": "137.940000", "comment": "October 2026", "createdAt": "2026-11-03T10:00:00.000Z"}charged=amount+feeleaves the offer budget.- The creator receives
amountin full and can withdraw it at once. - An accrual cannot be reversed. Check the amount before you send it.
Safe repeats
Section titled “Safe repeats”externalId makes an accrual safe to repeat:
- The same
externalIdwith the same data returns the same accrual and charges nothing. - The same
externalIdwith other data fails with409 EXTERNAL_ID_CONFLICT.
Choose a deterministic externalId for each payout in your system (for example 2026-10:<participantId>), save it before sending, and after a network error, a timeout or 503 send the same request again.
When an accrual is refused
Section titled “When an accrual is refused”| Code | Why |
|---|---|
PARTICIPANT_NOT_ACTIVE |
The creator has no code yet or was declined: send a code first |
CREATOR_BANNED |
The creator is banned on suly.gg |
INSUFFICIENT_BUDGET |
The budget is less than the amount plus the fee: add budget to the offer |
OFFER_ENDED |
The offer is closed |
GET /accruals
Section titled “GET /accruals”curl -s "https://suly.gg/api/partner/v1/accruals?page=1" \ -H "Authorization: Bearer $SULY_KEY"Accruals, 50 per page, newest first, each in the form above. Add participantId=… to read one creator’s accruals.
{ "accruals": [], "total": 0, "page": 1, "pageSize": 50 }