Skip to main content
Sent by Commerce when a settlement activity occurs on a payment. ce-type: SettlementEvent

​
Payload

​
account_id
string
required
UUID of the account.
​
settlement_item_id
string
required
UUID of the settlement item.
​
settlement_report_id
string
required
UUID of the settlement report this item belongs to.
​
payment_id
string
UUID of the related payment.
​
type
string
required
Type of settlement activity.Allowed values: CHARGEBACK, COMMISSION, FEE, OTHER, PAYMENT, PAYOUT, REFUND, REJECT
​
currency_code
string
required
ISO 4217 currency code.
​
date
string
required
Settlement date. Format: ISO 8601 date-time.
​
gross_credit_amount
number
required
Gross credit amount.
​
gross_debit_amount
number
required
Gross debit amount.
​
net_credit_amount
number
required
Net credit amount.
​
net_debit_amount
number
required
Net debit amount.
​
commission
number
required
Commission amount applied to this settlement item.