Saltar al contenido

Ajusta o saldo de créditos de um membro

POST/api/credits/adjustments

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
profileIdobligatoriostring (uuid)
amountobligatoriointegerPositivo ou negativo, nunca 0; de -1.000.000 a 1.000.000 (acima disso, 400 no campo `amount`). · ≥ -1000000, ≤ 1000000
reasonobligatoriostringmax 255
expiresAtopcionalstring (date-time)Só no ajuste positivo.

Respuestas

CódigoDescripción
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.

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