Skip to main content
POST
/
bank-accounts
Cadastrar Conta Bancária
curl --request POST \
  --url https://api.example.com/bank-accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_token": "<string>",
  "type": "<string>",
  "pix_key_type": "<string>",
  "pix_key": "<string>",
  "bank_code": "<string>",
  "account_type": "<string>",
  "account_number": "<string>",
  "agency": "<string>",
  "holder_name": "<string>",
  "holder_document": "<string>"
}
'
{
  "201": {},
  "400": {},
  "401": {},
  "422": {},
  "500": {}
}

​
Visão Geral

Este endpoint permite cadastrar uma conta bancária ou chave PIX para receber transferências dos valores disponíveis em sua conta KlivoPay.

​
Endpoint

POST https://api.klivopay.com.br/api/public/v1/bank-accounts

​
Parâmetros

​
api_token
string
required
Seu token de autenticação da API KlivoPay
​
type
string
required
Tipo de conta: pix ou bank

​
Parâmetros para PIX (type = “pix”)

​
pix_key_type
string
Tipo de chave PIX: cpf, cnpj, email, phone, random
​
pix_key
string
Valor da chave PIX

​
Parâmetros para Conta Bancária (type = “bank”)

​
bank_code
string
Código do banco (3 dígitos). Exemplo: 001 para Banco do Brasil
​
account_type
string
Tipo de conta: checking (corrente) ou savings (poupança)
​
account_number
string
Número da conta com dígito
​
agency
string
Número da agência
​
holder_name
string
Nome completo do titular da conta
​
holder_document
string
CPF ou CNPJ do titular (apenas números)

​
Exemplo de Requisição

curl -X POST 'https://api.klivopay.com.br/api/public/v1/bank-accounts' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_token": "seu_token_aqui",
    "type": "pix",
    "pix_key_type": "cpf",
    "pix_key": "12345678900"
  }'

​
Resposta de Sucesso

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

​
Códigos de Resposta

​
201
Created
Conta bancária cadastrada com sucesso
​
400
Bad Request
Dados inválidos na requisição
​
401
Unauthorized
Token de API inválido ou ausente
​
422
Unprocessable Entity
Erro de validação nos dados enviados
​
500
Internal Server Error
Erro interno do servidor
Você pode cadastrar múltiplas contas bancárias e escolher qual usar para cada saque.
Contas PIX geralmente processam saques mais rapidamente (até 1 hora) comparado a transferências bancárias tradicionais (1-3 dias úteis).