Delete (cancel) bill payment

Cancel a bill payment and reverse its allocations. Only pending or failed payments can be deleted. Completed payments cannot be deleted. This operation marks the payment as cancelled and updates bill statuses. Following the REST pattern, this uses POST method as it’s a state change operation, not a resource deletion.

POST /v1/platform/businesses/{business_id}/bills/payments/{bill_payment_id}/delete

Delete (cancel) bill payment

cURL

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bills/payments/{bill_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

BusinessScopedJWTPartnerJWTBasicAuthBearerUnscopedBearerBusinessScoped

Authorization · string · header · required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

bill_payment_id · string<uuid> · required

Bill Payment UUID

business_id · string<uuid> · required

Business UUID

Response

200

application/json

Response serializer for bill payment cancellation

message · string · required

Status message

payment_id · string<uuid> · required

UUID of the cancelled payment

status · string · required

New status of the payment

updated_at · string<date-time> · required

When the payment was updated