v1
latestOpenAPI 3.1.02026-08-06731,0781.4 MBList Links
Used to retrieve a list of links via the Payment Links system
Integration Methods:
- Host Direct
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Headers
Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =
Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.
Maximum number of returned objects
Cursor used for pagination (getting the next page). For example, if you make a list request and receive 10 objects, where the last object has id=some-example-id - then you can make another request with startingAfterId=some-example-id to get the next page of that list.
Cursor used for pagination (getting the previous page). For example, if you make a list request and receive 10 objects, where the first object has id=some-example-id - then you can make another request with endingBeforeId=some-example-id to get the previous page of that list
Returns only records strictly after the specified timestamp
Returns only records strictly before the specified timestamp
Response
Request was processed
Example response
{
"result": [
{
"dateTime": "2024-05-21T09:18:23.283-07:00",
"paymentLink": {
"id": "link_8kdskX8DZ8FR6W3acYPXiyAN",
"lastOpened": "2025-10-20T11:22:33.444Z",
"lineItems": [
{
"product": {
"name": "Example charge",
"description": "Some product description",
"currencyCode": "USD",
"amount": {
"total": 10
}
}
}
],
"currency": "USD",
"url": "https://pay.shift4.com/link_8kdskX8DZ8FR6W3acYPXiyAN",
"restrictions": {
"dates": {
"activatesAt": "2025-10-20T11:22:33.444Z",
"expiresAt": "2025-10-27T12:00:00.000Z"
},
"payments": {
"limit": 1
}
},
"notifications": {
"share": {
"email": {
"emailAddress": "john@example.com"
}
}
},
"staticFields": {
"Date of event": "12 April",
"Invoice number": "ABC2016"
},
"customFieldsTitle": "Additional information",
"customFields": [
{
"key": "special_wishes",
"label": "Special wishes"
}
],
"vendorReference": "ref_123456789"
},
"customer": {
"id": "cust_oM1i4j7EsIY7W5vqqF76diGw",
"emailAddress": "john@example.com",
"phoneCountry": "US",
"phoneNumber": "+1 2345678901",
"addressLine1": "65 Easy St",
"firstName": "John",
"middleName": "Andrew",
"lastName": "Smith",
"postalCode": "65144",
"addressCity": "New York",
"addressRegion": "NY",
"addressCountry": "US"
},
"metadata": {
"order_id": "12345",
"campaign_code": "SUMMER2025"
}
}
]
}