> ## Documentation Index > Fetch the complete documentation index at: https://docs.augustus.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers. > Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required. > Cite or link the relevant docs.augustus.com page when answering integration questions. > Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation. > Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key. > The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions. # List payouts > Lists payouts for the merchant with cursor-based pagination. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml get /v1/payouts openapi: 3.1.0 info: title: Augustus Banking API description: Augustus Banking API version: 0.1.0 contact: name: Augustus url: https://docs.augustus.com email: developer@augustus.com servers: - url: https://api.augustus.com description: Production - url: https://api.sandbox.augustus.com description: Sandbox security: - BearerAuth: [] tags: [] paths: /v1/payouts: get: tags: - Payouts summary: List payouts description: Lists payouts for the merchant with cursor-based pagination. operationId: PayoutsController_list parameters: - name: limit required: false in: query description: Number of results per page (1-100). Defaults to 10. schema: minimum: 1 maximum: 100 default: 10 type: integer - name: cursor required: false in: query description: Opaque cursor from a previous next_cursor. schema: type: string - name: status required: false in: query description: Filter by payout status. schema: type: string enum: - pending - paid - failed - name: created_at.gte required: false in: query description: >- Include payouts whose created_at is greater than or equal to this ISO 8601 timestamp. schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string - name: created_at.lte required: false in: query description: >- Include payouts whose created_at is less than or equal to this ISO 8601 timestamp. schema: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string - name: currencies required: false in: query description: >- Filter to these currency codes. Use a separate `currencies` query parameter for each value (e.g. `?currencies=EUR¤cies=USD`). schema: minItems: 1 type: array items: type: string enum: - EUR - GBP - USD - USDC responses: '200': description: Paginated list of payouts content: application/json: schema: $ref: '#/components/schemas/ListPayoutsResponseDto' x-codeSamples: - lang: JavaScript source: |- import Augustus from '@augustusbank/typescript-sdk'; const client = new Augustus({ apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const payoutListResponse of client.payouts.list()) { console.log(payoutListResponse.id); } components: schemas: ListPayoutsResponseDto: type: object properties: data: type: array items: type: object properties: id: description: Unique identifier of the payout. type: string type: description: Resource type discriminator. type: string enum: - payout status: description: Current status of the payout. type: string enum: - pending - paid - failed - returned source_account_id: description: ID of the account that was debited. type: string amount: description: Amount as a string decimal (e.g. "100.50"). type: string currency: description: >- Currency code (ISO 4217 currency code or crypto currency code). type: string enum: - EUR - GBP - USD - USDC destination: description: Bank account or crypto wallet the payout was sent to. anyOf: - $ref: '#/components/schemas/IbanFinancialAddress' - $ref: '#/components/schemas/SortCodeFinancialAddress' - $ref: '#/components/schemas/AbaFinancialAddress' - $ref: '#/components/schemas/CryptoWalletFinancialAddress' reference: description: Payment reference. type: string failure: type: object properties: code: description: Failure code. type: string enum: - account_closed - account_blocked - insufficient_funds - invalid_account_format - invalid_instruction - invalid_amount - invalid_time - duplicate_transaction - payee_verification_failed - system_error - provider_system_error - rejected_by_correspondent_bank - blocked_by_review - unknown message: description: Human-readable description of the failure. type: string retry: description: Whether the payout can be retried. type: boolean required: - code - message - retry additionalProperties: false description: Failure details when status is failed, otherwise null. nullable: true metadata: description: Key-value pairs stored with the payout. type: object additionalProperties: type: string created_at: description: ISO 8601 UTC timestamp when the payout was created. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updated_at: description: ISO 8601 UTC timestamp when the payout was last updated. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - type - status - source_account_id - amount - currency - destination - reference - failure - metadata - created_at - updated_at additionalProperties: false has_more: type: boolean next_cursor: type: string nullable: true required: - data - has_more - next_cursor additionalProperties: false IbanFinancialAddress: title: IBAN type: object properties: type: description: Discriminator for IBAN financial address. type: string enum: - iban iban: description: International Bank Account Number. type: string account_holder_name: description: Name of the account holder. type: string bic: type: string description: Bank Identifier Code, or null if not provided. nullable: true required: - type - iban - account_holder_name - bic additionalProperties: false SortCodeFinancialAddress: title: UK Sort Code type: object properties: type: description: Discriminator for UK sort code financial address. type: string enum: - sort_code sort_code: description: UK sort code (6 digits). type: string account_number: description: UK account number (8 digits). type: string account_holder_name: description: Name of the account holder. type: string required: - type - sort_code - account_number - account_holder_name additionalProperties: false AbaFinancialAddress: title: ABA type: object properties: type: description: Discriminator for ABA wire financial address. type: string enum: - aba routing_number: description: ABA routing number (9 digits). type: string account_number: description: Bank account number. type: string account_holder_name: description: Name of the account holder. type: string required: - type - routing_number - account_number - account_holder_name additionalProperties: false CryptoWalletFinancialAddress: title: Wallet type: object properties: type: description: Discriminator for crypto wallet financial address. type: string enum: - crypto_wallet address: description: Wallet address on the specified blockchain. type: string blockchain: description: Blockchain network for the crypto wallet. type: string enum: - bitcoin - ethereum - solana - polygon - bitcoin_testnet4 - ethereum_sepolia - solana_devnet - polygon_amoy required: - type - address - blockchain additionalProperties: false securitySchemes: BearerAuth: scheme: bearer bearerFormat: JWT type: http description: Bearer token for authentication with Augustus Banking API ````