Delete (cancel) invoice payment

Cancel a payment and reverse its allocations. Only pending or failed payments can be deleted. Completed payments cannot be deleted - use refunds instead. This operation marks the payment as cancelled and updates invoice statuses.

POST /v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/delete

Delete (cancel) invoice payment

cURL

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/payments/{payment_id}/delete/ \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "<string>",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

PartnerJWTBusinessScopedJWTBasicAuthBearerUnscopedBearerBusinessScoped

Authorization · string · header · required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id · string · required

Pattern: ^[0-9a-f-]+$

payment_id · string<uuid> · required

A UUID string identifying this payment.

Response

200

application/json

Response serializer for invoice payment deletion

message · string · required

Status message

payment_id · string<uuid> · required

UUID of the deleted payment

status · string · required

New status of the payment

updated_at · string<date-time> · required

When the payment was updated