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

You are viewing an old version of the API
List payment links

GET /v2/online-checkout/payment-links

Lists all payment links.


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

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.

limit
integer (32-bit)

A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored.

Default value: 100

Response Fields

Name Description
errors
Error [ ]

Errors that occurred during the request.

payment_links
PaymentLink [ ]

The list of payment links.

cursor
string

When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see Pagination.

Examples

You are viewing an old version of the API
GET /v2/online-checkout/payment-links
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/online-checkout/payment-links \
  -H 'Square-Version: 2022-06-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payment_links": [
    {
      "id": "TN4BWEDJ9AI5MBIV",
      "version": 2,
      "order_id": "Qqc6yppGvxVwc46Cch4zHTaJqc4F",
      "checkout_options": {
        "ask_for_shipping_address": true
      },
      "url": "https://square.link/u/EXAMPLE",
      "created_at": "2022-04-26T00:15:15Z",
      "updated_at": "2022-04-26T00:18:24Z",
      "payment_note": "test"
    },
    {
      "id": "RY5UNCUMPJN5XKCT",
      "version": 1,
      "description": "",
      "order_id": "EmBmGt3zJD15QeO1dxzBTxMxtwfZY",
      "url": "https://square.link/u/EXAMPLE",
      "created_at": "2022-04-11T23:14:59Z"
    }
  ],
  "cursor": "MTY1NQ=="
}