moneyOut
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. |
patch/MoneyOut/status/{transId}/{checkPaymentStatus}
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/MoneyOut/status/{transId}/{checkPaymentStatus}
- Auth: HTTP bearer
Path parameters
transIdstring required
The Payabli transaction ID for the check payment.
checkPaymentStatus'0' | '5' required
The new status to apply to a check payment transaction.
- 0: Cancelled/Voided — Cancels the check transaction.
- 5: Paid — Marks the check transaction as paid.
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
Success
Changes
No recorded changes to this operation across all 1 revision of this API.