> ## Documentation Index > Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt > Use this file to discover all available pages before exploring further. # List Payouts > Returns a paginated list of the payouts of your account, newest first. Every filter is optional and all the filters that are sent are combined. ## OpenAPI ````yaml get /v3/payout openapi: 3.1.0 info: title: sandbox version: '3' servers: - url: https://service-sandbox.tazapay.com security: - sec0: [] paths: /v3/payout: get: summary: List Payouts description: >- Returns a paginated list of the payouts of your account, newest first. Every filter is optional and all the filters that are sent are combined. operationId: list-payouts parameters: - name: limit in: query description: Number of payouts to return, from 1 to 100. Default is 10. schema: type: integer format: int32 minimum: 1 maximum: 100 default: 10 - name: starting_after in: query description: >- A payout ID (starts with pot_) used as a cursor. Returns the payouts created after this payout, oldest first. Cannot be used together with ending_before. schema: type: string - name: ending_before in: query description: >- A payout ID (starts with pot_) used as a cursor. Returns the payouts created before this payout, newest first. Cannot be used together with starting_after. schema: type: string - name: created.gt in: query description: >- Returns payouts created after this time (RFC 3339, e.g. 2026-10-01T00:00:00Z). schema: type: string format: date-time - name: created.gte in: query description: >- Returns payouts created at or after this time. Cannot be used together with created.gt. schema: type: string format: date-time - name: created.lt in: query description: Returns payouts created before this time. schema: type: string format: date-time - name: created.lte in: query description: >- Returns payouts created at or before this time. Cannot be used together with created.lt. schema: type: string format: date-time - name: type in: query description: Filter by the type of the payout. schema: type: string enum: - local - swift - wallet - local_payment_network - tazapay_account - name: local.fund_transfer_network in: query description: >- Filter local payouts by the fund transfer network, exact match and case insensitive, e.g. sepa. schema: type: string - name: swift.charge_type in: query description: Filter swift payouts by the charge type. schema: type: string enum: - shared - ours - name: beneficiary in: query description: Filter by the beneficiary ID (starts with bnf_). schema: type: string - name: status in: query description: Filter by the status of the payout. schema: type: string enum: - requires_approval - requires_action - requires_funding - requires_confirmation - compliance_hold - approval_hold - initiator_bank_hold - processing - succeeded - failed - cancelled - reversed - name: on_behalf_of in: query description: >- Filter by the entity the payouts were made on behalf of (starts with ent_). schema: type: string responses: '200': description: List of payouts. content: application/json: schema: type: object properties: status: type: string description: Status of API request message: type: string description: Message returned as part of the API response data: type: object properties: object: type: string description: Always list. has_more: type: boolean description: Whether there are more payouts after this page. results: type: array description: >- The payouts of this page, each one in the same format as Fetch Payout. items: $ref: '#/components/schemas/PayoutData' examples: Result: value: status: success message: '' data: object: list has_more: false results: - amount: 3000000 balance_transaction: btr_dhuvflvi5frlneafr0 beneficiary: bnf_d0dla9u8dpp4edio0 beneficiary_details: address: null date_of_birth: '' destination: '' destination_details: bank: account_type: '' bank_codes: swift_code: FBDEFF bank_name: ER VOLKSBANK EG branch_name: '' country: DE currency: EUR firc_required: false iban: DE535019045650474185 purpose_code: '' transfer_type: any type: bank documents: [] email: '' name: GMBH name_local: '' national_identification_number: '' party_classification: '' phone: calling_code: '49' registration_number: '' tax_id: '' type: business charge_type: '' confirmation_documents: [] created_at: '2025-09-16T08:27:41.832Z' currency: EUR documents: [] holding_currency: USD holding_fx_quote: fx_d34hc7loipp34fmg holding_fx_transaction: exchange_rate: 0.846438 final: amount: 3000000 currency: EUR id: fx_d34flc7loipp34fmg initial: amount: 3544266 currency: USD object: fx_transaction id: pot_d34hlvi5frlneafo0 local: fund_transfer_network: sepa logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 3000000 currency: EUR id: fx_d34huvflc7pp34fm0 initial: amount: 3000000 currency: EUR object: fx_transaction purpose: PYR001 reference_id: DE-LOG-2024-0909 statement_descriptor: Logistics Payment status: succeeded status_description: '' failure: null tracking_details: tracking_number: 098771252590P9A tracking_type: UTR transaction_description: Payment for logistic services 9-09 type: local '400': description: Invalid request. content: application/json: examples: Result: value: status: error message: 'Bad Request : Your request is invalid' errors: - code: 20343 message: >- Field limit must be a positive integer between 1 and 100 remarks: limit schema: $ref: '#/components/schemas/ErrorResponse' deprecated: false components: schemas: PayoutData: type: object description: Contains detailed information about a payout object. properties: amount: type: integer default: 0 description: Amount of the payout. available_balance: type: integer description: >- Available balance in the holding currency account after this payout is processed. balance_transaction: type: string description: Balance transaction ID associated with this payout. beneficiary: type: string description: Beneficiary identifier. beneficiary_details: $ref: '#/components/schemas/BeneficiaryDetails' charge_type: type: string description: Charge type of payout. enum: - ours - shared confirmation_documents: type: array description: List of documents confirming payout. items: type: object properties: key: type: string type: type: string value: type: string created_at: type: string description: Timestamp when payout was created. currency: type: string description: Currency of the payout. documents: type: array description: Documents associated with payout. holding_currency: type: string description: Currency held for payout. holding_fx_quote: type: string description: Holding FX quote ID. holding_fx_transaction: $ref: '#/components/schemas/FxTransaction' id: type: string description: Unique payout identifier. is_balance_sufficient: type: boolean description: >- Indicates whether the account has sufficient balance to process this payout. local: type: object description: Local payout configuration. properties: fund_transfer_network: type: string description: Local fund transfer network used. swift: type: object description: SWIFT payout configuration. Present for swift-type payouts. properties: fund_transfer_network: type: string description: >- SWIFT fund transfer network used. 'cross_border_wire' indicates the payout was routed via the Cross-border USD Wire network, displayed in the Tazapay dashboard as 'Cross-border USD Wire (via Fedwire/SWIFT)'. logistics_tracking_details: type: array description: Logistics tracking details. Mandatory for CNY local payouts. items: type: object properties: tracking_number: type: string logistics_provider: type: object properties: name: type: string code: type: string metadata: $ref: '#/components/schemas/Metadata' mt103: type: string description: SWIFT MT103 details if available. object: type: string description: Type of object (payout). on_behalf_of: type: string description: Entity on whose behalf the payout is made. payout_fx_transaction: $ref: '#/components/schemas/FxTransaction' payout_quote: type: string description: Payout quote reference. purpose: type: string description: Purpose code for the payout. quote: type: string description: Quote ID from the payout quote API. reference_id: type: string description: External reference ID for payout. reversal_balance_transaction: type: string description: >- Id of the reverse balance transaction linked to this payout. Only present when status is 'reversed'. reversal_payout_fx_transaction: $ref: '#/components/schemas/FxTransaction' statement_descriptor: type: string description: Statement descriptor for the payout. status: type: string description: Current status of the payout. status_description: type: string description: Detailed status description. failure: type: object nullable: true description: >- Failure details of the payout. Only present when the payout has failed. properties: code: type: string description: >- Error code indicating the reason for the payout failure. Refer to the failure code list [**here**](/API-Reference/appendix/payout-failure-reasons-updated). description: type: string description: Human-readable description of the failure reason. tracking_details: type: object description: Tracking details of payout. properties: tracking_number: type: string description: Tracking number (UETR, UTR, transaction hash, etc.) tracking_type: type: string description: Tracking type used for payout. enum: - uetr - utr - transaction_hash transaction_description: type: string description: Description or memo for the payout transaction. items: type: array description: List of invoice line items for the payout items: $ref: '#/components/schemas/PayoutItem' type: type: string description: Type of payout. enum: - swift - local - wallet - local_payment_network - tazapay_account ErrorResponse: type: object description: Standard error response structure properties: status: type: string enum: - error description: Always 'error' for error responses message: type: string description: High-level error message errors: type: array description: Array of detailed error objects items: type: object properties: code: type: integer description: Specific error code message: type: string description: Detailed error message remarks: type: string description: Additional context or suggestions for resolution BeneficiaryDetails: type: object description: >- Comprehensive beneficiary information including personal details and destination required: - name - type properties: name: type: string description: Name of the beneficiary maxLength: 140 email: type: string description: Email address of the beneficiary type: type: string description: Type of beneficiary entity enum: - business - individual address: $ref: '#/components/schemas/Address' phone: $ref: '#/components/schemas/Phone' destination_details: $ref: '#/components/schemas/DestinationDetails' tax_id: type: string description: Tax ID of the beneficiary (e.g., CPF or CNPJ for Brazil) national_identification_number: type: string description: National ID of the individual registration_number: type: string description: Registration number of the business date_of_birth: type: string description: Date of birth of individual (format DD-MM-YYYY) nationality: type: string description: Nationality (ISO 3166-1 alpha-2 country code) destination: type: string description: Destination identifier documents: type: array description: Array of supporting documents name_local: type: string description: Local name of the beneficiary party_classification: type: string description: Party classification status: type: string description: Status of the beneficiary FxTransaction: type: object description: Details of an FX conversion transaction properties: exchange_rate: type: number description: FX exchange rate applied final: type: object description: Final amount and currency after FX conversion properties: amount: type: number description: Final amount after FX conversion currency: type: string description: Currency of the final amount id: type: string description: FX transaction ID initial: type: object description: Initial amount and currency before FX conversion properties: amount: type: number description: Initial amount before FX conversion currency: type: string description: Currency of the initial amount object: type: string description: Object type (fx_transaction) Metadata: type: object description: Custom metadata key-value pairs attached to the object additionalProperties: type: string nullable: true PayoutItem: type: object description: >- Invoice line item for a payout. Required fields are name, quantity, amount, and category. Currently only the "Goods" category is accepted. Amounts are in minor units of the payout currency. required: - name - quantity - amount - category properties: name: type: string description: Name of the goods item. Maximum 512 characters. maxLength: 512 quantity: type: integer description: Number of units. Must be at least 1. format: int32 minimum: 1 amount: type: integer description: >- Unit price of the item in minor units of the payout currency (e.g., 10000 = CNY 100.00). Must be greater than 0. format: int64 minimum: 1 category: type: string description: Category of the item. Currently only "Goods" is accepted. enum: - Goods description: type: string description: Optional free-text description of the item. Maximum 512 characters. maxLength: 512 Address: type: object description: Address details properties: line1: type: string description: Address Line 1 line2: type: string description: Address Line 2 city: type: string description: Address city state: type: string description: Address state country: type: string description: Address country (ISO 3166-1 alpha-2 country code) postal_code: type: string description: Postal Code Phone: type: object description: Phone contact details properties: calling_code: type: string description: >- Calling country code (for example, '1' for United States, '91' for India) number: type: string description: Phone Number DestinationDetails: type: object description: >- Destination details for beneficiary payouts (discriminated union based on type) required: - type properties: type: type: string description: Type of destination enum: - bank - local_payment_network bank: $ref: '#/components/schemas/Bank' local_payment_network: $ref: '#/components/schemas/LocalPaymentNetwork' Bank: type: object description: Bank account details properties: account_number: type: string description: Bank Account Number. Either account_number or IBAN is mandatory iban: type: string description: IBAN. Either account_number or iban is mandatory bank_name: type: string description: Name of the bank branch_name: type: string description: Name of the branch country: type: string description: Two-letter country code (ISO 3166-1 alpha-2) currency: type: string description: Three-letter ISO currency code, in uppercase purpose_code: type: string description: Purpose Code for INR bank accounts bank_codes: $ref: '#/components/schemas/BankCodes' firc_required: type: boolean description: Pass true if you want FIRC for a payout to India account_type: type: string description: Type of bank account enum: - savings - checking - payment account_holder_name: type: string description: Name of the account holder transfer_type: type: string description: Type of transfer (e.g., local, SWIFT) LocalPaymentNetwork: type: object description: Local payment network destination details (e.g., PIX, UPI, PromptPay) required: - type - deposit_key properties: type: type: string description: >- Type of local payment network (e.g., pix_brl, upi_inr, promptpay_thb) deposit_key_type: type: string description: >- Type of the deposit key (conditionally mandatory depending on network type) deposit_key: type: string description: >- Deposit key for the local payment network (e.g., PIX key, UPI handle) currency: type: string description: Currency code for the local payment network BankCodes: type: object description: Bank specific identification codes properties: swift_code: type: string description: SWIFT Code bic_code: type: string description: Bank Identifier Code (BIC) ifsc_code: type: string description: IFS Code aba_code: type: string description: ABA / Routing Number sort_code: type: string description: SORT Code branch_code: type: string description: Branch Code bsb_code: type: string description: BSB Code bank_code: type: string description: Bank Code cnaps: type: string description: CNAPS securitySchemes: sec0: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.