API Object: Payment Charge
A Payment Charge represents a single payment initiated by the partner, fulfilled by the consumer through a specific provider (scheme or network).
A Payment Charge requires some basic information like the payment method, the payment amount, the currency and consumer details.
A Payment Charge has a lifecycle representing payment processing:
- Payment Authentication (if required by the scheme or network)
- Payment Authorization
- Void
- Capture
- Refund
Voids, Captures, and Refunds can all be partial with an amount less than the original authorization amount.
Payment Charge Status
Status | Description |
---|---|
AUTHENTICATION_PENDING | |
AUTHORIZATION_ASYNC | |
AUTHORIZATION_PROCESSING | |
CAPTURE_PENDING | |
CAPTURE_PROCESSING | |
CAPTURED | |
DISCARDED | |
FAILED | |
REFUND_PROCESSING | |
REFUNDED | |
VOID PROCESSING | |
VOIDED |
State Machine
The following diagram shows a Payment Charge's different states, along with transition conditions and events.
Note that the PROCESSING states are not expected to persist for long and only while a processing request is in-flight.
Updated 7 months ago