Skip to main content

Documentation

Poll - Reprint

Send a request using the poll method to reprint a receipt of a previous sale from a PAX POS device.

Parameters
Request Header Parameters
Request Body Parameters

    • ReceiptType

    • One of the following values:

      • NONE

      • CARDHOLDER_RECEIPT

      • MERCHANT_RECEIPT

    • uti

    • An id provided by the POS in a sale response. Used for message matching in a reprint.

    • 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. Will be returned in the callback for message matching. In a cancel request, use the value from the sale/refund that is being cancelled

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

202 Accepted Response
400 Error Response

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

401 Unauthorized Response

    • message

    • Unauthorized.

500 Error Response

    • message

    • Server Error

  • /poll/reprint

  • 202 Reprint Accepted

  • curl -X
post https://CloudLinkApi/poll/reprint
-H 'X-API-KEY: your-access-key-here'
-d '
{
    "receiptType": "CARDHOLDER_RECEIPT",
    "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566",
    "callbackUrl": "http://example.com/webhook-endpoint",
    "deviceToken": "b16526c3447ba6cea4818d",
    "correlationId": "011182D3-A941-4207-9905-D7770347D492",
    "timeToLive": 5
}
' 
  • {
"message": "Accepted"
}

  • 400 Bad Request

  • curl -X
post https://CloudLinkApi/poll/reprint
-H 'X-API-KEY: your-access-key-here'
-d '
{
    "receiptType": "CARDHOLDER_RECEIPT",
    "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566",
    "callbackUrl": "http://example.com/webhook-endpoint",
    "deviceToken": "b16526c3447ba6cea4818d",
    "correlationId": "011182D3-A941-4207-9905-D7770347D492",
    "timeToLive": 5      
}
' 

  •  {
  "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/reprint
-H 'X-API-KEY: your-access-key-here'
-d '
{
    "receiptType": "CARDHOLDER_RECEIPT",
    "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566",
    "callbackUrl": "http://example.com/webhook-endpoint",
    "deviceToken": "b16526c3447ba6cea4818d",
    "correlationId": "011182D3-A941-4207-9905-D7770347D492",
    "timeToLive": 5
}
' 

  • {
  "message": "Unauthorized"
}

  • 500 Server Error

  • curl -X
post https://CloudLinkApi/poll/reprint
-H 'X-API-KEY: your-access-key-here'
-d '
{
    "receiptType": "CARDHOLDER_RECEIPT",
    "uti": "83EF00C9-8A86-4E84-8E05-35B7B4358566",
    "callbackUrl": "http://example.com/webhook-endpoint",
    "deviceToken": "b16526c3447ba6cea4818d",
    "correlationId": "011182D3-A941-4207-9905-D7770347D492",
    "timeToLive": 5
}
' 

  • {
  "message": " Server Error"
}
In this section: