event

Payment Settled

Emitted when funds for a captured payment have been settled with the acquiring bank

EventNew

Overview

The PaymentSettled event is emitted when funds for a captured payment have been settled with the acquiring bank and are confirmed in the merchant account. It carries the gross, fee, and net amounts, plus details of the settlement instrument used (card network, bank transfer, or digital wallet).

Schema

Event Details

  • Amounts: Gross (captured from the customer), fees (deducted by acquirer/networks), and net (credited to the merchant)
  • Instrument: Exactly one of card, bank transfer, or wallet settlement details is present
  • Batch Settlement: When settled as part of a netted daily batch, batch_id identifies the batch
Event-driven architecture documentation: Acme Inc

PaymentSettled Schema

24 fields
Package:com.ecommerce.payments.settlement(proto3)
Message:Money

An amount of money in a specific currency.

currency_codestring= 1

ISO 4217 currency code, e.g. "EUR"

unitsint64= 2

Whole units of the currency

nanosint32= 3

Fractional units, in nano units (10^-9)

Message:PaymentSettled

Emitted when funds for a captured payment have been settled with the acquiring bank and are confirmed in the merchant account.

settlement_idstring= 1

Unique identifier for this settlement

payment_idstring= 2
merchant_account_idstring= 3
gross_amountMoney= 4

Amount captured from the customer

fee_amountMoney= 5

Fees deducted by the acquirer and card networks

net_amountMoney= 8

Amount credited to the merchant account

settlement_typeSettlementType= 9
Allowed values: SETTLEMENT_TYPE_UNSPECIFIED GROSS NET_BATCH
batch_idstring= 10

Present when settlement_type is NET_BATCH

cardCardSettlement= 11oneof instrument
bank_transferBankTransferSettlement= 12oneof instrument
walletWalletSettlement= 13oneof instrument
statement_descriptorstring= 14

Use merchant_account_id instead

settled_atstring= 15

RFC 3339 timestamp of the settlement confirmation

Enum:SettlementType

How the funds were settled with the acquiring bank.

Allowed values: SETTLEMENT_TYPE_UNSPECIFIED GROSS NET_BATCH
Edit this page