How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shift4 Payment Links API

The Payment Links API from Shift4 — 4 operation(s) for payment links.

Shift4 Payment Links API is one of 21 APIs that Shift4 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Links. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.7.57.

Requests are made against 2 base URLs: https://api.shift4test.com/api/rest/v1, https://api.shift4api.net/api/rest/v1.

4 operations 4 paths 49 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.7.57
Base URL
https://api.shift4api.net/api/rest/v1
Authentication
API Key, HTTP Hmac-Sha256
Resource Areas
1

Authentication & Security 2

Shift4 Payment Links API declares 2 security schemes for authenticating requests. An API key is passed in the header as AccessToken (AccessToken). It uses HTTP hmac-sha256 authentication (HMAC-SHA256).

  • AccessToken — A security credential used to authenticate API requests and all [i4Go®](https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20re…
  • HMAC-SHA256 — Authentication using HMAC-256 signatures as the authorization scheme. Sent in the Authorization header in the following format: Authorization: HMAC-SHA256 Cred…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Links 4
POST
/paymentlinks/create
Create Link
paymentslinkcreate 4 params body → 200400504
GET
/paymentlinks/list
List Links
paymentslinklist 9 params → 200400504
GET
/paymentlinks/retrieve
Retrieve Link
paymentslinkretrieve 5 params → 200400504
POST
/paymentlinks/update
Update Link
paymentslinkupdate 5 params body → 200400504

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are PaymentLinkResponse (17 properties), PaymentLinkRequest (14 properties), PaymentLinksCustomerResponse (12 properties), PaymentLinkUpdateRequest (12 properties). Each schema is shown below with its type and property counts.

PaymentLinkLocale
string
Language that will be used on payment page. Default: auto = use browser language
PaymentLinkCurrency
string
Currency for the authorization, represented as a three-letter ISO currency code. Required only for cardverification links. For lineitems links the currency is…
PaymentLinkLastOpened
string
The date the link was last opened. Omitted if the link has not been opened yet.
CustomerPostalCode
string
Cardholder’s ZIP/postal code from their billing statement. This field is used in AVS. Do not include special characters. Note: This field only allows alphanume…
PaymentLinkVendorReference
string
Merchant Defined Descriptor related to the Payment Link. This field is reportable on the merchant portal and settlement extract.
PaymentLinkLineItemsProductDescription
string
Description of a product, shown to the customer on the hosted checkout page directly under the product name
PaymentLinkCollectShippingAddress
boolean
If the value is true, the customer will be asked to provide the shipping address. Default: false
PaymentLinksDateTime
string
Date-time when the object was created
PaymentLinkLineItemsProductAmountTotal
number
Payment amount (in major units, with number of allowed decimal places depending on currency)
PaymentLinkStatus
string
Status of a Payment link. It can be one of the following: Value | Description ------------|--------------- active | Payment link is active and functional expir…
Error
object
6 properties
PaymentLinkRestrictions
object
This object describes time boundaries and preset number of charges made with the Payment link
2 properties
PaymentLinksHasMore
boolean
If the value is true then more objects can be listed by requesting next page
PaymentLinkCustomFieldsArray
array
Using custom fields, the merchant can request additional information from the customer. Each custom field will be displayed in the form as a new text field to…
LighthouseResponse
object
1 property
PaymentLinkLineItemsArrayResponse
array
List of line items
CustomerAddressLine1
string
Cardholder’s street address exactly as it appears on their billing statement. This field is used in AVS.
ServerName
string
The name of the server that processed the request.
PaymentLinkId
string
Identifier of Payment Link
PaymentLinkStaticFields
object
List of custom information (for example: hotel reservation details) in key value pair format. A maximum of 10 entries can be provided. The key contains the tit…
PaymentLinkLineItemsProductAmountCurrencyCode
string
currency represented as a three-letter ISO currency code
Server
object
1 property
PaymentLinkLineItemsArray
array
List of line items
CustomerLastName
string
Specifies a consumer’s last name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the re…
PaymentLinkUpdateRequest
object
12 properties
PaymentLinkCustomFieldsTitle
string
Title of custom fields section
CustomerFirstName
string
Specifies a consumer’s first name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the r…
ErrorSeverity
string
Severity level of the error. | Severity | Description | | -------- | ---------------------------------------------------------------- | | Info | Action not req…
CustomerMiddleName
string
Specifies a consumer’s middle name.
PaymentLinksCustomer
PaymentLinkNotificationsResponse
object
Payment Links notifications
1 property
PaymentLinkLineItemsProductAmountCustom
object
Possible range of custom payment amount
2 properties 2 required
PaymentLinksMetadata
object
Key-value object for storing additional custom data. This is never displayed to customer on the payment page. Examples: "orderid": "12345" "campaigncode": "SUM…
PaymentLinkURL
string
URL that can be used to process payment defined by this Payment Link
ErrorLongText
string
Extended error message that is returned if an error condition exists.
PaymentLinksCustomerResponse
object
12 properties
PaymentLinkCollectBillingAddress
boolean
If the value is true, the customer will be asked to provide the billing address. Default: false
ErrorShortText
string
Abbreviated error message that is always returned if an error condition exists
LighthouseDataResponse
string
Base64 encoded JSON formatted data that will be returned from Lighthouse to be passed back to SkyTab. This data will contain variable information.
ErrorPrimaryCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.
PaymentLinkLineItemsProductAmountOptionsArray
array
List of available pre-defined payment amounts. Allows the customer to select from a list of options for how much they want to pay. Useful whenever a merchant w…
PaymentLinkNotificationsRequest
object
Payment Links notifications
1 property
PaymentLinkType
string
The kind of flow the payment link performs. - lineitems (default) — a standard payment flow. The customer pays for the products defined in lineItems. - cardver…
ErrorCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details. Note: Th…
PaymentLinkRequest
object
Configuration of the payment link. Required fields depend on type: - lineitems (default) — lineItems is required; currency is taken from the line items. - card…
14 properties
PaymentLinkLineItemsProductName
string
Name of a product
ErrorSecondaryCode
integer
This code supplements the code specified in the error.primaryCode field to provide additional information about the error that occurred.
PaymentLinkResponse
object
17 properties
PaymentLinkReturnURL
string
Customer will be redirected to this URL after completing payment on paymentLink.url page. When not provided the return URL from account setting will be used. S…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shift4-payment-links-api-openapi.yml Raw ↑

Other APIs Shift4 publishes across the network.

Shift4 3D Secure API
Shift4 ACH API
Shift4 Batches API
Shift4 Cards API
Shift4 Checkout Sessions API
Shift4 Credentials API
Shift4 DCC API
Shift4 Devices API
Shift4 Gift Cards API
Shift4 Merchants API
Shift4 Mode API
Shift4 OCT API
Where this information came from

This is an independent, third-party profile of Shift4 Payment Links API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.