v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Payments

Delete a payment

Delete a payment and remove all invoice applications.

What happens

  • Payment record is deleted
  • Invoice applications are removed
  • Order statuses revert if needed (PAID → UNPAID)

Note

This action cannot be undone. Consider voiding instead if you need to maintain a record.

delete/payments/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Response

Payment deleted successfully