Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Pay by Link

List payment links

The GET /v2/payment-links endpoint returns a list of payment links. At least one filter parameter must be provided. Results can be filtered by IDs, statuses, creation date range (createdAfter, createdBefore), expiration date range (expiresAfter, expiresBefore), external PSU reference, and on-behalf-of ID.

get/v2/payment-links

Query parameters

idsstring[]

Filter by payment link ID list

statusesPaymentLinkStatusFilter[]

Filter by link statuses

[
  "LINK_ACTIVE"
]
onBehalfOfIdstring

Filter by on behalf of ID

externalPsuReferencestring

An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User).

Example:psu external reference 12345

Filter by external PSU Reference

createdAfterstring date-time

Filter links created after this timestamp (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format)

createdBeforestring date-time

Filter links created before this timestamp (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format)

expiresAfterstring date-time

Filter links expiring after this timestamp (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format)

expiresBeforestring date-time

Filter links expiring before this timestamp (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format)

limitinteger

Maximum number of results to return

offsetstring

The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response.

Response

List of payment links

Example response

{
  "paymentLinks": [
    {
      "id": "pl-019c8a02-a30e-7307-83da-7428239da59d",
      "memberId": "m:member123:token456",
      "status": "LINK_ACTIVE",
      "createdAt": "2026-01-01T00:00:00Z",
      "paymentTemplate": {
        "id": "pt-019daa05-dcf3-7920-87fc-53b36d58deea",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "localInstrument": "SEPA",
        "creditor": {
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "name": "Customer Inc.",
          "ultimateCreditorName": "Customer Inc.",
          "address": {
            "addressLine": [
              "The Coach House"
            ],
            "streetName": "221B",
            "buildingNumber": "2C",
            "postCode": "TR26 1EZ",
            "townName": "Saint Ives",
            "state": "Cornwall",
            "country": "GB"
          }
        },
        "refId": "COFFEESHOP123",
        "remittanceInformationPrimary": "Sweepco",
        "remittanceInformationSecondary": "Secondary remittance information.",
        "externalPsuReference": "psu external reference 12345",
        "callbackUrl": "https://tpp.com/callback",
        "chargeBearer": "CRED",
        "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
        "risk": {
          "psuId": "0000789123",
          "paymentContextCode": "PISP_PAYEE",
          "paymentPurposeCode": "DVPM",
          "merchantCategoryCode": "4812",
          "beneficiaryAccountType": "BUSINESS",
          "contractPresentIndicator": true,
          "beneficiaryPrepopulatedIndicator": true,
          "deliveryAddress": {
            "addressLine": [
              "Flat 2, The Red Lodge, 1 High Street"
            ],
            "addressType": "BUSINESS",
            "buildingNumber": "1",
            "country": "GB",
            "countrySubDivision": [
              "North Yorkshire"
            ],
            "department": "1",
            "postCode": "YO62 5JB",
            "streetName": "High Street",
            "subDepartment": "Flat 2",
            "townName": "York"
          }
        }
      },
      "linkConfig": {
        "maxUsageCount": 100,
        "perPaymentAmountLimit": "100.00",
        "totalAmountLimit": "5000.00",
        "expiresAt": "2026-12-31T23:59:59Z"
      },
      "url": "https://app.token.io/pay-by-link/pl-019c8a02-a30e-7307-83da-7428239da59d",
      "currentUsage": {
        "remainingCount": 77,
        "remainingAmount": "4100.00"
      }
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  }
}