AccountSettlement

A settlement (payout) of the current account: the transactions of one period paid as one bank transfer. Settlements are kept apart by currency, payment method, acquirer and, when the account settles to each store, store. The dashboard shows settlements as payouts in Settings > Payouts > Payouts history. All amounts are in the smallest currency unit (cents for EUR).

type AccountSettlement {
  accountId: ID!
  acquirerFees: Int!
  grossVolume: Int!
  iban: String
  id: ID!
  legalName: String
  netVolume: Int!
  payMethod: SettlementPayMethods
  periodEndAt: AWSTimestamp!
  periodStartAt: AWSTimestamp!
  releasedAmount: Int
  reservedAmount: Int
  scheduledAt: AWSTimestamp!
  status: SettlementStatus!
  settleGross: Boolean
  storeId: ID
  currency: String
}

Fields

AccountSettlement.accountId ● ID! non-null scalar

ID of the account the settlement belongs to.

AccountSettlement.acquirerFees ● Int! non-null scalar

Fees deducted from the settlement, in the smallest currency unit. Usually negative. It holds the fee of each transaction, chargeback fees and, on some plans, a fee of 20 (in the smallest currency unit) per payout transfer. Shown as Acquiring fees.

AccountSettlement.grossVolume ● Int! non-null scalar

Total amount of the transactions in the settlement before fees, in the smallest currency unit. Shown as Gross volume.

AccountSettlement.iban ● String scalar

IBAN the payout goes to: the payout IBAN of the account for the settlement currency, or the IBAN of the store for a store settlement. Shown as IBAN. Masked (first 2 and last 4 characters kept) unless the caller holds iban:read.

AccountSettlement.id ● ID! non-null scalar

Settlement ID.

AccountSettlement.legalName ● String scalar

Name of the payout beneficiary: the legal name of the business (its company name when no legal name is set), or the store name for a store settlement. The dashboard shows it in the Store column of a store settlement.

AccountSettlement.netVolume ● Int! non-null scalar

Payout amount, in the smallest currency unit. While PENDING, it is the balance so far: the transactions after fees. It does not include the reserve carried in from the previous payout; that reserve is in reservedAmount. On COMPLETED, MONEI adds releasedAmount and the negative reservedAmount to it, and it is the amount sent to iban (when settleGross is true, grossVolume is sent instead). Shown as Amount, and as the total of Gross volume, Acquiring fees, Released amount and Reserved amount in the payout preview.

AccountSettlement.payMethod ● SettlementPayMethods enum

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

AccountSettlement.periodEndAt ● AWSTimestamp! non-null scalar

Date of the last payment or refund in the settlement, in Unix seconds. Shown with periodStartAt as Period. On a settlement that only carries a reserve, it is the time MONEI opened the settlement.

AccountSettlement.periodStartAt ● AWSTimestamp! non-null scalar

Date of the first payment or refund in the settlement, in Unix seconds. Shown with periodEndAt as Period. On a settlement that only carries a reserve, it is the time MONEI opened the settlement.

AccountSettlement.releasedAmount ● Int scalar

Reserve of the previous payout that MONEI releases into this payout, in the smallest currency unit. Set when the settlement completes; 0 when nothing is released. Shown as Released amount.

AccountSettlement.reservedAmount ● Int scalar

Rolling reserve, in the smallest currency unit. On COMPLETED, the reserve MONEI withholds from this payout, as a negative number. On PENDING, the reserve carried in from the previous payout, as a positive number; MONEI releases it into releasedAmount when the settlement completes. Shown as Reserved amount.

AccountSettlement.scheduledAt ● AWSTimestamp! non-null scalar

Completion date, in Unix seconds (the start of a UTC day). Shown as Completion date: expect the bank transfer after this date. On PENDING and SUSPENDED, it is the date of the next evaluation, moved from a weekend to the next Monday. MONEI moves it to a later date when the balance is zero or negative, when the account is not active, when payouts of the account are on hold, or when payout details are missing. On COMPLETED, it is the day the settlement completed.

AccountSettlement.status ● SettlementStatus! non-null enum

Settlement status. Shown as Status.

AccountSettlement.settleGross ● Boolean scalar

true when the account is paid the gross amount: the transfer is grossVolume, fees are not deducted from it, and no reserve is withheld. MONEI adds the card and Bizum fees of these settlements to the account invoice. false or null: the transfer is netVolume. The payouts history shows the matching value as Amount.

AccountSettlement.storeId ● ID scalar

ID of the store the settlement covers, when the account settles to each store. Null for an account-level settlement.

AccountSettlement.currency ● String scalar

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

Returned By

accountSettlement query

Member Of

AccountSettlementsConnection object