Consultar o saldo da conta

Esse endpoint é responsável por retornar o saldo atualizado da conta.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • account (object): Objeto contendo os dados da conta.
  • balance -> amount (float): Saldo disponível da conta.

Objeto "account":

  • name (string): Nome da conta.
  • bank_account(string): Número da conta.
  • cashout (object): Objeto contendo as chaves Pix cadastradas para transferências.
  • cashout -> pix -> key (string): Código da chave Pix.

Exemplo de JSON:

{
    "account": {
        "name": "<string>",
        "account": "<string>",
        "cashout": {
            "pix": {
                "key": "<string>"
            }
        }
    },
    "balance": {
        "amount": "<double>"
    }
}

Language
URL
Click Try It! to start a request and see the response here!