Reference

Settlement

A settlement represents a payout event to the merchant account based on transactions done in a 24hr period.

Settlement payout is executed in frequence per merchant agreement, e.g. each business day.
A settlement represents a sum of all transactions that credit the merchant account (e.g. purchases) deducted by the sum of all transactions that are debited from the merchant (e.g. refund, chargeback etc.)

If applicable, rolling reserve is deducted from the final net, remaining amount is then paid out to the merchant account.

Property	Type	Description	Optional
reference	string
merchant	string
period	{ start: Date; end: Date }
payout	Date
reserve	{ amount: number; payout?: Date }
created	Date
currency	Currency
gross	number
fee	number | { scheme: number; total: number }
net	number
transactions	Settlement.Transaction

Settlement.Transaction

Property	Type	Description	Optional
authorization	Identifier	ID in our system
reference	string
type	string	"capture", "refund" or "chargeback"
card	string	"debit" or "credit"
currency	Currency	Transaction currency
gross	number	Transaction amount as paid out by card network
fee	number | { scheme: number; total: number }	For merchants on IC++ pricing, transaction fees (scheme fee, interchange fee, Intergiro fee) are broken down and reported separately. For merchants on blended pricing, only total fee is reported.
net	number	Gross amount deducted by all applicable fees
scheme	Scheme	Card network
area	Alpha2
created	Date

Types of Authorizations and Transactions

Payment use-case	Authorization	Settlement Transaction
E-Commerce Purchase	{ "category": "purchase" "capture": [{...}] // ... }	{ "type": "capture" // ... }
Refund	{ "refund": [{...}] // ... }	{ "type": "refund" // ... }
Chargeback	N/A	{ "type": "firstChargeback" // ... }
Topup/Tip	{ "category": "topup" | "tip" "capture": [{...}] }	{ "type": "capture" "wallet": { "type": "topup" | "tip" "payout": number "preliminaryFee": number } }
Funding	{ "category": | "account-to-account" | "person-to-person", "capture": [{...}], // ... }	{ "type": "funding" }
Payout	{ "category": "payout" "capture": [{...}] // ... }	{ "type": "payout" // ... }