Settlements
Retrieve and list settlements that group batched payments into a payout.
A settlement groups payments that were batched together and paid out in a single transfer. VINR creates a settlement automatically when a payout is initiated; you cannot create them manually.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The settlement objectAsk
idstringUnique identifier for the settlement, e.g. stl_5Rw9nCpT.
payoutstringExpandableThe payout (po_) this settlement was included in. Expand to retrieve the full payout object.
amountintegerGross amount of the batched payments, in the smallest currency unit (e.g. cents).
currencystringThree-letter ISO currency code, e.g. EUR.
netintegerNet amount after fees, in the smallest currency unit.
transaction_countintegerNumber of individual payment transactions included in this settlement.
createdtimestampUnix timestamp of when the settlement was created.
Retrieve a settlementAsk
List settlementsAsk
Returns a list of settlements, optionally filtered by the associated payout. Results are sorted by creation date, newest first.
Related eventsAsk
settlement.created. See Events.
