Skip to main content

Documentation

Refund

Send a request to display a refund 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

    • description

    • Receipt description

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

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

    • timeToLive

    • The maximum time, in seconds, for a request to reach the physical terminal. The default value is 5 seconds.

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 Unauthorized Response

    • message

    • Unauthorized

500 Error Response

    • 500

    • Server Error

  • /refund

  • 202 Accepted refund

  • curl -X
post https://CloudLinkApi/refund
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "description": "Refund request",
  "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/refund
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "description": "Refund request",
  "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": "Bad Request",
        "status": 400,
        "detail": "DeviceId not registered"
}

  • 401 Unauthorized

  • curl -X
post https://CloudLinkApi/refund
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "description": "Refund request",
  "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/refund
-H 'X-API-KEY: your-access-key-here'
-d '
{
  "amount": "100",
  "description": "Refund request",
  "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" 
}
In this section: