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

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

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

Deletes a payment link.

Permissions
ORDERS_READ
ORDERS_WRITE
Guide
Manage Checkout Try in API Explorer

Path Parameters

Example code
Name Description
id
string
Required

The ID of the payment link to delete.

Response Fields
Name Description
errors
Error [ ]
id
string

The ID of the link that is deleted.
cancelled_order_id
string

The ID of the order that is canceled. When a payment link is deleted, Square updates the the state (of the order that the checkout link created) to CANCELED.

Examples

You are viewing an old version of the API
DELETE /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/MQASNYL6QB6DFCJ3 \
  -X DELETE \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON 
{
  "id": "MQASNYL6QB6DFCJ3",
  "cancelled_order_id": "asx8LgZ6MRzD0fObfkJ6obBmSh4F"
}