Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 1.38 KB

list-payment-links-response.md

File metadata and controls

45 lines (37 loc) · 1.38 KB

List Payment Links Response

Structure

ListPaymentLinksResponse

Fields

Name Type Tags Description
errors Error[] | undefined Optional Errors that occurred during the request.
paymentLinks PaymentLink[] | undefined Optional The list of payment links.
cursor string | undefined Optional 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.

Example (as JSON)

{
  "cursor": "MTY1NQ==",
  "payment_links": [
    {
      "checkout_options": {
        "ask_for_shipping_address": true
      },
      "created_at": "2022-04-26T00:15:15Z",
      "id": "TN4BWEDJ9AI5MBIV",
      "order_id": "Qqc6yppGvxVwc46Cch4zHTaJqc4F",
      "payment_note": "test",
      "updated_at": "2022-04-26T00:18:24Z",
      "url": "https://square.link/u/EXAMPLE",
      "version": 2
    },
    {
      "created_at": "2022-04-11T23:14:59Z",
      "description": "",
      "id": "RY5UNCUMPJN5XKCT",
      "order_id": "EmBmGt3zJD15QeO1dxzBTxMxtwfZY",
      "url": "https://square.link/u/EXAMPLE",
      "version": 1
    }
  ]
}