Home
API Reference

Void a purchase

POST

/purchaserequests/void

https://[api-endpoint-environment]/purchaserequests/void
Marks a purchase request as void, reversing any captured transactions on the customer's account for this purchase request. To support error scenarios you do not need to know the purchase request id to void, only the unique merchant reference code created by the caller. 
{
  "refCode": "XXXXXXXX-SomeRandomText-XXXXXX",
  "originator": {
    "locationId": "612044",
    "deviceRefCode": "OnlinePoS",
    "staffActor": {
      "refCode": "ZipPayAgent"
    }
  }
}
Request parameters

  • originator JSON Object REQUIRED

    Shopper information object

    • originator.locationId REQUIRED INTEGER

      Store location ID supplied by Zip.

    • originator.deviceRefCode REQUIRED STRING

      ID of the device where the transaction is taking place. Pass "null" if not available

    • originator.staffActor JSON Object

      ID of the staff who is procesing the trsnsaction. Pass "null" if not available.

      • originator.staffActor.refCode REQUIRED STRING

        ID of the staff who is procesing the trsnsaction. Pass "null" if not available.

  • refCode REQUIRED STRING

    Transaction reference ID provided in the original purchase request.