SettlementEventObject

Settlement as it was when MONEI emitted a SettlementEvent. It has the fields of AccountSettlement except settleGross, plus period, reservePercent, previousNegative and the statement dates createdAt and updatedAt. Amounts are in the smallest currency unit.

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

ID of the account the settlement belongs to.

SettlementEventObject.acquirerFees ● Int! non-null scalar

Fees deducted from the settlement, in the smallest currency unit. Usually negative. See AccountSettlement.acquirerFees.

SettlementEventObject.createdAt ● AWSTimestamp! non-null scalar

Date of the earliest acquirer statement in the settlement, in Unix seconds. 1 (0 on older settlements) when the settlement holds no statement yet: it only carries a reserve, or it only holds chargebacks.

SettlementEventObject.grossVolume ● Int! non-null scalar

Total amount of the transactions in the settlement before fees, in the smallest currency unit.

SettlementEventObject.iban ● String scalar

IBAN the payout goes to. Masked (first 2 and last 4 characters kept) unless the caller holds iban:read. See AccountSettlement.iban.

SettlementEventObject.id ● ID! non-null scalar

Settlement ID.

SettlementEventObject.legalName ● String scalar

Name of the payout beneficiary: the legal name of the business, or the store name for a store settlement.

SettlementEventObject.netVolume ● Int! non-null scalar

Payout amount, in the smallest currency unit. See AccountSettlement.netVolume.

SettlementEventObject.period ● Int! non-null scalar

Payout period, in days. MONEI uses it to set the next evaluation date when it reschedules the settlement.

SettlementEventObject.payMethod ● SettlementPayMethods enum

Payment method the settlement covers. Null on older settlements means card.

SettlementEventObject.periodEndAt ● AWSTimestamp! non-null scalar

Date of the last payment or refund in the settlement, in Unix seconds.

SettlementEventObject.periodStartAt ● AWSTimestamp! non-null scalar

Date of the first payment or refund in the settlement, in Unix seconds.

SettlementEventObject.previousNegative ● Boolean scalar

true when an evaluation of this settlement found a negative balance. A second negative evaluation suspends the settlement.

SettlementEventObject.releasedAmount ● Int scalar

Reserve of the previous payout that MONEI releases into this payout, in the smallest currency unit.

SettlementEventObject.reservedAmount ● Int scalar

Rolling reserve, in the smallest currency unit. Negative on COMPLETED (withheld), positive on PENDING (carried in). See AccountSettlement.reservedAmount.

SettlementEventObject.reservePercent ● Int! non-null scalar

Rolling reserve rate, as a whole percent from 0 to 100. On completion, MONEI withholds this percent of netVolume plus the carried-in reserve, rounded down. It is 0 when settleGross is true, and MONEI sets it to 0 when it releases the reserve of the account.

SettlementEventObject.scheduledAt ● AWSTimestamp! non-null scalar

Completion date, in Unix seconds. See AccountSettlement.scheduledAt.

SettlementEventObject.status ● SettlementStatus! non-null enum

Settlement status after the change that emitted the event.

SettlementEventObject.updatedAt ● AWSTimestamp! non-null scalar

Date of the latest acquirer statement in the settlement, in Unix seconds. 1 (0 on older settlements) when the settlement holds no statement yet.

SettlementEventObject.storeId ● ID scalar

ID of the store the settlement covers. Null for an account-level settlement.

SettlementEventObject.currency ● String scalar

Three-letter ISO 4217 currency code of the settlement. Null on older settlements means EUR.

Member Of

SettlementEvent object