Skip to main content

SettlementStatus

Where a captured payment has reached.

enum SettlementStatus {
CAPTURED
REFUNDED
DISPUTED
}

Values

SettlementStatus.CAPTURED

The money was taken and, so far as the merchant knows, is theirs. Some of it may still have been given back — check refundedAmount.

SettlementStatus.REFUNDED

Every last unit of the payment has been returned to the customer.

SettlementStatus.DISPUTED

The customer's bank has questioned this payment. Whether the money moved depends on how the question was answered — check refundedAmount.

Member Of

Settlement object ● settlements query