Affirm · Schema

SettlementEventSummary

An aggregated summary of settlement activity for a single disbursement batch from Affirm to the merchant.

FintechBNPLLendingPaymentsConsumer

Properties

Name Type Description
id string A unique identifier for this settlement event summary.
total_amount integer Total amount disbursed in this batch in the smallest currency unit.
currency string ISO 4217 currency code for this disbursement.
event_count integer Number of individual settlement events included in this batch.
disbursed_at string Timestamp when the disbursement was initiated, in RFC 3339 format.
View JSON Schema on GitHub

JSON Schema

transactions-settlement-event-summary-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/transactions-settlement-event-summary-schema.json",
  "title": "SettlementEventSummary",
  "description": "An aggregated summary of settlement activity for a single disbursement batch from Affirm to the merchant.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique identifier for this settlement event summary.",
      "example": "500123"
    },
    "total_amount": {
      "type": "integer",
      "description": "Total amount disbursed in this batch in the smallest currency unit.",
      "example": 1
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for this disbursement.",
      "example": "USD"
    },
    "event_count": {
      "type": "integer",
      "description": "Number of individual settlement events included in this batch.",
      "example": 1
    },
    "disbursed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the disbursement was initiated, in RFC 3339 format.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}