> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a payout > One of this seller's settlements. Another seller's is not found, whatever id is sent. ## OpenAPI ````yaml /api-reference/seller.yaml get /api/v3/seller/payouts/{id} openapi: 3.0.3 info: title: Seller API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: | Spree Seller API v3 - the marketplace seller panel, where a seller runs their own shop inside someone else's marketplace. This is a branch of its own, not a narrowing of the Admin API. Every endpoint is scoped server-side to the seller the request acts as, which is what makes cross-seller access impossible by construction rather than by rule. Sellers never call the Admin API. ## Authentication Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as `Authorization: Bearer `. The token carries a `seller_api` audience — a token minted for the storefront or the back office is not accepted here, and vice versa. There is deliberately **no secret API key** for this branch: a credential that could act as a seller without a seller signing in is exactly what the separate audience exists to prevent. ### Choosing a seller A user may run more than one seller. Login returns the list; send the chosen seller's ID in the `X-Spree-Seller-Id` header on every authenticated request. The store is derived from the seller — never sent — so no header can widen what a seller reaches. A request that names no seller the caller belongs to is rejected with `403`. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Seller sign-in, token refresh, logout, and invitation acceptance - name: Account description: The signed-in user, the sellers they may act for, and what they may do - name: Countries description: Country and state reference data for the panel's address forms - name: Delivery Methods description: >- The seller's own ways to ship, and the marketplace methods shared with them - name: Delivery Profiles description: >- The marketplace's delivery vocabulary — what kind of goods a product is, which decides how it ships - name: Delivery Zones description: >- The marketplace's destinations, for narrowing where a seller's own method ships - name: Onboarding description: >- The marketplace checklist a seller completes before admission, and what they submit against it - name: Policies description: The seller's own legal documents, as the marketplace asks them to publish - name: Product Types description: The types a seller may list a product against, and what each adds - name: Products description: The seller's own catalog - name: Profile description: >- The seller's own record — presentation, contact details, addresses, and tax registration - name: Stock Locations description: Where the seller keeps stock, and so where their returns are sent - name: Team description: Who runs this seller, and the invitations nobody has accepted yet - name: Files description: Uploading the files a profile, a submission or an import uses paths: /api/v3/seller/payouts/{id}: parameters: - name: id in: path required: true description: Payout prefixed ID schema: type: string get: tags: - Earnings summary: Get a payout description: >- One of this seller's settlements. Another seller's is not found, whatever id is sent. parameters: - name: X-Spree-Seller-Id in: header required: true schema: type: string responses: '200': description: payout found content: application/json: example: id: vpo_UkLWZg9DAJ status: pending currency: USD reference: null period_start: null period_end: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' amount: '120.00' transfers_count: 1 provider: system schema: $ref: '#/components/schemas/Payout' '404': description: payout not found content: application/json: example: error: code: record_not_found message: Seller payout not found schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Seller SDK source: |- import { createSellerClient } from '@spree/seller-sdk' const client = createSellerClient({ baseUrl: 'https://your-store.com', jwtToken: 'eyJhbGciOi...', sellerId: 'sel_UkLWZg9DAJ', }) const payout = await client.payouts.get('vpo_UkLWZg9DAJ') components: schemas: Payout: type: object properties: id: type: string status: type: string currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR reference: type: string nullable: true period_start: type: string nullable: true period_end: type: string nullable: true created_at: type: string updated_at: type: string amount: type: string transfers_count: type: number provider: type: string description: >- Payout provider. Built-in: system. Provider gems register more (e.g. stripe). required: - id - status - currency - reference - period_start - period_end - created_at - updated_at - amount - transfers_count - provider x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for an authenticated seller session (`seller_api` audience) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.