Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.98 KB

payment-link.md

File metadata and controls

39 lines (31 loc) · 1.98 KB
Raw

Payment Link

Structure

PaymentLink

Fields

Name Type Tags Description
id string | undefined Optional The Square-assigned ID of the payment link.
version number Required The Square-assigned version number, which is incremented each time an update is committed to the payment link.
Constraints: <= 65535
description string | undefined Optional The optional description of the payment_link object.
It is primarily for use by your application and is not used anywhere.
Constraints: Maximum Length: 4096
orderId string | undefined Optional The ID of the order associated with the payment link.
Constraints: Maximum Length: 192
checkoutOptions CheckoutOptions | undefined Optional -
prePopulatedData PrePopulatedData | undefined Optional Describes buyer data to prepopulate in the payment form.
For more information,
see Optional Checkout Configurations.
url string | undefined Optional The URL of the payment link.
Constraints: Maximum Length: 255
createdAt string | undefined Optional The timestamp when the payment link was created, in RFC 3339 format.
updatedAt string | undefined Optional The timestamp when the payment link was last updated, in RFC 3339 format.
paymentNote string | undefined Optional An optional note. After Square processes the payment, this note is added to the
resulting Payment.
Constraints: Maximum Length: 500

Example (as JSON)

{
  "id": null,
  "version": 172,
  "description": null,
  "order_id": null,
  "checkout_options": null,
  "pre_populated_data": null,
  "url": null,
  "created_at": null,
  "updated_at": null,
  "payment_note": null
}