DesenvolvedoresReferência da APIPedidos
Cancelar pedido
POST
Cancela um pedido que ainda aguarda pagamento: as cobranças abertas são canceladas e o estoque e o cupom reservados voltam. Só pedido com situação efetiva pending pode ser cancelado; qualquer outro, inclusive o pedido com expiresAt vencido (que já aparece como expired), responde 409 conflict. Pedido pago se resolve com reembolso (POST /refunds).
Chave: Só chave secreta (chamada pelo servidor).
Escopo: orders:write.
Idempotência: aceita o cabeçalho Idempotency-Key.
chaveSecretaheader
AutorizaçãoBearer <chave de API>Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.
orderId*stringFormato
uuidIdempotency-Key?stringDe 1 a 255 caracteres visíveis. Repetir a chamada com a mesma chave devolve a mesma resposta por 24 horas.
application/json- body
reason?stringTamanho
length <= 500Sucesso.
application/json- response
data*meta*curl -X POST 'https://minepag.com.br/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": -9007199254740991, "externalId": "string", "status": "pending", "paymentStatus": "pending", "source": "checkout", "environment": "sandbox", "currency": "BRL", "subtotal": -9007199254740991, "discountTotal": -9007199254740991, "total": -9007199254740991, "refundedTotal": -9007199254740991, "customer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "name": "string" }, "metadata": { "property1": null, "property2": null }, "createdAt": "2019-08-24T14:15:22Z", "paidAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "cancelledAt": "2019-08-24T14:15:22Z", "refundedAt": "2019-08-24T14:15:22Z" }, "meta": { "requestId": "string" }}