Créditos
Um crédito é um pagamento a um criador. É o seu sistema que define o valor.
POST /accruals
Seção intitulada “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"}'| Campo | Regras |
|---|---|
participantId |
Um participante active da oferta |
amount |
De 0.01 a 1000000, uma string em dólares americanos |
externalId |
O seu próprio número da operação: de 1 a 100 caracteres entre A–Z a–z 0–9 . _ : -, único dentro da oferta |
comment |
Opcional, até 200 caracteres. O criador o vê |
{ "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+feesai do orçamento da oferta.- O criador recebe
amountintegralmente e pode sacá-lo na hora. - Um crédito não pode ser estornado. Confira o valor antes de enviar.
Repetições seguras
Seção intitulada “Repetições seguras”O externalId torna seguro repetir um crédito:
- O mesmo
externalIdcom os mesmos dados devolve o mesmo crédito e não cobra nada. - O mesmo
externalIdcom outros dados falha com409 EXTERNAL_ID_CONFLICT.
Escolha um externalId determinístico para cada pagamento no seu sistema (por exemplo, 2026-10:<participantId>), salve-o antes de enviar e, depois de um erro de rede, de um timeout ou de um 503, envie a mesma requisição de novo.
Quando um crédito é recusado
Seção intitulada “Quando um crédito é recusado”| Código | Por quê |
|---|---|
PARTICIPANT_NOT_ACTIVE |
O criador ainda não tem código ou foi recusado: envie um código primeiro |
CREATOR_BANNED |
O criador está banido na suly.gg |
INSUFFICIENT_BUDGET |
O orçamento é menor que o valor mais a taxa: adicione orçamento à oferta |
OFFER_ENDED |
A oferta está fechada |
GET /accruals
Seção intitulada “GET /accruals”curl -s "https://suly.gg/api/partner/v1/accruals?page=1" \ -H "Authorization: Bearer $SULY_KEY"Créditos, 50 por página, os mais novos primeiro, cada um no formato acima. Adicione participantId=… para ler os créditos de um criador.
{ "accruals": [], "total": 0, "page": 1, "pageSize": 50 }