跳到主要内容

Listar repasses

Superfície ainda não disponível

Os endpoints financeiros descritos nesta seção ainda não estão publicados no gateway externo. Esta seção descreve o contrato-alvo e pode mudar antes da liberação — confirme a disponibilidade com o time de Integração (api@qitech.com.br) antes de implementar contra ela.

Retorna a lista paginada dos repasses de comissão executados (ou em execução) para a sua conta.

Request

ENDPOINT
/finance/v1/transfers
MÉTODO
GET

Query params

ParâmetroTipoObrigatoriedadeDescrição
pageintegeropcionalNúmero da página. Padrão: 1.
page_sizeintegeropcionalRegistros por página. Padrão: 50. Máximo: 200.
statusstringopcionalFiltra pelo status do repasse.
Exemplo de chamada
GET /finance/v1/transfers?status=SETTLED&page=1

Response

STATUS
200
Response Body
{
"items": [
{
"transfer_key": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
"amount": "980.10",
"status": "SETTLED",
"scheduled_date": "2026-07-21",
"settled_at": "2026-07-21T09:00:12.000Z"
},
{
"transfer_key": "4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a",
"amount": "1250.40",
"status": "PENDING",
"scheduled_date": "2026-07-28",
"settled_at": null
}
],
"page": 1,
"page_size": 50,
"total": 2
}

Atributos da resposta

CampoTipoDescrição
itemsarrayRepasses, do mais recente para o mais antigo.
pageintegerPágina atual.
page_sizeintegerTamanho da página solicitado.
totalintegerTotal de repasses que atendem aos filtros.

Objeto em items

CampoTipoDescrição
transfer_keystringChave única do repasse — a mesma referenciada nas movimentações TRANSFER_SETTLED do extrato.
amountstringValor líquido do repasse (créditos carregados menos estornos compensados).
statusstringStatus do repasse. Veja a tabela abaixo.
scheduled_datestringData programada da execução.
settled_atstringInstante da liquidação. null enquanto não liquidado.

Status do repasse

StatusSignificado
PENDINGRepasse montado, aguardando execução na data programada.
PROCESSINGInstrução de transferência enviada, aguardando liquidação.
SETTLEDLiquidado na sua conta. Status terminal.
FAILEDA transferência falhou; será reprocessada. Os valores retornam à sua posição disponível até a nova tentativa.

Possíveis erros

StatusDescrição
400Parâmetro de filtro ou paginação inválido.
401 / 403Falha de autenticação ou autorização.
500 / 503Erro interno ou serviço indisponível — seguro repetir a chamada.