Callbacks

All of the endpoints listed above include a callbackUrl parameter. This URL will be used by Zip to update you on the result of each of these operations. The content of this webhook is as follows:

{
    "timestamp": "2020-04-27T12:34:56.000000Z",
    "merchantId": "44444444-4444-4444-4444-444444444444",
    "orderId": "11111111-1111-1111-1111-111111111111",
    "currency": "USD",
    "amount": 123.45,
    "merchantReference": "1234-abc",
    "test": false,
    "success": true,
    "metadata": {
      "property1": "value1"
    }

The merchantReference value will match the value you provided for the original operation. You also may pass metadata properties to add other important attributes you may need to use to identify your order.

Each of these callbacks will have a `X-QP-Signature header that contains the signature that you can use to verify and trust the HTTP request.

These callbacks are issued for every operation (order authorization, refund, void, and capture transactions).

Important! This data will also be provided to you as query string parameters on your supplied confirm URL when creating an order. You can use this to verify order completion within your system by verifying the signature and utilizing the other parameters to store the Zip order ID. Here is a sample URL showing how this information is added. Also note that we pass you the Zip customer information as part authorize order callbacks:

https://yoursite.com/order/complete?timestamp=04%2F27%2F2020%2023%3A27%3A22&merchantId=44444444-4444-4444-4444-444444444444&orderId=11111111-1111-1111-1111-111111111111&currency=USD&amount=123.45&merchantReference=1234-abc&test=False&success=True&customer.firstName=Test&customer.lastName=Test&[email protected]&customer.phone=%2B15555555555&customer.address.line1=123%20Main%20St&customer.address.city=New%20York&customer.address.state=NY&customer.address.postalCode=10000&customer.address.country=US&X-QP-Signature=PdkC29bSMbRG5DR6E0xQt781AgvaZa6Ov9V26Ez2OHU%3D