Vai al contenuto

Ajusta o saldo de créditos de um membro

POST/api/credits/adjustments

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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

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

Corpo della richiesta application/json

NomeTipoDescrizione
profileIdobbligatoriostring (uuid)
amountobbligatoriointegerPositivo ou negativo, nunca 0; de -1.000.000 a 1.000.000 (acima disso, 400 no campo `amount`). · ≥ -1000000, ≤ 1000000
reasonobbligatoriostringmax 255
expiresAtfacoltativostring (date-time)Só no ajuste positivo.

Risposte

CodiceDescrizione
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.

Esempio con curl

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"}'