Skip to main content
Open in Explorer

accountSettlement

Returns a settlement (payout) of the current account by ID. Returns a NotFound error when no settlement of the account has this ID. Arguments: - id: Settlement ID, from accountSettlements or the objectId of a settlement event.

accountSettlement(
  id: ID!
): AccountSettlement

Arguments​

accountSettlement.id ● ID! non-null scalar​

Type​

AccountSettlement object​

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). Amount fields: grossVolume (before fees), acquirerFees, netVolume (after fees; the payout amount once the settlement is COMPLETED, and with settleGross the payout is grossVolume), releasedAmount and reservedAmount; there is no amount field. Date fields, in Unix seconds: scheduledAt (for a COMPLETED settlement the payout date; for PENDING or SUSPENDED the next evaluation, which can move), periodStartAt and periodEndAt (the period).

Last updated on