payment-link.md

Payment Link

Structure

PaymentLink

Fields

Name	Type	Tags	Description
Id	string	Optional	The Square-assigned ID of the payment link.
Version	int	Required	The Square-assigned version number, which is incremented each time an update is committed to the payment link. Constraints: <= 65535
Description	string	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	Optional	The ID of the order associated with the payment link. Constraints: Maximum Length: 192
CheckoutOptions	CheckoutOptions	Optional	-
PrePopulatedData	PrePopulatedData	Optional	Describes buyer data to prepopulate in the payment form. For more information, see Optional Checkout Configurations.
Url	string	Optional	The shortened URL of the payment link. Constraints: Maximum Length: 255
LongUrl	string	Optional	The long URL of the payment link. Constraints: Maximum Length: 255
CreatedAt	string	Optional	The timestamp when the payment link was created, in RFC 3339 format.
UpdatedAt	string	Optional	The timestamp when the payment link was last updated, in RFC 3339 format.
PaymentNote	string	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": "id2",
  "version": 64,
  "description": "description8",
  "order_id": "order_id4",
  "checkout_options": {
    "allow_tipping": false,
    "custom_fields": [
      {
        "title": "title8"
      },
      {
        "title": "title8"
      }
    ],
    "subscription_plan_id": "subscription_plan_id8",
    "redirect_url": "redirect_url2",
    "merchant_support_email": "merchant_support_email8"
  },
  "pre_populated_data": {
    "buyer_email": "buyer_email8",
    "buyer_phone_number": "buyer_phone_number0",
    "buyer_address": {
      "address_line_1": "address_line_12",
      "address_line_2": "address_line_22",
      "address_line_3": "address_line_38",
      "locality": "locality2",
      "sublocality": "sublocality2"
    }
  }
}