<- Checkout API

Checkout API

List payment links

GET

 /v2/online-checkout/payment-links

Lists all payment links.

Permissions:ORDERS_READ

Guide

Manage Checkout

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.

Link to section

limit

integer(32-bit)

A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored.

Default value: 100

Link to section

Response fields

Link to section

errors

Errors that occurred during the request.

Link to section

payment_links

The list of payment links.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see Pagination.