Cancel Instore Order v2

For paymentType of payment (default)

  • If the order is in a Created or Paired state, this will cancel or rollback the in-store code
  • If the order has been paid and is in a Complete state, this will refund the order
  • If the order is in a Rollback, Cancelled, Declined or Expired state, no further action is required

For paymentType of auth

  • If the order is in an Approved state, this will rollback the in-store code
  • If the order is in a Commit state, this will refund the order
📘

A customer's in-store code can only be cancelled/rolled-back if they have yet to approve the order on the Zip app

Path Params
string
required

orderId returned from Create Order endpoint

Body Params
string
required
Defaults to John Smith

Current Point of Sale terminal operator

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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