Skip to main content

SettlementStatus

Lifecycle status of a settlement batch.

  • PENDING - Open batch. Transactions for the period are still being aggregated; the batch is evaluated on scheduledAt.
  • COMPLETED - Aggregation closed with a positive balance, reserve calculated, and the net amount queued for bank transfer to iban.
  • SUSPENDED - On hold. May follow consecutive negative-balance cycles or a manual hold. Excluded from automatic transfer until cleared.
enum SettlementStatus {
COMPLETED
PENDING
SUSPENDED
}

Values

SettlementStatus.COMPLETED

SettlementStatus.PENDING

SettlementStatus.SUSPENDED

Member Of

AccountSettlement object ● SettlementEventObject object