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.

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.
discarded	Descarta o lote inteiro. Nenhuma liquidação será processada.

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.

Possíveis erros

STATUS

404

Lote não encontrado

O external_id informado na URL não corresponde a nenhum lote cadastrado para este fundo. Verifique se o identificador está correto.

{
  "title": "Payment batch not found",
  "description": "The Payment Batch with external_id {payment_batch_external_id} was not found",
  "translation": "O Lote de Pagamento com identificador externo {payment_batch_external_id} não foi encontrado",
  "code": "SET000010"
}

STATUS

400

Status inválido

O valor informado no campo batch_status não é válido. Utilize apenas pending_payment ou discarded.

{
  "title": "Invalid status",
  "description": "The status given: {status} is not suported.",
  "translation": "O status: {status} não possui suporte.",
  "code": "SET000026"
}

STATUS

400

Lote sem liquidações

Você tentou encerrar o lote, mas ele ainda não possui nenhuma liquidação inserida. É necessário inserir pelo menos uma liquidação antes de encerrar o lote.

{
  "title": "Payment Batch with no settlement",
  "description": "Payment batch of external_id: {payment_batch_external_id} have no settlements to be settled",
  "translation": "O lote de pagamento com identificador: {payment_batch_external_id} não possui liquidações",
  "code": "SET000017"
}

Próximos passos

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

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