Pular para o conteúdo principal

Recebimentos

GET/v1/payments

Os recebimentos (créditos pagos pelas adquirentes) do cliente, criados ou alterados a partir de uma data, em páginas numeradas. Funciona igual às vendas: mesmos parâmetros de página e mesmas regras.

Autenticação: Authorization: Bearer <access_token> e X-Company-Token: <company_token>.

Parâmetros de consulta​

ParâmetroTipoPadrãoDescrição
updated_sincedata e hora ISO 8601Recebimentos criados ou alterados a partir deste instante (inclusive). Sem ele, vêm todos os recebimentos dos últimos 90 dias e os futuros. Não pode estar mais de 5 minutos no futuro.
pageinteiro1Número da página, de 1 a 10000.
page_sizeinteiro500Itens por página, de 1 a 1000.
acquirerstringSó uma adquirente: REDE, STONE, PAGBANK ou CIELO.
merchant_codestringSó um estabelecimento. Até 60 caracteres.
date_fromdata YYYY-MM-DD90 dias atrásRecebimentos com payment_date a partir deste dia. Não pode ser anterior a 90 dias atrás.
date_todata YYYY-MM-DDRecebimentos com payment_date até este dia. Não pode ser anterior a 90 dias atrás.

:::info Últimos 90 dias A API entrega só vendas e recebimentos com data de até 90 dias atrás (no horário de Brasília). Recebimentos com crédito previsto para o futuro aparecem normalmente. date_from ou date_to antes desse limite dão 400. :::

:::tip Todos os recebimentos de um dia Sem updated_since e com date_from e date_to, vêm todos os recebimentos creditados no período. Veja Consultar um dia ou período. :::

curl "$BASE_URL/v1/payments?updated_since=2026-10-01T00:00:00Z&page=1&page_size=1000" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "X-Company-Token: $COMPANY_TOKEN"

Resposta 200​

{
"message": "Recebimentos",
"result": true,
"data": {
"items": [
{
"id": "51877",
"acquirer": "REDE",
"merchant_code": "12345678",
"payment_id": "202610020000123",
"payment_date": "2026-10-02",
"status": "PAID",
"type": "CREDIT",
"type_negotiation": null,
"brand_code": "1",
"bank_code": "341",
"bank_branch": "1234",
"bank_account": "567890",
"net_amount": "4820.370000",
"settlement_code": null,
"updated_at": "2026-10-02T09:41:27.106533Z"
}
],
"page": 1,
"page_size": 1000,
"has_more": false,
"next_updated_since": "2026-10-21T15:42:10.000Z"
},
"error": null
}

page, page_size, has_more e next_updated_since funcionam como nas vendas.

Recebimento​

CampoTipoDescrição
idstringIdentificador do recebimento no Concilia+. Estável. Use para deduplicar.
acquirerstringAdquirente: REDE, STONE, PAGBANK ou CIELO.
merchant_codestringCódigo do estabelecimento na adquirente.
payment_idstringIdentificador do pagamento na adquirente.
payment_datestring YYYY-MM-DDData do crédito.
statusstringSituação, por exemplo PAID, PENDING ou SUSPENDED.
typestring ou nullTipo do lançamento, por exemplo CREDIT.
type_negotiationstring ou nullPreenchido quando o recebível foi negociado ou cedido (antecipação, cessão). Nesse caso o dinheiro pode ter ido para outra conta.
brand_codestring ou nullCódigo da bandeira.
bank_codestring ou nullCódigo do banco do domicílio.
bank_branchstring ou nullAgência.
bank_accountstring ou nullConta.
net_amountstring decimalValor líquido creditado, em reais.
settlement_codestring ou nullCódigo da liquidação (saque) que pagou o recebimento, quando a adquirente informa (PagBank).
updated_atstring ISO 8601Última alteração do recebimento no Concilia+ (UTC, com microssegundos).

Comportamento importante​

As mesmas regras das vendas:

  • Um recebimento alterado (por exemplo, de PENDING para PAID) volta a aparecer: faça upsert pelo id.
  • Pode haver repetição, dentro da rodada e nos 30 segundos de sobreposição entre rodadas; nenhum recebimento é pulado.
  • Nada é apagado.
  • Vendas e recebimentos têm rodadas separadas. Guarde um updated_since para cada feed de cada cliente.

Erros​

CódigoQuando
400Parâmetros inválidos, como no feed de vendas.
401Token de acesso ou company_token ausente, vencido, revogado ou inválido.
429Limite por minuto excedido.