| Field | Type | Required | Description | Example |
|---|---|---|---|---|
cursor |
JsonNullable<String> | ➖ | A pointer to the page of results to return. | ZXhhbXBsZTE |
limit |
Optional<Long> | ➖ | The maximum number of items that are returned. | 20 |
createdAtLte |
OffsetDateTime | ➖ | Filters the results to only payment links created before this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00. |
2022-01-01T12:00:00+08:00 |
createdAtGte |
OffsetDateTime | ➖ | Filters the results to only payment links created after this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00. |
2022-01-01T12:00:00+08:00 |
updatedAtLte |
OffsetDateTime | ➖ | Filters the results to only payment links updated before this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00. |
2022-01-01T12:00:00+08:00 |
updatedAtGte |
OffsetDateTime | ➖ | Filters the results to only payment links updated after this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00. |
2022-01-01T12:00:00+08:00 |
currency |
List<String> | ➖ | Filters for payment links that have matching currency values. The currency values provided must be formatted as 3-letter ISO currency codes. |
[ "USD" ] |
amountEq |
JsonNullable<Long> | ➖ | Filters for payment links that have an amount equal to this value. |
1299 |
amountGte |
JsonNullable<Long> | ➖ | Filters for payment links that have an amount greater than or equal to this value. |
1299 |
amountLte |
JsonNullable<Long> | ➖ | Filters for payment links that have an amount less than or equal to this value. |
1299 |
status |
List<PaymentLinkStatus> | ➖ | Filters the results to only the payment links that have a status that matches with any of the provided status values. |
|
buyerSearch |
List<String> | ➖ | Filters the results to only get the items for which some of the buyer data contains exactly the provided buyer_search values. |
[ "John", "London" ] |
merchantAccountId |
JsonNullable<String> | ➖ | The ID of the merchant account to use for this request. |