Consultar prévia de cancelamento

Consulta prévia dos valores de reembolso antes de cancelar uma ordem. Retorna informações detalhadas sobre valor total a ser reembolsado, taxas de cancelamento, descontos aplicáveis e valores de seguro e taxas de serviço. Permite que parceiros exibam ao cliente os valores que serão reembolsados antes de confirmar o cancelamento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Observações

  • items: string CSV com os IDs dos itens/tickets. Exemplo: "1111,2222,3333".
  • refundOption: ORIGINAL_PAYMENT_METHOD (padrão) ou WALLET_CLICKBUS.

Exemplos de respostas

200 - Sucesso (pode cancelar com taxa)

{
  "totalAmount": 150.00,
  "insuranceAmount": 15.00,
  "feeAmount": 7.50,
  "cancelationFeeAmount": 20.00,
  "discountAmount": 0.00,
  "refundAmount": 130.00
}

200 - Sucesso (sem taxa)

{
  "totalAmount": 100.00,
  "insuranceAmount": 10.00,
  "feeAmount": 5.00,
  "cancelationFeeAmount": 0.00,
  "discountAmount": 0.00,
  "refundAmount": 95.00
}

200 - Não pode cancelar

{
  "totalAmount": 0.00,
  "insuranceAmount": 0.00,
  "feeAmount": 0.00,
  "cancelationFeeAmount": 0.00,
  "discountAmount": 0.00,
  "refundAmount": 0.00
}

400 - Requisição inválida

{
  "code": "400",
  "message": "Bad Request",
}

404 - Ordem não encontrada

{
  "code": "404",
  "message": "Not Found",
  "details": "Order with id QMTL04R2 not found"
}

500 - Erro interno

{
  "code": "500",
  "message": "Internal Server Error",
  "details": "An unexpected error occurred"
}
Path Params
string
required

ID único da ordem (publicId)

Query Params
string
required

IDs dos itens/tickets a cancelar, separados por vírgula (CSV).

string
enum

Opção de reembolso

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json