Remoção de Liquidações
Endpoint para descartar uma liquidação individual previamente inserida em um lote de pagamento. Somente liquidações em lotes que ainda não foram encerrados podem ser removidas.
Use este endpoint quando precisar remover uma liquidação incorreta ou indesejada antes de encerrar o lote. Após o encerramento do lote, não é possível remover liquidações individuais.
Request
Path params
| Parâmetro | Tipo | Descrição |
|---|---|---|
external_id | string | O external_id do lote de pagamento. |
settlement_external_id | string | O external_id da liquidação que será descartada. |
{
"status": "discarded"
}
Atributos do body
| Campo | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
status | string | obrigatório | Novo status da liquidação. Para descartar, envie discarded. |
Response
{
"external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"status": "discarded"
}
Atributos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
external_id | string | Chave externa da liquidação fornecida pelo parceiro. |
status | string | Novo status da liquidação: discarded. |
Possíveis erros
Liquidação não encontrada
O settlement_external_id informado na URL não corresponde a nenhuma liquidação cadastrada neste lote. Verifique se os identificadores do lote e da liquidação estão corretos.
{
"title": "Settlement not found",
"description": "The Settlement with external_id {external_id} was not found",
"translation": "A Liquidação com identificador externo {external_id} não foi encontrada",
"code": "SET000011"
}
Status inválido
O valor informado no campo status não é válido. Para remoção, utilize apenas discarded.
{
"title": "Invalid status",
"description": "The status given: {status} is not suported.",
"translation": "O status: {status} não possui suporte.",
"code": "SET000026"
}
Lote já encerrado
O lote de pagamento já foi encerrado e não permite mais alterações nas liquidações. Não é possível remover liquidações de lotes que já passaram do status pending_settlements_insertion.
{
"title": "Payment Batch Status mismatch",
"description": "Payment batch of key: {payment_batch_key} with status: {current} was expected to be: {expected}",
"translation": "O lote de pagamento com chave: {payment_batch_key} e com status: {current} não passou, era esperado que fosse: {expected}",
"code": "SET000016"
}
Status da liquidação incompatível
A liquidação está em um status que não permite ser descartada. Apenas liquidações com status validated podem ser removidas.
{
"title": "Settlement type mismatch",
"description": "The settlement given has the status: {current_status} and was expected: {expected_status}",
"translation": "A liquidação com status: {current_status} era esperado ter: {expected_status}",
"code": "SET000024"
}