Home
API Reference

Refund a purchase

POST

/purchaserequests/{id}/refund

https://[api-endpoint-environment]/purchaserequests/{id}/refund

Refunds a purchase request partially or in full. The field refundAmount specifies how much of the purchase request to refund. This can be less than or equal to the full purchase request amount. This service supports the Client-Request-Id idempotency header 

{
  "refCode": "6ifb67bf76faaa",
  "refundAmount": 4.99,
  "originator": {
    "locationId": "{{locationId}}",
    "deviceRefCode": "205203",
    "staffActor": {
      "refCode": "3071"
    }
  }
}
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.

  • refundAmount REQUIRED INTEGER

    Refund amount.

  • refCode REQUIRED STRING

    Transaction reference ID.