Exibir saldo do estabelecimento

🔽
GET urlServidor/v1/marketplace/establishments/balance

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth
`establishment\_id`	string	Sim	ID do estabelecimento ao qual os lançamentos estão vinculados.

Exemplo de header da requisição

curl --request GET \
  --url '{{urlServidor}}/v1/marketplace/establishments/balance' \
  --header 'integration-key: sua_integration_key' \
  --header 'x-token: seu_x_token' \
  --header 'establishment_id: 0000' \
  --header 'Accept: application/json

Exemplo do response

{
    "total_balance": 5000000,
    "blocked_balance": 0,
    "balance": 5000000
}

Descrição dos Campos do Response

Campo	Tipo	Obrigatório	Descrição
`total_balance`	number	Sim	Saldo total do estabelecimento, somando valores disponíveis e bloqueados (em centavos).
`blocked_balance`	number	Sim	Saldo bloqueado, indisponível para saque ou transferência (em centavos).
`balance`	number	Sim	Saldo disponível para saque ou uso imediato (em centavos).

Para mais informações, consulte a documentação oficial da Paytime.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.