Zum Inhalt springen

Ajusta o saldo de créditos de um membro

POST/api/credits/adjustments

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Ajuste positivo ou negativo, com motivo obrigatório; é assim que se corrige um erro (o livro nunca altera nem apaga um lançamento). O ajuste positivo abre um lote (`expiresAt` opcional); o negativo consome os lotes que vencem primeiro e **não** pode levar o saldo utilizável abaixo de zero (`409`, `errors[].param = amount`). Owner, admin e financeiro; o moderador recebe 403.

Header

NameTypBeschreibung
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request-Body application/json

NameTypBeschreibung
profileIdPflichtstring (uuid)
amountPflichtintegerPositivo ou negativo, nunca 0; de -1.000.000 a 1.000.000 (acima disso, 400 no campo `amount`). · ≥ -1000000, ≤ 1000000
reasonPflichtstringmax 255
expiresAtoptionalstring (date-time)Só no ajuste positivo.

Antworten

StatusBeschreibung
201Ajustado
400Requisição inválida — falha de validação.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.

curl-Beispiel

curl -X POST "https://api.memberfy.net/api/credits/adjustments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"00000000-0000-0000-0000-000000000000","amount":-1000000,"reason":"string"}'