| Field | Type | Required | Description | Example |
|---|---|---|---|---|
paymentLinkId |
String | ✔️ | Provide the ID of the related payment link. | pl_d9fQur83kFdhH8hIhaZfq |
from |
Optional<String> | ➖ | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. |
tr_5B8cwPMGnU |
limit |
JsonNullable<Long> | ➖ | The maximum number of items to return. Defaults to 50 items. | 50 |
sort |
Optional<Sorting> | ➖ | Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest. |
desc |
testmode |
Optional<Boolean> | ➖ | Most API credentials are specifically created for either live mode or test mode. In those cases the testmode queryparameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. |
|
idempotencyKey |
Optional<String> | ➖ | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | 123e4567-e89b-12d3-a456-426 |