Skip to main content

Remoção de Liquidações

Request​

ENDPOINT
/settlement/fund_class/FUND_CLASS_KEY/payment_batch/EXTERNAL_ID/settlement/SETTLEMENT_EXTERNAL_ID
MÉTODO
PUT
Request Body
{
    "status": "discarded", 
}
Informação

O campo SETTLEMENT_EXTERNAL_ID no endpoint da requisição se refere ao identificador da Liquidação e o campo EXTERNAL_ID se refere ao identificador do Lote

Response​

STATUS
200
Request Body
{ 
    "external_id": "6299b801-a272-4b5a-a766-70ceb8e273a8",
    "status": "discarded"
}

Possíveis erros​


STATUS
404
Response Body
{
  "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
400
Response Body
{
  "title": "Invalid status",
  "description": "The status given: {status} is not suported.",
  "translation": "O status: {status} não possui suporte.",
  "code": "SET000026"
}


STATUS
400
Response Body
{
  "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
400
Response Body
{
  "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"
}