Get Payment Links

GET /paymentlinks

This endpoint allows merchants to retrieve all payment links visible to the currently authenticated user. It returns a list of both pay-by-link and tokenize-by-link entries, including their current status and metadata.

Test URL

Send the request to the following URL:

https://checkout-api.staging.straumur.is/api/v1/paymentlinks?page=0&pageSize=100

Query Parameters

Field	Type	Description
Page	Integer	Page number (starts at 0)
PageSize	Integer	Page size (cannot be larger than 100)

Example Response

{
  "data": [
    {
      "paymentLinkReference": "30001aylo2a",
      "description": "Payment for PlayStation 2 HDMI Adapter.",
      "amount": 20000,
      "currency": "ISK",
      "type": "PayByLink",
      "createdAt": "2025-01-01T09:50:14.343503Z"
    },
    {
      "paymentLinkReference": "30001aylo2b",
      "description": "Tokenization for PlayStation 2 purchase.",
      "amount": 0,
      "currency": "ISK",
      "type": "TokenizeByLink",
      "createdAt": "2025-01-01T09:50:14.343503Z"
    }
  ],
  "totalCount": 2,
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}

Response Fields

Field	Type	Description	Example
data	Array	Array of payment link objects	-
totalCount	Integer	The total count of all items available.	2
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
paymentLinkReference	String	Unique reference for the payment link	30001aylo2a
description	String	Description of the payment link	cool tokenization link really
amount	Integer	Payment amount in minor units	0
currency	String	Three-character ISO currency code	ISK
type	String	Type of payment link (PayByLink/TokenizeByLink)	TokenizeByLink
createdAt	String	When the payment link was created	2025-01-01T09:50:14.343503Z

Error Response

Error responses are standardized. For details, see Errors.

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