Skip to main content

Cancel

Cancel Request#

Content-Type: application/json

KeyRequired?TypeExample
gatewayReference
Note:
unique reference of the payment assigned by Latitude Checkout.
Also used for order management requests - Void, Capture and Refund.
The *complete URL used on redirect, will also contain this field in the query string
Yesstring
max length 128
906f5b69-255d-4f26-a81f-ca0d2c47fe35

Cancel Response#

Content-Type: application/json

KeyTypeExample
result
Note: completed – Cancel request approved
failed – Cancel request declined/has errors
string
values completed, failed
completed
errorstringtransaction_was_already_cancelled
unexpected_error

Sample cancel response for approved request
{"result":"completed","error":""}

Sample cancel response if duplicate cancellation request was received
{"result":"failed","error":"transaction_was_already_cancelled"}

Sample cancel response when cancel request is invalid
{"result":"failed","error":"unexpected_error"}