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

Value	Status	Description
`0`	Cancelled/Voided	Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates “Cancelled” events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled.
`5`	Paid	Marks the check transaction as paid. Updates associated bills to “Paid” status, creates “Paid” events, and sends a `payout_transaction_paid` notification if the notification is enabled.

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 | Value | Status | Description | |-------|--------|-------------| | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. | | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |

Authentication

requestTokenstring

API Key authentication via header

Path parameters

transIdstringRequired

The Payabli transaction ID for the check payment.

checkPaymentStatusenumRequired

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.

Allowed values:

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

pageIdentifierstring or null

Auxiliary validation used internally by payment pages and components.

roomIdlong or null

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatastring or integer or null

The response data.

Errors

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

Value	Status	Description
`0`	Cancelled/Voided	Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates “Cancelled” events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled.
`5`	Paid	Marks the check transaction as paid. Updates associated bills to “Paid” status, creates “Paid” events, and sends a `payout_transaction_paid` notification if the notification is enabled.

1	from payabli import payabli
2	from payabli.environment import payabliEnvironment
3
4	client = payabli(
5	environment=payabliEnvironment.SANDBOX,
6	api_key="YOUR_API_KEY_HERE"
7	)
8
9	client.money_out.update_check_payment_status(
10	trans_id="TRANS123456",
11	check_payment_status="5"
12	)

1	{
2	"responseText": "Success",
3	"responseCode": 1,
4	"pageIdentifier": null,
5	"roomId": 0,
6	"isSuccess": true,
7	"responseData": "TRANS123456"
8	}