Skip to main content

AccountSettlement

Settlement batch grouping a merchant's transactions for one payout period, currency, and payment method. A COMPLETED settlement produces a single bank transfer to iban.

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​

Account ID the settlement belongs to.

AccountSettlement.acquirerFees ● Int! non-null scalar​

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

AccountSettlement.grossVolume ● Int! non-null scalar​

Gross transaction volume for the period (before fees), in minor units.

AccountSettlement.iban ● String scalar​

Destination IBAN for the bank transfer.

AccountSettlement.id ● ID! non-null scalar​

Settlement ID.

Legal name of the account holder receiving the transfer.

AccountSettlement.netVolume ● Int! non-null scalar​

Amount transferred to the merchant for the period, in minor units. While PENDING, this is the running balance (gross minus acquirer fees, plus carried-in reserve). On COMPLETED, this is the net amount sent to iban after the new reserve is withheld.

AccountSettlement.payMethod ● SettlementPayMethods enum​

Payment method the batch covers. Each method settles in its own batch.

AccountSettlement.periodEndAt ● AWSTimestamp! non-null scalar​

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

AccountSettlement.periodStartAt ● AWSTimestamp! non-null scalar​

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

AccountSettlement.releasedAmount ● Int scalar​

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

AccountSettlement.reservedAmount ● Int scalar​

Reserve withheld from this settlement, in minor units. Stored as a negative value on COMPLETED settlements (amount removed from the transfer); appears as a positive carry-in balance on the next PENDING settlement.

AccountSettlement.scheduledAt ● AWSTimestamp! non-null scalar​

Settlement evaluation date as a unix timestamp (seconds). For PENDING settlements: projected closing date (period start + period length, advanced past weekends). For COMPLETED/SUSPENDED: the day the batch was closed.

AccountSettlement.status ● SettlementStatus! non-null enum​

Settlement lifecycle status.

AccountSettlement.settleGross ● Boolean scalar​

When true, the merchant is paid the full grossVolume (acquirer fees not deducted from the transfer) and reservePercent is forced to 0. When false/null, the transfer is netVolume (gross minus acquirer fees, minus reserve).

AccountSettlement.storeId ● ID scalar​

Store ID when the settlement is scoped to a specific store under a multi-store account.

AccountSettlement.currency ● String scalar​

ISO 4217 currency code of the settlement.

Returned By​

accountSettlement query

Member Of​

AccountSettlementsConnection object