Aller au contenu

Concede créditos a um membro ou a uma empresa

POST/api/credits/grants

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
finance
Clé d’API:
sales:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Concessão manual: abre um lote novo com motivo obrigatório e validade opcional (nulo = não vence). Owner, admin e financeiro; o moderador só lê (403). `amount` é inteiro de 1 a 1.000.000 (acima disso, 400 no campo `amount`); `expiresAt` precisa ser futuro. Informe `memberId` **ou** `companyId` (os dois ou nenhum: 400 em `memberId`). Para a carteira da empresa (`companyId`), só owner e admin (financeiro: 403); empresa de outra comunidade: 404; a resposta traz `companyId` no lugar de `memberId`.

En-têtes

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

Corps de la requête application/json

NomTypeDescription
memberIdfacultatifstring (uuid)O perfil que recebe. Ou `companyId`.
companyIdfacultatifstring (uuid)A empresa que recebe. Só owner e admin.
amountobligatoireinteger≥ 1, ≤ 1000000
reasonobligatoirestringmax 255
expiresAtfacultatifstring (date-time)

Réponses

StatutDescription
201Concedido
400Requisição inválida — falha de validação.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.

Exemple curl

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