Skip to main content

SettlementEventObject

Settlement snapshot embedded in a SettlementEvent (state at the time the event was emitted). Mirrors AccountSettlement plus internal lifecycle fields.

type SettlementEventObject {
  accountId: ID!
  acquirerFees: Int!
  createdAt: AWSTimestamp!
  grossVolume: Int!
  iban: String
  id: ID!
  legalName: String
  netVolume: Int!
  period: Int!
  payMethod: SettlementPayMethods
  periodEndAt: AWSTimestamp!
  periodStartAt: AWSTimestamp!
  previousNegative: Boolean
  releasedAmount: Int
  reservedAmount: Int
  reservePercent: Int!
  scheduledAt: AWSTimestamp!
  status: SettlementStatus!
  updatedAt: AWSTimestamp!
  storeId: ID
  currency: String
}

Fields​

SettlementEventObject.accountId ● ID! non-null scalar​

Account ID the settlement belongs to.

SettlementEventObject.acquirerFees ● Int! non-null scalar​

Acquirer/processing fees accrued for the period, in minor units.

SettlementEventObject.createdAt ● AWSTimestamp! non-null scalar​

Statement date of the first transaction aggregated into this settlement, as a unix timestamp (seconds). May be set to 1 on reserve-carry-in batches before any transactions have been processed.

SettlementEventObject.grossVolume ● Int! non-null scalar​

Gross transaction volume for the period, in minor units.

SettlementEventObject.iban ● String scalar​

Destination IBAN for the bank transfer.

SettlementEventObject.id ● ID! non-null scalar​

Settlement ID.

Legal name of the account holder receiving the transfer.

SettlementEventObject.netVolume ● Int! non-null scalar​

Amount transferred to the merchant for the period, in minor units. See AccountSettlement.netVolume.

SettlementEventObject.period ● Int! non-null scalar​

Settlement period length in days (interval between successive settlements for the account).

SettlementEventObject.payMethod ● SettlementPayMethods enum​

Payment method the batch covers.

SettlementEventObject.periodEndAt ● AWSTimestamp! non-null scalar​

End of the settlement period (timestamp of the last transaction included), as a unix timestamp (seconds).

SettlementEventObject.periodStartAt ● AWSTimestamp! non-null scalar​

Start of the settlement period (timestamp of the first transaction included), as a unix timestamp (seconds).

SettlementEventObject.previousNegative ● Boolean scalar​

true when the previous cycle closed with a negative balance.

SettlementEventObject.releasedAmount ● Int scalar​

Reserve released into this settlement from the previous period, in minor units.

SettlementEventObject.reservedAmount ● Int scalar​

Reserve associated with this settlement, in minor units. Sign convention matches AccountSettlement.reservedAmount.

SettlementEventObject.reservePercent ● Int! non-null scalar​

Reserve rate applied to this settlement, as a whole-number percent (0-100). Forced to 0 when settleGross is true or after a manual reserve release.

SettlementEventObject.scheduledAt ● AWSTimestamp! non-null scalar​

Settlement evaluation date as a unix timestamp (seconds). See AccountSettlement.scheduledAt.

SettlementEventObject.status ● SettlementStatus! non-null enum​

Settlement lifecycle status at the time of the event.

SettlementEventObject.updatedAt ● AWSTimestamp! non-null scalar​

Statement date of the most recent transaction aggregated into this settlement, as a unix timestamp (seconds). May be set to 1 on reserve-carry-in batches before any transactions have been processed.

SettlementEventObject.storeId ● ID scalar​

Store ID when the settlement is scoped to a specific store.

SettlementEventObject.currency ● String scalar​

ISO 4217 currency code of the settlement.

Member Of​

SettlementEvent object