Skip to main content
GET
/
bank-accounts
/
{bankAccountHash}
Consultar Conta Bancária
curl --request GET \
  --url https://api.example.com/bank-accounts/{bankAccountHash}
{
  "200": {},
  "401": {},
  "404": {},
  "500": {}
}

​
Visão Geral

Este endpoint retorna os detalhes completos de uma conta bancária ou chave PIX específica cadastrada.

​
Endpoint

GET https://api.klivopay.com.br/api/public/v1/bank-accounts/{bankAccountHash}

​
Parâmetros

​
bankAccountHash
string
required
Hash identificador único da conta bancária
​
api_token
string
required
Seu token de autenticação da API KlivoPay

​
Exemplo de Requisição

curl -X GET 'https://api.klivopay.com.br/api/public/v1/bank-accounts/bank123abc?api_token=seu_token_aqui'

​
Resposta de Sucesso - PIX

200 OK
{
  "success": true,
  "data": {
    "hash": "bank123abc",
    "type": "pix",
    "pix_key_type": "cpf",
    "pix_key": "123.456.789-00",
    "status": "active",
    "created_at": "2025-01-15T10:00:00Z",
    "updated_at": "2025-01-15T10:00:00Z"
  }
}

​
Resposta de Sucesso - Conta Bancária

200 OK
{
  "success": true,
  "data": {
    "hash": "bank456def",
    "type": "bank",
    "bank_code": "001",
    "bank_name": "Banco do Brasil",
    "account_type": "checking",
    "account_number": "12345-6",
    "agency": "1234",
    "holder_name": "João Silva",
    "holder_document": "123.456.789-00",
    "status": "active",
    "created_at": "2025-01-10T14:30:00Z",
    "updated_at": "2025-01-10T14:30:00Z"
  }
}

​
Códigos de Resposta

​
200
OK
Conta bancária encontrada e retornada com sucesso
​
401
Unauthorized
Token de API inválido ou ausente
​
404
Not Found
Conta bancária não encontrada
​
500
Internal Server Error
Erro interno do servidor