Docs
Dashboard

PaymentState

Enum

Summary states of payment collection for an order.

#

Possible enum values


AUTHORIZED

The full payable amount has been authorized but not fully captured.

BALANCE_DUE

The order still has an amount that must be paid.

FAILED

The required payment processing did not succeed.

OVERPAID

The collected amount is greater than the order’s payable balance.

The order’s payable balance has been collected.

PARTIALLY_AUTHORIZED

Only part of the payable amount has been authorized.

PARTIALLY_REFUNDED

Part of the captured amount has been refunded.

PENDING

No payment attempt has reached a final or authorized state.

REFUNDED

The captured amount has been fully refunded.