Consultar Conta Bancária
curl --request GET \
--url https://api.example.com/bank-accounts/{bankAccountHash}import requests
url = "https://api.example.com/bank-accounts/{bankAccountHash}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/bank-accounts/{bankAccountHash}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/bank-accounts/{bankAccountHash}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/bank-accounts/{bankAccountHash}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/bank-accounts/{bankAccountHash}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/bank-accounts/{bankAccountHash}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"200": {},
"401": {},
"404": {},
"500": {}
}Contas Bancária
Consultar Conta Bancária
Consulta os detalhes de uma conta bancária específica
GET
/
bank-accounts
/
{bankAccountHash}
Consultar Conta Bancária
curl --request GET \
--url https://api.example.com/bank-accounts/{bankAccountHash}import requests
url = "https://api.example.com/bank-accounts/{bankAccountHash}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/bank-accounts/{bankAccountHash}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/bank-accounts/{bankAccountHash}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/bank-accounts/{bankAccountHash}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/bank-accounts/{bankAccountHash}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/bank-accounts/{bankAccountHash}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
Hash identificador único da conta bancária
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'
const bankAccountHash = 'bank123abc';
const response = await fetch(
`https://api.klivopay.com.br/api/public/v1/bank-accounts/${bankAccountHash}?api_token=seu_token_aqui`
);
const data = await response.json();
console.log(data);
import requests
bank_account_hash = 'bank123abc'
url = f'https://api.klivopay.com.br/api/public/v1/bank-accounts/{bank_account_hash}'
params = {'api_token': 'seu_token_aqui'}
response = requests.get(url, params=params)
print(response.json())
<?php
$bankAccountHash = 'bank123abc';
$url = "https://api.klivopay.com.br/api/public/v1/bank-accounts/{$bankAccountHash}?api_token=seu_token_aqui";
$response = file_get_contents($url);
print_r(json_decode($response));
?>
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
Conta bancária encontrada e retornada com sucesso
Token de API inválido ou ausente
Conta bancária não encontrada
Erro interno do servidor
⌘I