Order operations

Void an order

Cancels a transaction on the order before it settles — the clean undo while the money has not actually moved yet. Use it to cancel a pay, an authorization, a capture or a refund; pass the targetTransactionId you got back from the transaction you are cancelling. Once the transaction has settled, void no longer applies and you need a refund instead.

The same operation as PUT /v3/orders/{orderId} with apiOperation: VOID. The checkout host forwards to this exact route without applying any authentication of its own, so the two are interchangeable.

Send your secret key in the Authorization header. Like refund, this requires the refund permission on the key's role.

put/v3/payment/void/{orderId}

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v3/payment/void/{orderId}
  • Auth: API key in header Authorization

Path parameters

orderIdstring required

Kashier's order id.

Request body

apiOperation'VOID' required

Should be VOID to be able to make a void request

Response

The void result. A successful void leaves the order at CANCELLED.

responseobject
transactionIdstring
statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.