Encerrar Inserção no Lote de Pagamento

Após inserir todas as liquidações desejadas no lote, utilize este endpoint para sinalizar que a inserção foi concluída e o processamento pode ser iniciado. Também é possível descartar o lote por completo.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Criar Lotes
Cedente	assignor-api	Escrita

URL base de cada host: Ambientes (Hosts).

Onde estou no fluxo?

Este é o 3º passo do fluxo de liquidação. Antes deste passo, você deve ter:

1. Criado o lote de pagamento
2. Inserido as liquidações

Request

ENDPOINT

/settlement/fund_class/{fund_class_key}/payment_batch/{external_id}

MÉTODO

PUT

Path params

Parâmetro	Tipo	Descrição
external_id	string	O external_id informado na criação do lote.

Request Body

{
    "batch_status": "pending_payment"
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
batch_status	string	obrigatório	Status para o qual o lote será atualizado. Veja enumeradores abaixo.

Enumeradores de batch_status

Valor	Descrição
pending_payment	Encerra a inserção e inicia o processamento do lote. Só é aceito com o lote em pending_settlements_insertion e com ao menos uma liquidação validated ou pending_validation.
discarded	Descarta o lote inteiro. Nenhuma liquidação será processada. Aceito com o lote em pending_settlements_insertion, pending_validation ou pending_payment.

Response

STATUS

200

Response Body

{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "status": "pending_payment"
}

Atributos da resposta

Campo	Tipo	Descrição
external_id	string	Chave externa do lote fornecida pelo parceiro.
status	string	Novo status do lote. Veja abaixo.

Status devolvido:

Você enviou	Status devolvido	O que significa
pending_payment	pending_payment	Lote encerrado; aguarda a confirmação do pagamento.
pending_payment	pending_validation	Há liquidações em revisão pela QI Tech. Quando a revisão terminar, o lote segue sozinho para pending_payment.
discarded	pending_discard ou pending_discard_on_cash_account	Descarte em processamento. O status final discarded chega pelo webhook do lote.

Próximos passos

Após encerrar o lote, o processamento é iniciado automaticamente. Acompanhe o resultado através dos webhooks ou da consulta do lote:

1. Webhooks do lote de pagamento — notificação quando o lote for pago, concluído ou descartado.
2. Webhooks das liquidações — notificação individual de cada liquidação processada.

Erros

Status	Código	Quando acontece
404	SET000005	A fund_class_key não existe.
403	SET000028	O fundo não pertence ao seu perfil (gestora do fundo, consultoria vinculada ou cedente associado).
404	SET000010	O lote informado na URL não existe neste fundo.
400	SET000026	batch_status diferente de pending_payment ou discarded.
400	SET000049	Pedido de encerramento para um lote já em pending_payment, paid ou completed.
400	SET000016	Pedido de encerramento para um lote fora de pending_settlements_insertion (por exemplo, em pending_validation ou em descarte).
400	SET000017	O lote não tem nenhuma liquidação validated ou pending_validation.
400	SET000069	Pedido de descarte para um lote já em status final (paid, completed ou discarded).

Erros de autenticação, permissão e host: veja Erros da API.