Status
: string
in package
Payment state.
Use enum cases in typed PHP code and ->value when building a native
request array. Each case maps exactly to the documented API string.
Table of Contents
Cases
- Canceled = 'canceled'
- The operation was canceled before successful completion.
- Executed = 'executed'
- Execution has been started or completed as defined by the resource lifecycle.
- Expired = 'expired'
- The value is no longer usable because its validity period ended.
- Failed = 'failed'
- The operation did not complete successfully.
- Initiated = 'initiated'
- Processing has been initiated.
- Overdue = 'overdue'
- The operation passed its due time without completing.
- Paid = 'paid'
- Payment completed successfully.
- RequiresAction = 'requires_action'
- Additional customer or merchant action is required before processing can continue.
- Unknown = 'unknown'
- The API could not classify the value more specifically.
Cases
Initiated
Processing has been initiated.
Wire value: initiated.
RequiresAction
Additional customer or merchant action is required before processing can continue.
Wire value: requires_action.
Overdue
The operation passed its due time without completing.
Wire value: overdue.
Executed
Execution has been started or completed as defined by the resource lifecycle.
Wire value: executed.
Paid
Payment completed successfully.
Wire value: paid.
Canceled
The operation was canceled before successful completion.
Wire value: canceled.
Expired
The value is no longer usable because its validity period ended.
Wire value: expired.
Failed
The operation did not complete successfully.
Wire value: failed.
Unknown
The API could not classify the value more specifically.
Wire value: unknown.