Configuração
Recebedores
Como configurar dados bancários e de recebimento para saques
O que são Recebedores?
Recebedores são os dados de destino para saques. Você pode cadastrar diferentes tipos de recebedores para receber seus pagamentos:
| Tipo | Descrição |
|---|---|
bank_account | Conta bancária (para saques via TED) |
pix | Chave PIX (para saques via PIX) |
crypto | Carteira de criptomoedas (para saques em cripto) |
Cada tipo possui no máximo um recebedor primário. Ao criar ou atualizar, o recebedor existente do mesmo tipo é substituído.
Cadastrando um Recebedor
O endpoint PUT /v1/recipients funciona como upsert: cria um novo recebedor ou atualiza o existente para o tipo informado.
Conta Bancária
curl -X PUT https://api.payhubrasil.com.br/v1/recipients \
-H "Authorization: Basic {credentials}" \
-H "Content-Type: application/json" \
-d '{
"type": "bank_account",
"bank_code": "001",
"branch_number": "1234",
"account_number": "567890",
"account_check_digit": "1",
"account_type": "checking",
"holder_name": "João Silva ME",
"holder_tax_id": "12345678000190"
}'const response = await fetch('https://api.payhubrasil.com.br/v1/recipients', {
method: 'PUT',
headers: {
'Authorization': `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify
Campos da Conta Bancária
| Campo | Obrigatório | Descrição |
|---|---|---|
type | Sim | bank_account |
bank_code | Sim | Código do banco (1-10 caracteres) |
branch_number | Sim | Número da agência |
branch_check_digit | Não | Dígito da agência |
account_number | Sim | Número da conta |
account_check_digit | Não | Dígito da conta |
account_type | Sim | checking (corrente) ou savings (poupança) |
holder_name | Sim | Nome do titular |
holder_tax_id | Sim | CPF ou CNPJ do titular |
Chave PIX
curl -X PUT https://api.payhubrasil.com.br/v1/recipients \
-H "Authorization: Basic {credentials}" \
-H "Content-Type: application/json" \
-d '{
"type": "pix",
"pix_key": "12345678000190",
"pix_key_type": "cnpj"
}'Campos da Chave PIX
| Campo | Obrigatório | Descrição |
|---|---|---|
type | Sim | pix |
pix_key | Sim | Chave PIX |
pix_key_type | Sim | cpf, cnpj, email, phone ou random |
Carteira de Criptomoedas
curl -X PUT https://api.payhubrasil.com.br/v1/recipients \
-H "Authorization: Basic {credentials}" \
-H "Content-Type: application/json" \
-d '{
"type": "crypto",
"crypto_currency": "USDT",
"crypto_network": "tron",
"crypto_wallet": "TXyz1234567890abcdef"
}'Campos da Carteira Cripto
| Campo | Obrigatório | Descrição |
|---|---|---|
type | Sim | crypto |
crypto_currency | Sim | Moeda (ex: BTC, ETH, USDT) |
crypto_network | Sim | Rede blockchain (ex: tron, ethereum) |
crypto_wallet | Sim | Endereço da carteira |
Consultando Recebedores
Listar todos
curl -X GET https://api.payhubrasil.com.br/v1/recipients \
-H "Authorization: Basic {credentials}"Buscar por tipo
curl -X GET https://api.payhubrasil.com.br/v1/recipients/bank_account \
-H "Authorization: Basic {credentials}"Os dados sensíveis do recebedor (como número da conta) podem ser parcialmente mascarados na resposta por segurança.