• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve payment link

GET /v2/online-checkout/payment-links/{id}

Retrieves a payment link.


Permissions
ORDERS_READ
Guide
Manage Checkout
Try in API Explorer
Name Description
id
string

Required

The ID of link to retrieve.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

payment_link
PaymentLink

The payment link that is retrieved.

Examples

You are viewing an old version of the API
GET /v2/online-checkout/payment-links/{id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/online-checkout/payment-links/LLO5Q3FRCFICDB4B \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payment_link": {
    "id": "LLO5Q3FRCFICDB4B",
    "version": 1,
    "order_id": "4uKASDATqSd1QQ9jV86sPhMdVEbSJc4F",
    "url": "https://square.link/u/EXAMPLE",
    "created_at": "2022-04-26T00:10:29Z"
  }
}