--- updatedAt: 2025-11-13T14:39:41.000Z agentTools: siteIndex: https://docs.affirm.com/llms.txt projectIndex: https://docs.affirm.com/developers/v1.0-Global-Integration/llms.txt --- # List Settlement Event Summaries Lists settlement event summaries by merchant. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Transactions API", "version": "2.0" }, "security": [ { "basicAuth": [] } ], "paths": { "/settlements/daily": { "get": { "tags": [ "Transactions API" ], "x-swagger-router-controller": "affirm.http.api.merchant.transaction.v1.api", "operationId": "list_settlement_event_summaries", "summary": "List Settlement Event Summaries", "description": "Lists settlement event summaries by merchant.", "parameters": [ { "in": "query", "name": "merchant_id", "description": "The Affirm Merchant ID", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The maximum number of results per page. Default is 5.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "in": "query", "name": "after", "description": "The beginning of the date range (inclusive)", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "before", "description": "The end of the date range (inclusive)", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "from_cursor_uuid", "description": "Optional paging cursor uuid after which results should be returned. This uuid, along with from_cursor_date is returned in the prev_page field in the 200 response", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "from_cursor_date", "description": "Optional paging cursor date after which results should be returned. This date, along with from_cursor_uuid is returned in the prev_page field in the 200 response", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "to_cursor_uuid", "description": "Optional paging cursor uuid before which results should be returned. This uuid, along with to_cursor_date is returned in the next_page field in the 200 response", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "to_cursor_date", "description": "Optional paging cursor date before which results should be returned. This date, along with to_cursor_uuid is returned in the next_page field in the 200 response", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "ordering", "description": "Optional parameter to define ordering of results. Default is descending chronological order", "schema": { "type": "string", "enum": [ "ascending", "descending" ] } }, { "in": "header", "name": "country-code", "description": "Required param to identify the country in which Affirm is used and uses an \"alpha-3\" three-letter country code. Supported countries are the United States (`USA`), Canada (`CAN`), and the United Kingdom (`GBR`).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HTTP 200 OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PaginatedSettlementEventSummaryResponse" } } } }, "400": { "description": "HTTP 400 Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorBadRequest" } } } }, "401": { "description": "HTTP 401 Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorUnauthorized" } } } }, "404": { "description": "HTTP 404 Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorNotFound" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "503": { "description": "Unexpected Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UnexpectedError" } } } } } } } }, "servers": [ { "url": "https://api.global.sandbox.affirm.com/api/v1" }, { "url": "https://api.global.affirm.com/api/v1" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "ErrorBadRequest": { "properties": { "message": { "description": "The error message.", "example": "Bad Request", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 400, "type": "integer" }, "type": { "description": "The error type.", "example": "BAD_REQUEST", "type": "string" }, "code": { "description": "The error type.", "example": "BAD_REQUEST", "type": "string" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } }, "type": "object" }, "ErrorNotFound": { "properties": { "message": { "description": "The error message.", "example": "Not Found", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 404, "type": "integer" }, "type": { "description": "The error type.", "example": "NOT_FOUND", "type": "string" }, "code": { "description": "The error type.", "example": "NOT_FOUND", "type": "string" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } }, "type": "object" }, "ErrorUnauthorized": { "properties": { "message": { "description": "The error message.", "example": "Unauthorized", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 401, "type": "integer" }, "type": { "description": "The error type.", "example": "UNAUTHORIZED", "type": "string" }, "code": { "description": "The error type.", "example": "UNAUTHORIZED", "type": "string" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } }, "type": "object" }, "InternalServerError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "internal_server_error" ] }, "message": { "type": "string", "description": "Human readable message with details about the error" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } } }, "UnexpectedError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string", "description": "Human readable message with details about the error" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } } }, "SettlementEventSummary": { "type": "object", "properties": { "date": { "type": "string", "description": "The date corresponding to the settlement events that are being summarized.", "example": "2020-01-31T00:00:00.000Z" }, "deposit_id": { "type": "string", "description": "The ID that a user sees on their bank statement", "example": "DEPOSIT-ARI-123" }, "total_sales": { "type": "integer", "description": "The sum of the disbursements during a given day (before fees), in cents.", "example": 12345 }, "total_refunds": { "type": "integer", "description": "The sum of the refunds disbursed during a given day (before fees), in cents.", "example": -12345 }, "total_fees": { "type": "integer", "description": "The sum of the fees during a given day, in cents.", "example": 12345 }, "total_settled": { "type": "integer", "description": "total_sales - total_fees or total_refunds - total_fees", "example": 12345 }, "account_last_four": { "type": "string", "description": "Last four digits of the disbursed to bank account number", "example": "1234" }, "currency": { "type": "string", "description": "Currency of the deposit associated with the settlement summary", "example": "USD" }, "removal_state": { "type": "string", "description": "Returns the reason for removal, if the settlement had been removed.\n * `failed` - The settlement had failed\n * `rejected` - The settlement was rejected from the disbursements pipeline\n", "enum": [ "failed", "rejected" ] } }, "required": [ "date", "deposit_id", "total_sales", "total_refunds", "total_fees", "total_settled", "currency" ] }, "PaginatedSettlementEventSummaryResponse": { "type": "object", "properties": { "count": { "description": "The number of settlement summary events returned on the current page.", "example": 10, "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementEventSummary" } }, "prev_page": { "type": "string", "description": "URL-encoded parameters that include the date and UUID of the previous results for cursor-based pagination. Empty string if no previous results. Previous results refer to newer results if sorted in descending chronological order, and will refer to older results if sorted in ascending chronological order.", "example": "example.com%2Fprev_page" }, "next_page": { "type": "string", "description": "URL-encoded parameters that include the date and UUID of the next results for cursor-based pagination. Empty string if no next results. Next results refer to older results if sorted in descending chronological order, and will refer to newer results if sorted in ascending chronological order.", "example": "example.com%2Fnext_page" } }, "required": [ "count", "data", "prev_page", "next_page" ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [List Transactions](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/list_transactions.md) * [Authorize Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/authorize_transaction.md) * [List Transaction Events](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/list_transaction_events.md) * [Read Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/read_transaction.md) * [Update Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/update_transaction.md) * [Capture Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/capture_transaction.md) * [Refund Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/refund_transaction.md) * [Void Transaction](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/void_transaction.md) * [List Settlement Events](https://docs.affirm.com/developers/v1.0-Global-Integration/reference/list_settlement_events.md)