List payment links

Required scope: business/orders:read

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

cursorstring or nullOptional>=1 character<=255 characters

A pagination cursor from where results should start being fetched.

limitintegerOptional>=1<=100Defaults to 50

The maximum number of results to return.

created_at__gtestring or nullOptionalformat: "date-time"

The min payment link created date and time in ISO 8601 format.

created_at__ltestring or nullOptionalformat: "date-time"

The max payment link created date and time in ISO 8601 format.

updated_at__gtestring or nullOptionalformat: "date-time"

The min payment link updated date and time in ISO 8601 format.

updated_at__ltestring or nullOptionalformat: "date-time"

The max payment link updated date and time in ISO 8601 format.

Successful Response

datalist of objects

A list of paginated entities.

next_cursorstring or null

A pagination cursor that can be used to retrieve the next set of results.

1	{
2	"data": [
3	{
4	"created_at": "2024-11-19T15:27:02+00:00",
5	"customer_description": "This description is visible to the customer on the payment page.",
6	"customer_reference": "Peter Parker",
7	"id": "1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4",
8	"order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
9	"updated_at": "2024-11-19T16:27:23+00:00",
10	"url": "https://pay.yoco.com/r/dRggEC"
11	}
12	],
13	"next_cursor": "1323935095007282836"
14	}

1	curl https://api.yoco.com/v1/payment_links/ \
2	-H "Authorization: Bearer <token>"