> ## 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. # Funding a Payout > Fund a payout which is in requires_funding ## OpenAPI ````yaml post /v3/payout/{id}/fund openapi: 3.1.0 info: title: sandbox version: '3' servers: - url: https://service-sandbox.tazapay.com security: - sec0: [] paths: /v3/payout/{id}/fund: post: summary: Funding a Payout description: Fund a payout which is in requires_funding operationId: funding-a-payout parameters: - name: id in: path description: ID of a payout in the state `requires_funding` schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: status: success message: '' data: amount: 1000000 available_balance: -1038 is_balance_sufficient: false balance_transaction: btr_fahfaniaf0023902 beneficiary: bnf_cta4erf3l65o6mqvace0 beneficiary_details: address: null destination: '' destination_details: bank: account_number: '6492749274' account_type: '' bank_codes: aba_code: AIOHFAONF swift_code: SWIFT CODE bank_name: Bank of America branch_name: '' country: US currency: USD firc_required: false purpose_code: '' type: bank documents: [] email: '' name: Test Account USA phone: calling_code: '1' tax_id: '' type: business charge_type: shared created_at: '2024-12-17T07:15:14.691660Z' currency: USD documents: - id: doc_ctgia0ng9n1vh5ns81f0 type: invoice url: >- https://s3.ap-southeast-1.amazonaws.com/tazapay-payout-document/pot_ctgia0ng9n1vh5ns81cg/1734419711360340856_image%20%281%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAUGJYD3OSSENYIX45%2F20241217%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241217T072015Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHYaDmFwLXNvdXRoZWFzdC0xIkcwRQIhAM9um7eR7Mr0x9x7nPCUHqNfsNQOl%2FGYlyBCZU25t1ZaAiA1Qg%2BnFaZXl0ynXNu9cEvoGFXfz86d%2B2CSrPacMzDaOSr0Awg%2FEAEaDDI4ODQxNzM3MzA5MyIM41LZ42vlF4tAc69tKtED12ChC8dNuaNE3xjx6BuhDm6SFBy58FENrzdHcI%2FBV2AA1cjmom4CzMLgXvv29Sf8Iy7s12Kxq3dz5pct5ya9ZVzh8iFjlIX52iQo%2BslhQNiCUKrQqEpwLMiUmDyAb7OV4tARhttrSvbLUOC51KTdyIS4bKqJrncHKzDlzTIRoO9PdM%2BPEFFXUY786C2a23W1sM5GqgnhKd1EUb1iN3AxO7fd7wPhXC6o%2Fym6Wh2TNTGz0uaxXHtLzcDAZJwMNEeKQDaa1YD%2BG3xWSN9m6yyysaDoGewhqrUAeqr1AQvTR47sbdIkFKn7m%2B6wDjK86cQNxpHU61FpgCYwbXBNCaMKqIrXcmamSAiK8m7C4BfxWlrCz7iQXqR3vKGf3Y%2BHhqpkXGk0mHRk%2FI4VWWAeoDxEogdfarZ%2FMk1BEAThH689NDSiCwrf%2FcWw3B0AlRfXWuy5oKyXgDPlku9WYzN7XnbR3ACCOW8NbzJ0nSCiZb71932okKiEpYyrU10BivAboncdGfHpwcQerBlz40ESSpVzKJFFaIRL6LALRzd8ybzofdFgzs5GAoU%2Bbbn6ZqbGXFIGzsoIh4umuOMMEbhoCJnY3np%2FS5pdSjqaZ%2FhKLMipnAoeMNKuhLsGOqUBBIcJEaO3lTmzl9%2B3Kwkun6q5OVe0fLnarcASVwfK12G4TQEfKimM9EbAoOtGqSbIduTaDaW8PbJndpSVHue%2FC%2BeAgjGhIC%2FoUFpUxoGoVuxBdI%2BAuHEf%2FNKnplTjBTT2YBraCnEGjiRLE38owzZ8M1fU3Iymp9KlBTNhCCkp%2BZKPhUD81sv0T3Rh%2FQTSygt3ML9wakZBxvTFosGDKy%2BIbAUUxQ6h&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B&response-content-type=image%2Fpng&x-id=GetObject&X-Amz-Signature=8be0fdb60f69daad7d4cb4b92b2790b5ff3e8f5ef8a5ecebe6f84140a211ec91 holding_currency: SEK holding_fx_transaction: exchange_rate: 0.087096 final: amount: 1000000 currency: USD id: fx_ctgia0lpk5p8ci902fsg initial: amount: 11481567 currency: SEK object: fx_transaction id: pot_ctgia0ng9n1vh5ns81cg metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 1000000 currency: USD id: fx_ctgia0lpk5p8ci902fs0 initial: amount: 1000000 currency: USD object: fx_transaction purpose: PYR002 reference_id: '' statement_descriptor: '' status: processing status_description: '' failure: null tracking_details: null transaction_description: '' type: swift schema: type: object properties: status: type: string message: type: string data: $ref: '#/components/schemas/PayoutData' '400': description: Bad Request content: application/json: examples: Result: value: '{}' 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. 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 - wallet - local_payment_network - tazapay_account bank: $ref: '#/components/schemas/Bank' wallet: $ref: '#/components/schemas/Wallet' local_payment_network: $ref: '#/components/schemas/LocalPaymentNetwork' tazapay_account: $ref: '#/components/schemas/TazapayAccount' 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) Wallet: type: object description: Crypto wallet destination details required: - deposit_address - type - currency properties: deposit_address: type: string description: Blockchain wallet address type: type: string description: >- Type of blockchain wallet (e.g., ethereum, bitcoin_lightning_network). Use `bitcoin_lightning_network` for BTC currency only. enum: - ethereum - tron - polygon - solana - bitcoin_lightning_network currency: type: string description: Cryptocurrency code (e.g., USDC, BTC, ETH) hosted: type: string description: Whether wallet is hosted/custodial enum: - 'yes' - 'no' vasp_name: type: string description: Virtual Asset Service Provider name (required for hosted wallets) vasp_website: type: string description: VASP website URL (required for hosted wallets) 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 TazapayAccount: type: object description: Tazapay account destination details required: - deposit_address properties: deposit_address: type: string description: Tazapay account deposit address (format - xxxxx@tzp) 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 ````