Delete a payment link

DELETE/v2/api/store/{team_slug}/v2/payment_link/{hash_id}

v2Operation ID v2_public_payment_link_delete

Deletes a payment link and all its allocations. The payments stay recorded on the sales order, unallocated, and the invoices show that much less paid. No money moves.

Permission

Any member of the team. No sales order permission is checked.

Side effects

• Invoices show less paid. The order's customer's balance totals update in the background, and Customer Portal pages the customer has open refresh.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The payment link's hash id. Hash ids only: a unique key or a document number gives 404.

  • Example IirNDCwiaCVSKx

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  The link isn't your team's.

  Fix

  Check the id.

Notes

• Unlike the other payment link calls, delete also works on an order that was deleted in Shopify.

Related

• GETList the payment links of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link
• POSTCreate a payment link for a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/v2/payment_link/IirNDCwiaCVSKx' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}