Recebíveis
Entenda a agenda de recebíveis e como acompanhar seus pagamentos futuros
O que são Recebíveis?
Recebíveis representam os valores que você tem a receber de cobranças processadas. Cada cobrança capturada gera um ou mais recebíveis, dependendo do método de pagamento e do número de parcelas.
Por exemplo, uma cobrança de R$ 300,00 em 3x no cartão de crédito gera 3 recebíveis de R$ 100,00 cada, com datas de liquidação diferentes.
Ciclo de Vida
| Status | Descrição |
|---|---|
pending | Recebível criado, aguardando processamento |
scheduled | Agendado para liquidação na data prevista |
settled | Liquidado (valor creditado na carteira) |
anticipated | Antecipado (recebido antes da data original) |
canceled | Cancelado (estorno ou chargeback) |
failed | Falha na liquidação |
Consultando Recebíveis
Listar todos
curl -X GET "https://api.payhubrasil.com.br/v1/receivables?status=scheduled&page=1&limit=20" \
-H "Authorization: Basic {credentials}"Filtros disponíveis
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | string | Filtrar por status |
payment_method | string | Filtrar por método de pagamento |
settlement_date_from | string | Data de liquidação inicial (ISO 8601) |
settlement_date_to | string | Data de liquidação final (ISO 8601) |
charge_id | string | Filtrar por cobrança específica |
Buscar um recebível
curl -X GET https://api.payhubrasil.com.br/v1/receivables/{id} \
-H "Authorization: Basic {credentials}"Resposta
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"charge_id": "660e8400-e29b-41d4-a716-446655440001",
"gross_amount": 10000,
"fee_amount": 350,
"net_amount": 9650,
"status": "scheduled",
"payment_method": "credit_card",
"installment"
Valores
Cada recebível contém três valores monetários (em centavos):
| Campo | Descrição |
|---|---|
gross_amount | Valor bruto da parcela |
fee_amount | Taxa cobrada pela SoarLabz |
net_amount | Valor líquido (bruto - taxa) |
Resumo de Recebíveis
Para ter uma visão geral dos seus recebíveis:
curl -X GET "https://api.payhubrasil.com.br/v1/receivables/summary?date_from=2026-01-01&date_to=2026-12-31" \
-H "Authorization: Basic {credentials}"Parâmetros do resumo
| Parâmetro | Tipo | Descrição |
|---|---|---|
date_from | string | Data inicial (ISO 8601) |
date_to | string | Data final (ISO 8601) |
period | string | Alternativa a date_from/date_to. Valores: today, week, month, year |
O parâmetro period é uma alternativa prática aos filtros date_from e date_to. Quando informado, o sistema calcula automaticamente o intervalo de datas correspondente.
{
"data": {
"total_gross_amount": 1500000,
"total_net_amount": 1425000,
"total_fee_amount": 75000,
"by_status": {
"scheduled": { "count": 45, "amount": 900000 },
"settled": { "count": 30, "amount"
Use os filtros de data para consultar a agenda de recebíveis futuros e planejar seu fluxo de caixa.