Poll - Void
Send a request using the poll method to display a void on a PAX POS device
uti
An id provided by the POS in a sale response. Used for message matching in a re-print.
amount
The amount represented with two minor units, e.g. 12 EUR is 1200.
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
hi_IN
is_IS
nb_NO
nl_NL
pi_PL
pt_PT
ru_RU
sl_SI
sv_SE
zh_CN
pollId
The ID used to poll after a terminal response
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
If the request has not reached the PAX POS device within this time, the request will be deleted and no reversal action is required by the caller. If not set the default value is 5 seconds
endStateApplication
Deprecated - Do not use. End state application is the name of the application that is supposed to be active on the pos device once the transaction has been processed.
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
/poll/void
202 Void Accepted
curl -X post https://CloudLinkApi/poll/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "amount": "100", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "pollId": "03aa1721-65ea-4db3-af51-d1294446238c", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "endStateApplication": null } '{ message: "Accepted" }
400 Bad Request
curl -X post https://CloudLinkApi/poll/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "amount": "100", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "pollId": "03aa1721-65ea-4db3-af51-d1294446238c", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "endStateApplication": 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/poll/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "amount": "100", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "pollId": "03aa1721-65ea-4db3-af51-d1294446238c", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "endStateApplication": null } '{ "message": "Unauthorized" }
500 Server Error
curl -X post https://CloudLinkApi/poll/void -H 'X-API-KEY: your-access-key-here' -d ' { "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566", "amount": "100", "disablePrinting": true, "referenceId": "merchant-ref-number-abc123", "language": "en_GB", "voucherCode": null, "whitelistAids": null, "whitelistBins": null, "callbackUrl": "http://example.com/webhook-endpoint", "deviceToken": "b16526c3447ba6cea4818d", "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda", "timeToLive": 5, "endStateApplication": null } '{ "message": "Server Error" }