Consultar informação da conta

Esse endpoint é responsável por retornar os detalhes com os dados de uma conta bancária de um financiador.

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 (string): Nome da conta.
  • status_account (string): Status da conta.
  • client_code (string): Código do cliente titular da conta.
  • document_number (string): Número do documento de identificação do titular da conta.
  • business_phone_number (string): Número de telefone comercial.
  • business_email (string): E-mail comercial para contato.
  • create_date (datetime): Data de cadastro da conta.
  • business_name (string): Razão social da empresa.
  • trading_name (string): Nome da empresa.
  • bank_account(string): Número da conta.
  • bank_branch (string): Número da agência.
  • pix_keys (object): Objeto contendo os dado das chaves Pix.
  • pix_keys -> key_type (string): Tipo da chave Pix.
  • pix_keys -> key (string): Código da chave Pix.
  • cashout (object): Objeto contendo as chaves Pix cadastradas para transferências.
  • cashout -> pix -> key (string): Código da chave Pix.

Exemplo de JSON:

{
    "account": "",
    "status_account": "",
    "client_code": "",
    "document_number": "",
    "business_phone_number": "",
    "business_email": "",
    "create_date": "",
    "business_name": "",
    "trading_name": "",
    "bank_account": "",
    "bank_branch": "",
    "pix_keys": [
        {
            "key_type": "",
            "key": ""
        }
    ],
    "cashout": {
        "pix": {
            "key": ""
        }
    }
}

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