Delete a payment or refund

DELETE/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}

v2Operation ID v2_public_sales_order_manual_payment_destroy

Deletes a payment or refund record from the order. Card payments can't be deleted: refund them, or move their money to customer credit. {payment_reference} is the record's id. The answer has no data. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team. The order must be published.

Business rules

• Only published orders: "Payment Action Not Allowed - due to order internal state".
• A recorded payment part of which was moved to customer credit is refused with 422 credit_issued_from_payment ("25.00 of credit was issued from this payment, so it can't be removed."), even after that credit is applied back. A refund of such a payment, and a refund recorded against a card payment, get "Cannot Delete Transaction". A payment's delete_blocked_reason says in advance.
• Card payments are refused with 422 provider_payment_not_removable ("Payments made through a payment provider can't be removed. Use Issue credit or Refund instead."); a voided one gets "Transaction Already Processed".
• A Customer Portal payment, or credit linked to one, can't be changed here: 422 customer_payment_source_immutable ("This credit is linked to its original customer payment and cannot be edited or deleted.").
• Payments from customer credit, moves to customer credit and card refunds can't be deleted: 422 with a message starting "This Middleware".
• A record synced from an integration (Shopify) is refused: "Cannot delete external object from API."

Side effects

• Updates the order's balance, invoices and customer totals; deleting a payment removes payment links left empty.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7
• payment_referencestringrequired

  The payment or refund's id (a hash id).

  • Example hAwWd7vPrqjuHD

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired

  No data.

• 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.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  A draft order, or a record that can't be deleted (credit_issued_from_payment, provider_payment_not_removable, customer_payment_source_immutable; see rules).

  Fix

  Record a refund instead.

Related

• GETList the payments of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/payment/hAwWd7vPrqjuHD' \  -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
}