Cancela um pedido
POST /api/v2/orders/{order_code}/cancel
POST
/api/v2/orders/{order_code}/cancel
Altera o status do pedido para cancelado
Authorizations
Seção intitulada “Authorizations ”Parameters
Seção intitulada “ Parameters ”Path Parameters
Seção intitulada “Path Parameters ” order_code
required
string
Código identificador (code) ou token do pedido
Request Body
Seção intitulada “Request Body ”object
cancelation_data
Parâmetro para incluir uma confirmação de estorno de pagamento para o cliente. Para pedidos com pagamento via cartão de crédito, é obrigatório que nesse campo seja incluído no parâmetro o retorno da requisição de estorno de pagamento.
string
Responses
Seção intitulada “ Responses ”Pedido cancelado
object
Parâmetros enviados inválidos
422
Erro de validação na criação e atualização de registros
object
errors
object
{field}
Array<string>
Headers
Seção intitulada “Headers ” X-Request-Id
string
Código Identificador ID da requisição