Retorna o balanço do usuário

GET /user/:userId/balance

Retorna o balanço do usuário.

Request

userId stringrequired

Id do Usuário

Example: 258adef8-c771-444c-9fcf-ca5549de3aa1

Balanço encontrado com sucesso

Schema

value number

Saldo do balanço do usuário

tier string

Nível do usuário no programa de fidelidade

tierExpirationDateTime string

Data de expiração do nível (ISO 8601)

tierUpdateDateTime string

Data de atualização do nível (ISO 8601)

{
  "value": 10000,
  "tier": "GOLD PREMIUM",
  "tierExpirationDateTime": "2022-11-22T20:30",
  "tierUpdateDateTime": "string"
}

Erros em que a operação não pode ser concluída.

Schema

message string

{
  "message": "Forbidden"
}

Usuário inválido ou bloqueado.

{
  "message": "Usuário inválido ou bloqueado. Verifique sua conta."
}

Operação inválida.

{
  "message": "Não é possível realizar essa operação no momento."
}

Erros inesperados.

Schema

message string

{
  "message": "Forbidden"
}

Timeout para realizar a operação

{
  "message": "Timeout. Tente novamente."
}

Erro de comunicação de rede

{
  "message": "Falha de comunicação. Tente novamente."
}

Servidor inoperante

{
  "message": "Servidor inoperante. Tente novamente mais tarde."
}