--- title: "List payment links" method: GET path: "/v2/payment-links" tags: ["Pay by Link"] --- # List payment links `GET /v2/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. ## Query parameters - `ids` string[] - `statuses` PaymentLinkStatusFilter[] - `onBehalfOfId` string - `externalPsuReference` string — An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User). - `createdAfter` string, date-time - `createdBefore` string, date-time - `expiresAfter` string, date-time - `expiresBefore` string, date-time - `limit` integer - `offset` string ## Response `200` List of payment links - PaymentLinksResponse — Response containing a list of payment links with pagination info. - `paymentLinks` PaymentLink[], required - `id` string, required — Payment link ID - `memberId` string, required — The Token.io-assigned member identifier of the TPP that created the payment link - `status` 'LINK_ACTIVE' | 'LINK_EXPIRED' | 'LINK_CANCELED' | 'USAGE_LIMIT_REACHED' | 'AMOUNT_LIMIT_REACHED', required — Status of the payment link: - `createdAt` string, date-time, required — Creation timestamp (in ISO 8601 format) - `paymentTemplate` PaymentTemplate, required — The payment template containing payment details. The amount.currency is always required. For fixed amount payment links, both amount.currency and amount.value must be provided. For variable amount payment links where the payer provides the amount, omit amount.value. - `id` string — Payment template ID - `amount` object - `currency` string, required — The ISO 4217 three letter currency code. - `value` string — The transaction amount with up to four digits after the decimal point. Omit for variable amount payment links where the payer provides the amount. - `localInstrument` 'SEPA' | 'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'ELIXIR' | 'EU_DOMESTIC_NON_EURO' | 'EU_DOMESTIC_NON_EURO_INSTANT' | 'BANKGIRO' | 'PLUSGIRO' | 'AUTO_SELECT', required — The bank's payment service used to make the payment.
Depending on which local instrument you select, you will require different account identifiers in the `debtor` and `creditor` objects. The `creditor` object is mandatory, but the `debtor` object is only required if it is mandatory for a specific bank. However, if the TPP decides to provide debtor details, account identifier field(s) within the `debtor` object are mandatory.
The fields within the `creditor` and `debtor` objects are populated as follows: - `creditor` union, required - object — SEPA account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — SEPA Instant account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — A UK or Irish account where the sort code and account number are required. - `accountNumber` string, required — The unique identifier for the bank account in the UK or Ireland. - `sortCode` string, required — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Polish account details where the account number is required and the bic is optional. - `accountNumber` string, required — The payee's Elixir-registered bank account number. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Polish account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the bban is required and the bic is optional. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the bban is required and the clearing number is optional. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the iban and bban are required and the bic and clearing number are optional. This is ONLY allowed for an HP flow if there is no `bankId` provided in the initiation AND the currency is SEK or NOK. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the bban is required and the bic is optional. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the bban is required and the clearing number is optional. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the iban and bban are required and the bic and clearing number are optional. This is ONLY allowed for an HP flow if there is no `bankId` provided in the initiation AND the currency is SEK or NOK. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bban` string, required — Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the bankgiroNumber is required and the bic is optional. - `bankgiroNumber` string, required — The unique identifier for the bank account in Sweden (known in Swedish as Bankgironummer), it consists of 7 or 8 digits. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — Account details where the plusgiroNumber is required and the bic is optional. - `plusgiroNumber` string, required — The unique identifier for the Swedish money transaction system owned by Nordea. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - object — The creditor settlement account details. - `virtualAccountId` string, required — The unique identifier for the settlement account. This field is mandatory for unregulated TPPs. - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts. - `ultimateCreditorName` string — The ultimate creditor's name. - `address` Address — Address - `addressLine` string[] - `streetName` string — Street number - `buildingNumber` string — Building number - `postCode` string — Post Code - `townName` string — Town name - `state` string — State - `district` string — The district. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `bankName` string — The creditor's bank name. - `refId` string, required — Reference ID for the payment, TPP provided base reference. The system will derive a unique per payment reference from this value when the link is used (e.g., by appending a unique suffix). The exact generated reference is returned in the created payment. - `remittanceInformationPrimary` string — The primary field for remittance information. This should contain a reference, as assigned by the creditor, to unambiguously refer to the payment transactions under this consent. The value of this field should appear on the bank statement and reconciliation file, irrespective of the payment network being used.
We recommend that the `remittanceInformationPrimary` field should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-') as banks may remove these when sending this field to the beneficiary. This field should not exceed 35 characters in length (18 characters for UK Faster Payments). - `remittanceInformationSecondary` string — The secondary field for remittance information. The information supplied should enable the reconciliation of an entry in an unstructured form. Depending on the payment network, information from this field may or may not be included in the bank statement and reconciliation file.
We recommend that the `remittanceInformationSecondary` field should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-') as banks may remove these when sending this field to the beneficiary. This field should not exceed 140 characters in length. - `externalPsuReference` string — An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User). - `callbackUrl` string — The TPP's url that Token.io calls back to. This url should not be under the token.io domain and must be https/SSL secure. - `chargeBearer` 'INVALID_CHARGE_BEARER' | 'CRED' | 'DEBT' | 'SHAR' | 'SLEV' — The bearer of the charge, if any, for international transfers. - `confirmFunds` boolean — Fund confirmation check - `returnRefundAccount` boolean — Return refund account information - `onBehalfOfId` string — The on-behalf-of ID is validated against the sub-TPP id of the member. This field is mandatory for unregulated TPPs. - `risk` Risk — This field is used to specify additional details for the risk scoring of payments. - `psuId` string — The merchant's unique customer identifier for the user. - `paymentContextCode` 'INVALID_PAYMENT_CONTEXT_CODE' | 'BILLING_GOODS_AND_SERVICES_IN_ADVANCE' | 'BILLING_GOODS_AND_SERVICES_IN_ARREARS' | 'PISP_PAYEE' | 'ECOMMERCE_MERCHANT_INITIATED_PAYMENT' | 'FACE_TO_FACE_POINT_OF_SALE' | 'TRANSFER_TO_SELF' | 'TRANSFER_TO_THIRD_PARTY' — This field describes the context of the payment context. This field is an OBIE standard and also maps to NextGenPsd2's `purposeCode` and `categoryPurposeCode` fields. We recommend that the TPP populates this field. - `paymentPurposeCode` 'CASH' | 'CORT' | 'DVPM' | 'INTC' | 'TREA' | 'SUPP' — The category code conforming to the Recommended UK Purpose Code in the ISO 20022 Payment Messaging List, related to the type of services or goods corresponding to the underlying purpose of the payment. This list applies to all banks that follow ISO 20022. - `merchantCategoryCode` string — The category code conforming to ISO 18245, relating to the type of services or goods provided by the merchant. A list of codes can be purchased here." - `beneficiaryAccountType` 'PERSONAL' | 'JOINT_PERSONAL' | 'PERSONAL_SAVINGS_ACCOUNT' | 'BUSINESS' | 'BUSINESS_SAVINGS_ACCOUNT' | 'CHARITY' | 'COLLECTION' | 'CORPORATE' | 'GOVERNMENT' | 'EWALLET' | 'INVESTMENT' | 'ISA' | 'PREMIER' | 'WEALTH' | 'PENSION' — This information should be provided if the `AccountType` is known. - `contractPresentIndicator` boolean — This field indicates whether a Payee has a contractual relationship with the Payment Initiation Service Provider (PISP). - `beneficiaryPrepopulatedIndicator` boolean — This field indicates whether the Payment Initiation Service Provider (PISP) has immutably prepopulated payment details for the user. - `deliveryAddress` DeliveryAddress — Specifies the recipient's delivery address details. - `addressLine` string[] — Specifies the delivery address using multiple lines, as necessary. - `addressType` 'INVALID_ADDRESS_TYPE' | 'BUSINESS' | 'CORRESPONDENCE' | 'DELIVERYTO' | 'MAILTO' | 'POBOX' | 'POSTAL' | 'RESIDENTIAL' | 'STATEMENT' — Specifies the type of address. - `buildingNumber` string — The building number within the delivery address. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `countrySubDivision` string[] — Identifies a subdivision of a country; for instance, a state, region, or county. - `department` string — This OBIE specification maps to house number. - `postCode` string — An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `streetName` string — The name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received. - `subDepartment` string — This OBIE specification maps to flats. - `townName` string — The name of a built-up area with defined boundaries and a local government. - `linkConfig` LinkConfig, required — Link configuration with usage limits and expiration. - `maxUsageCount` integer — Maximum number of times the link can be used. If omitted, defaults to 10000000. - `perPaymentAmountLimit` string — Per payment amount limit value - `totalAmountLimit` string — Total amount limit value - `expiresAt` string, date-time — The time and date the link will expire (in ISO 8601 format) - `url` string, uri, required — The payment link URL - `currentUsage` CurrentUsage — Current usage statistics for the payment link. - `remainingCount` integer — Number of remaining uses - `remainingAmount` string — Remaining amount that can be used - `pageInfo` PageInfo, required — The information about the current page, which also indicates whether the next page exists. - `limit` integer, required — The limit (maximum number of objects to return) applied to this page.
The default and maximum allowed limit is 200. If this limit is exceeded, was not set or was set to 0, it will be set to 200. - `offset` string — The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset is provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to the dynamic nature of the data.
The offset is opaque to a user and should not be parsed and/or understood in any way. - `nextOffset` string — The offset for the next page. If the page is empty, it is equal to this page offset. If the page is not empty, but there are no more objects to load (haveMore = false), it will be empty.
The offset is opaque to a user and should not be parsed and/or understood in any way. - `haveMore` boolean — This field indicates whether there are more objects to load, i.e. whether the next page exists. ## Other responses - `400` — The client specified an invalid argument - `401` — The authorization information is missing or invalid - `403` — Permission to access this endpoint is denied - `500` — An unexpected or internal server error --- [API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)