Skip to main content

Documentation

Poll - Sale

Send a request using the poll method to display a sale on a PAX POS device.

Parameters
Request Header Parameters
Request Body Parameters

    • 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

    • The token of a PAX POS device.

    • 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.

202 Accepted Response
400 Error Response

    • type

    • Example: https://tools.ietf.org/html/rfc7231#section-6.5.1

    • title

    • Bad Request

    • status

    • 400

    • detail

    • DeviceId not registered

401 Error Response

    • message

    • Unauthorized

500 Error Response

    • message

    • Server Error

  • /poll/sale

  • 202 Accepted Poll Sale

  • curl -X
post https://CloudLinkApi/poll/sale
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "disablePrinting": true,
  "referenceId": "merchant-ref-number-abc123",
  "language": "en_GB",
  "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "endStateApplication": null
}
' 
  • {
"description": "Accepted"	
}

  • 400 Bad Request

  • curl -X
post https://CloudLinkApi/poll/sale
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "disablePrinting": true,
  "referenceId": "merchant-ref-number-abc123",
  "language": "en_GB",
  "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "endStateApplication": null
}
'
  • {
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "DeviceId not registered"
}

  • 401 Unauthorized Sale

  • curl -X
post https://CloudLinkApi/poll/sale
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "disablePrinting": true,
  "referenceId": "merchant-ref-number-abc123",
  "language": "en_GB",
  "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "endStateApplication": null
}
' 
  • {
  "message": "Unauthorized"
}

  • 500 Server Error

  • curl -X
post https://CloudLinkApi/poll/sale
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "disablePrinting": true,
  "referenceId": "merchant-ref-number-abc123",
  "language": "en_GB",
  "pollId": "e855e0cf-a026-4614-9dcb-58814455b6a4",
  "deviceToken": "b16526c3447ba6cea4818d",
  "correlationId": "5d1d4ea-8229-44d7-b517-26a5ae6c2fda",
  "timeToLive": 5,
  "endStateApplication": null
}
'
  • {
  "message": "Server Error"
}
In this section: