> ## Documentation Index > Fetch the complete documentation index at: https://docs.lite.sa/llms.txt > Use this file to discover all available pages before exploring further. # List payouts > Retrieves the merchant's payouts, newest first. ## OpenAPI ````yaml /openapi/account-settlement.json get /settlements/payouts openapi: 3.1.0 info: title: lite - Account Settlement version: 1.0.0 servers: - url: https://api.lite.sa/v1 description: Production security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Settlement Windows description: Manage settlement windows for merchant payout cycles - name: Transactions description: Query settlement transactions and their details - name: Settlement description: >- Register verified seller settlement accounts, view acceptance account balances, and pay out on demand from an acceptance account to a settlement account paths: /settlements/payouts: servers: - url: https://api.lite.sa description: Production get: tags: - Settlement summary: List payouts description: | Retrieves the merchant's payouts, newest first. operationId: lite.settlement.listPayouts parameters: - $ref: '#/components/parameters/x-correlation-id' - name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number (1-indexed) - name: page_size in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 description: Number of items per page - name: acceptance_account_id in: query required: false schema: type: string format: uuid description: Filter by acceptance account - name: settlement_account_id in: query required: false schema: type: string format: uuid description: Filter by settlement account - name: reference in: query required: false schema: type: string description: Filter by the merchant's payout reference - name: status in: query required: false schema: type: string enum: - INITIATED - IN_PROGRESS - SUCCESS - FAILED description: Filter by payout status - name: date_from in: query required: false schema: type: string format: date-time description: Filter payouts created from this date (ISO 8601 format) - name: date_to in: query required: false schema: type: string format: date-time description: Filter payouts created up to this date (ISO 8601 format) responses: '200': $ref: '#/components/responses/PayoutList' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' security: - ApiKeyAuth: [] components: parameters: x-correlation-id: name: x-correlation-id in: header required: false description: >- Unique identifier for request tracing. Generated by the client or server if not provided. schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 responses: PayoutList: description: List of payouts retrieved successfully. content: application/json: schema: type: object required: - data - pagination_data properties: data: type: array description: List of payouts items: $ref: '#/components/schemas/Payout' pagination_data: $ref: '#/components/schemas/PaginationData' BadRequest: description: > The request was invalid or malformed. Returned when: - Request validation fails (missing required fields, invalid field formats) - Payment details do not match the session (amount, currency, order reference mismatch) - The operation is not allowed given the current resource state content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: | Authentication failed — missing or invalid token. Returned when: - The JWT bearer token is missing, expired, or has an invalid signature - The API key is missing or invalid - The authenticated session token is invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: > Request blocked by security policy. Returned when: - A security threat is detected (SQL injection, XSS, NoSQL injection, LDAP injection, path traversal) - Header injection or suspicious headers are detected - The request payload exceeds the maximum allowed size - Geo-region validation fails (user country does not match client region) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalServerError: description: > An unexpected error occurred on the server. Returned when an unhandled exception or infrastructure failure prevents the request from being processed. Retry the request with exponential backoff. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: Payout: type: object description: A payout from an acceptance account to a settlement account required: - id - status - acceptance_account_id - settlement_account_id - amount - fee - currency - created_at - updated_at properties: id: type: string format: uuid description: Unique payout identifier example: 9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d status: type: string description: Payout status oneOf: - title: Initiated const: INITIATED description: Payout accepted and funds held - title: In Progress const: IN_PROGRESS description: Transfer sent to the bank - title: Success const: SUCCESS description: Funds delivered to the settlement account - title: Failed const: FAILED description: Payout failed and the held funds were released acceptance_account_id: type: string format: uuid description: Acceptance account debited example: 550e8400-e29b-41d4-a716-446655440000 settlement_account_id: type: string format: uuid description: Settlement account credited example: 4b0f6c1e-2d3a-4f5b-8c7d-9e0f1a2b3c4d amount: type: integer description: Payout amount in minor units minimum: 1 example: 150000 fee: type: integer description: Payout fee in minor units minimum: 0 example: 250 currency: type: string description: ISO 4217 currency code example: SAR reference: type: - string - 'null' description: Merchant's own reference for the payout example: tiktok-payout-5531 failure_reason: type: - string - 'null' description: Reason the payout failed, set only when status is FAILED example: null created_at: type: string format: date-time description: Timestamp when the payout was created example: '2026-09-29T10:00:00.000Z' updated_at: type: string format: date-time description: Timestamp of the last status change example: '2026-09-29T10:00:00.000Z' PaginationData: type: object description: Pagination metadata for list responses required: - count - pages - page - page_size - has_next - has_previous properties: count: type: integer description: Total number of items matching the query minimum: 0 example: 100 pages: type: integer description: Total number of pages minimum: 0 example: 4 page: type: integer description: Current page number (1-indexed) minimum: 1 example: 1 page_size: type: integer description: Number of items per page minimum: 1 example: 25 has_next: type: boolean description: Whether there is a next page example: true has_previous: type: boolean description: Whether there is a previous page example: false ErrorResponse: type: object required: - error properties: error: type: object required: - code - message - timestamp properties: code: type: string description: Error code identifying the type of error example: PAYMENT_DETAILS_MISMATCH message: type: string description: Human-readable error description example: The request was invalid or malformed details: type: object description: Additional error details correlationId: type: string format: uuid description: Correlation ID for tracking the request example: 550e8400-e29b-41d4-a716-446655440000 timestamp: type: string format: date-time description: Timestamp when the error occurred example: '2024-12-16T10:30:00.000Z' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key for service-to-service or merchant authentication. BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT Bearer token obtained from user authentication. Passed as Authorization: Bearer . ````