Aller au contenu

Meu saldo de créditos

GET/api/credits/me

Auth
Jeton requis
Clé d’API:
sales:read
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.

Saldo utilizável do perfil de quem chama (a comunidade vem do `X-CommunityId`), o que vence em 7 dias e os lotes. Qualquer papel. Quando quem chama tem vínculo vivo com uma empresa não encerrada que tem carteira (algum lançamento), `company` traz o saldo dela: é o que a reserva usa com `payWith: company`.

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.

Réponses

StatutDescription
200Saldo
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.

Exemple curl

curl -X GET "https://api.memberfy.net/api/credits/me" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"