Update check payment status
Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
The transaction must meet all of the following criteria:
- Status: Must be in Processing or Processed status.
- Payment method: Must be a check payment method.
Allowed status values
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Long-lived API token sent in the requestToken header. See API token authentication.
Path parameters
The new status to apply to the check transaction. To mark a check as Paid, send 5. To mark a check as Cancelled, send 0.
Response
Response text for operation: ‘Success’ or ‘Declined’.
Code for the response. Learn more in API Response Codes.
Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.
Boolean indicating whether the operation was successful. A true value
indicates success. A false value indicates failure.