Get Payment Links

This API call returns multiple Payment link information, like would be seen in the Merchant Portal view of Payment Links.

GET Payment Links

Creation of a payment link is achieved by sending a HTTP POST request to these URLs. The access_token will be the one received in the Authentication Response.

HTTP Headers

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
Content-TypeMandatoryStringBearer access_token

Request Details

Create Payment Link request
Field NameStateData TypeDescription
terminalIdMandatoryStringTerminal ID for the Merchant.
fromMandatoryStringThe Start Date for the search.

ISO 8601 format e.g. 2021-11-30T16:00:00Z
toMandatoryStringThe End Date for the search.

ISO 8601 format e.g. 2021-11-30T16:00:00Z
You can request payment links up to 365 days old
pageOptionalIntegerThe page number, which specifies the set of records to retrueve.

Default=1
sizeOptionalIntegerThe number of records to be returned per page.

Default=20, Max=5000
statusOptionalStringPayment link status. See Statuses for more details.

Get Payment Links Response

If the request is successful, you will receive a 200 OK response code, and the following response fields.

Field nameTypeDescription
totalCountIntegerThe total number of payment links returned in the Response.
recordsArrayAn array containing an object for each payment link record returned.

Get Payment Links Response > Records

The records Array contains the following fields.

Field nameTypeDescription
idStringPayment link ID, the unique reference for this payment link assigned by the DNA Platform.
amountFloatThe amount of the payment, as a decmal.
currencyStringCurrency e.g. GBP.
invoiceIdStringThe InvoiceId supplied in the Request, if applicable.
terminalIdStringThe terminal ID supplied in the request.
customerNameStringThe Customer name.
descriptionStringThe description as supplied in the request.
createdDateStringThe date that the Payment Link was created.
expirationDateStringThe date that the Payment Link will expire.
viewedDateStringThe date that the Payment Link was viewed. Null if not applicable.
attemptedDateStringThe date that the Payment Link was attempted. Null if not applicable.
paidDateStringThe date that the Payment Link was viewed. Null if not applicable.
cancelledDateStringThe date that the Payment Link was viewed. Null if not applicable.
statusStringPayment link status. See Statuses for more details.
urlStringFull payment link URL

Example Request and Response

{
"terminalId": "4511a14f-61a3-4449-a1c1-7a314ee2374c",
"from": "2020-12-09T00:00:00.000Z",
"to": "2020-12-15T23:59:99.000Z",
"page": 1,
"size": 3
}