Retrieve a link

You can also retrieve links previously created, using our API. This will provide you with the link URL and status.

API Examples

Retrieve a link



GET /smartlink/links/{linkId}
{}

HTTP/1.1 200
{
  "smartLinkResponseDetail": {
    "expires": "2015-12-24T12:15:00.000+0000",
    "usage": "SINGLE",
    "status": "CANCELLED",
    "link": "http://www.example.com/smartlink/52aef20c-6b53-4491-ad5d-08c25e681af0",
    "linkId": "52aef20c-6b53-4491-ad5d-08c25e681af0"
  },
  "status": "SUCCESS",
  "reasonCode": "S100",
  "reasonMessage": "SmartLink retrieved"
}

API Endpoint

endpoint: /smartlink/links/{linkId}

method: GET

summary: Request an existing link

parameters:

linkId

string

The link id to be retrieved

response:

{
smartLinkResponseDetail {	The details of the created link.
expires	dateTime The date and time this link will expire.
onDeadLink	String The URL to which the merchant wished a customer to be redirected in an error case.
status	string Possible Values: ACTIVATED, DEACTIVATED, CANCELLED, USED, EXPIRED Links are created with a status of ACTIVATED.
link	string The link. A HTTP link that will initialise a hosted session so that a payment may be taken.
linkId	string A unique ID that can be used to identify the link created.
}
status	string The status of the SmartLinkRESTRequest, SUCCESS, indicating a link was created.
reasonCode	string A code that indicates a response message, it can be looked up for trouble shooting.
reasonMessage	string A description of the reason code.
}

Developer Documents