Get Payment Link Details

GET /paymentlinks/{reference}

This endpoint allows merchants to retrieve detailed information about a specific payment link using its reference identifier. It provides comprehensive details, including configuration, status, and usage statistics.

Test URL

Send the request to the following URL:

https://checkout-api.staging.straumur.is/api/v1/paymentlinks/{reference}

Replace {reference} with the actual payment link reference.

Example Response – Pay by Link

{
  "paymentLink": {
    "terminalIdentifier": "1adfe4a1",
    "paymentLinkReference": "30001aylo2a",
    "themeKey": "441368-7a47f",
    "description": "Payment for PlayStation 2 HDMI Adapter.",
    "amount": 20000,
    "currency": "ISK",
    "returnUrl": null,
    "status": "Active",
    "culture": "is",
    "type": "PayByLink",
    "url": "https://pay.example.com/link/30001aylo2a",
    "createdAt": "2025-01-01T09:50:14.343503Z",
    "validUntil": null,
    "recurringProcessingModel": null,
    "visitCount": 69,
    "salesCount": 1,
    "maxSalesCount": null,
    "items": [
      {
        "name": "Playstation 2 Analog RCA/SCART to HDMI Adapter Low Latency",
        "quantity": 1,
        "amountWithoutDiscount": 25000,
        "amount": 20000,
        "unitPrice": 20000
      }
    ],
    "shopperInfo": [
      {
        "field": "Ssn",
        "requirementType": "Required",
        "prefilledValue": null,
      }
    ],
    "submissions": [
      {
        "answers": [
          {
            "field": "Ssn",
            "value": "1111111119"
          }
        ],
        "completed": true,
        "amount": 20000,
        "currency": "ISK",
        "token": null
      }
    ]
  },
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}

Example Response – Tokenize by Link

{
  "paymentLink": {
    "terminalIdentifier": "1adfe4a1",
    "themeKey": null,
    "paymentLinkReference": "30001aylo2b",
    "description": "Tokenization for PlayStation 2 purchase.",
    "amount": 0,
    "currency": "ISK",
    "returnUrl": null,
    "status": "Completed",
    "culture": "is",
    "type": "TokenizeByLink",
    "url": "https://pay.example.com/link/30001aylo2b",
    "createdAt": "2025-01-01T09:50:14.343503Z",
    "validUntil": null,
    "recurringProcessingModel": "CardOnFile",
    "visitCount": 69,
    "salesCount": 1,
    "maxSalesCount": 1,
    "items": [],
    "shopperInfo": [
      {
        "field": "Ssn",
        "requirementType": "Prefilled",
        "prefilledValue": "1111111119",
      }
    ],
    "submissions": [
      {
        "answers": [
          {
            "field": "Ssn",
            "value": "1111111119"
          }
        ],
        "completed": true,
        "amount": 0,
        "currency": "ISK",
        "token": "A1B2C3D4E5F6G7H8"
      }
    ]
  },
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}

Response Fields

Field	Type	Description	Example
paymentLink	Object	The payment link object	-
responseDateTime	String	The date and time when the response was generated.	`2024-09-04T09:50:14.343503Z`
responseIdentifier	String	The unique identifier for the response.	`7be7111c-2e8e-4cd4-a5ba-f15bdfd177c1`

Payment Link Object Fields

Field	Type	Description	Example
terminalIdentifier	String	The terminal identifier to uniquely identify the terminal	`1adfe4a1`
themeKey	String	The value of the theme to be used for the checkout page	`441368-7a47f`
paymentLinkReference	String	Unique reference for the payment link	`30001aylo2a`
description	String	Description of the payment link	`Payment for PlayStation 2 HDMI Adapter.`
amount	Integer	Payment amount in minor units	`0`
currency	String	Three-character ISO currency code	`ISK`
returnUrl	String	The URL to which the user is redirected after completing or cancelling payment	`https://merchant.com/return`
status	String	Current status of the payment link. Values: Active, Expired, Used, Disabled	`Active`
culture	String	Language code used as default for the checkout page	`is`
type	String	Type of payment link. Values: PayByLink, TokenizeByLink	`TokenizeByLink`
url	String	The URL at which the payment link can be opened	`https://pay.example.com/link/30001aylo2a`
createdAt	String	Timestamp when the payment link was created (ISO 8601 format)	`2025-01-01T09:50:14.343503Z`
validUntil	String	Expiration timestamp of the payment link (ISO 8601 format)	`2026-01-01T09:50:14.343503Z`
recurringProcessingModel	String	Model used for recurring payments, if applicable. Values: CardOnFile, Subscription, UnscheduledCardOnFile	`CardOnFile`
visitCount	Integer	Number of times the payment link has been visited	`69`
salesCount	Integer	Number of successful transactions completed through the link	`1`
maxSalesCount	Integer	Maximum allowed successful transactions for this link	`10`
items	Array	List of items related to this payment link	-
shopperInfo	Array	List of shopper info requested from the shopper	-
submissions	Array	List of submission attempts	-

Items Fields

Field	Type	Description	Example
name	String	Name or description of the product	`Playstation 2 Analog RCA/SCART to HDMI Adapter Low Latency`
quantity	Integer	Number of units being purchased	`1`
amountWithoutDiscount	Integer	Original amount in minor units before any discounts	`25000`
amount	Integer	Final payable amount in minor units after discount	`20000`
unitPrice	Integer	Price per unit in minor units	`20000`

Shopper Info Fields

Field	Type	Description	Example
field	String	The shopper data field being requested	`Ssn`
requirementType	String	Indicates if the field is required, optional, etc.	`Required`
prefilledValue	String	Default value, if requirementType is set to 'Prefilled'	`null`

Submissions Fields

Field	Type	Description	Example
answers	Array	List of shopper answers to requested fields	-
completed	Boolean	Indicates whether the submission resulted in a successful checkout	`true`
amount	Integer	The total amount paid in minor units	`20000`
currency	String	Three-character ISO currency code	`ISK`
token	String	Payment token if tokenization occurred, otherwise null	`null`

Submission Answers Fields

Field	Type	Description	Example
field	String	The name of the shopper field that was answered	`Ssn`
value	String	The value provided by the shopper	`1111111119`

Error Response

Error responses are standardized. For details, see Errors.

You can also find a detailed overview of our HTTP Status Codes.

Test URL​

Example Response – Pay by Link​

Example Response – Tokenize by Link​

Response Fields​

Payment Link Object Fields​

Items Fields​

Shopper Info Fields​

Submissions Fields​

Submission Answers Fields​

Error Response​