Void
Send a request to display a void on a PAX POS device.
For a void transaction, the client must provide the uti (Unique Transaction Identifier) from the original transaction response.
Upon receiving the request, the CloudLink API forwards it to the terminal, which immediately triggers a SALE_RECEIVED event sent to the provided callbackUrl. The terminal then processes the void using the provided UTI and triggers a final SALE_VOIDED callback event (not SALE_COMPLETED).
uti
An id provided by the POS in a sale response. Used for message matching in a re-print.
disablePrinting
Indicates if to print a receipt.
referenceId
Optional reference from merchants.
language
The language that the PAX POS will use to display information on the device. One of the following:
en_GB
ar_EG
da_DK
de_DE
es_ES
fi_FI
fr_FR
hi_IN
is_IS
it_IT
nb_NO
nl_NL
pl_PL
pt_PT
ru_RU
sl_SI
sv_SE
zh_CN
callbackUrl
The URL that CloudLinkApi will use to return information to the caller.
deviceToken
The token of a PAX POS device.
correlationId
An ID provided by the caller. Returned in the callback for message matching. In a cancel request, use the value from the sale/refund that is being canceled.
timeToLive
The maximum time, in seconds, for a request to reach the physical terminal. The default value is 5 seconds.
terminalId
If terminal has more than one merchant, this field is used to identify the merchant. To get a list of merchants, use the requestMerchantConfig request. Value can be null.
type
Example: https://tools.ietf.org/html/rfc7231#section-6.5.1
title
One or more validation errors occurred.
status
400
errors
Object with one or more errors. Example: "The Uti field is required."
message
Unauthorized
message
Server Error
/void
202 Void Accepted
curl -X post https://CloudLinkApi/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "callbackUrl": "http://example.com/webhook-endpoint", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Accepted" }
400 Bad Request
curl -X post https://CloudLinkApi/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "callbackUrl": "http://example.com/webhook-endpoint", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "errors": { "Uti": [ "The Uti field is required." ] } }
401 Unauthorized
curl -X post https://CloudLinkApi/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "callbackUrl": "http://example.com/webhook-endpoint", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Unauthorized" }
500 Server Error
curl -X post https://CloudLinkApi/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "callbackUrl": "http://example.com/webhook-endpoint", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "terminalId": null } '{ "message": "Server Error" }