GuidesAPI Reference

/orders/{orderId}/void

post https://gateway.us.zip.co/orders//void

Voids uncaptured funds for the specified order and allocates them to the payment plan to apply it to the customer. Only applicable to pay-on-ship/deferred fund capture merchants. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.

Important Notes

Example — "Success: True" Response 

{
    “Amount”: 1.0, 
    “Currency”: “USD”,
    “MerchantId”: “c6194164-f330-4505-acd1-3e38e8615175”,
    “MerchantReference”: “VO”,
    “Operation”: “VoidOrder”,
    “OrderId”: “c1a083ae-e603-460c-8a0e-70d6e854cf77”, 
    “Success”: True,
    “Test”: False,
    “Timestamp”: “2022-02-25T15:00:43.8391167Z”
}

Example — "Success: False" Response

The amount to be voided must be less than or equal to the amount left to void, or a "Success: False" message will be given.

{	
    “Amount”: 300, 
    “Currency”: “USD”,
    “MerchantId”: “c6194164-f330-4505-acd1-3e38e8615175”,
    “MerchantReference”: “V”,
    “Operation”: “VoidOrder”,
    “Message”: Amount to be voided ($300.0) is greater than $20.05 available for void."
    “OrderId”: “c1a083ae-e603-460c-8a0e-70d6e854cf77”, 
    “Success”: False,
    “Test”: False,
    “Timestamp”: “2022-02-25T15:00:43.8391167Z”
}
Language