> ## 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.

# Confirm Payout

> Confirm a payout by attaching source of funds



## OpenAPI

````yaml post /payout/{id}/confirm
openapi: 3.1.0
info:
  title: sandbox
  version: '3'
servers:
  - url: https://service-sandbox.tazapay.com
security:
  - sec0: []
paths:
  /payout/{id}/confirm:
    post:
      operationId: post_payout{id}confirm
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the payout
          schema:
            type: string
            default: ''
      requestBody:
        content:
          application/json:
            schema:
              properties:
                source:
                  type: string
                  description: ID of the collect to fund the payout
              type: object
              required:
                - source
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                OK:
                  summary: OK
                  value:
                    amount: 5000
                    balance_transaction: btr_d24adsvfccunngaiu2bg
                    beneficiary: bnf_d24adp7fccunngaiu20g
                    beneficiary_details:
                      address: null
                      date_of_birth: ''
                      destination: ''
                      destination_details:
                        bank:
                          account_type: ''
                          bank_codes: {}
                          bank_name: testfxbank
                          branch_name: ''
                          country: FR
                          currency: EUR
                          firc_required: false
                          iban: '31'
                          purpose_code: ''
                          transfer_type: local
                        type: bank
                      documents: []
                      email: ''
                      name: Jackie Morissette
                      national_identification_number: ''
                      party_classification: ''
                      phone:
                        calling_code: '33'
                      registration_number: ''
                      tax_id: ''
                      type: individual
                      status: active
                    charge_type: ''
                    confirmation_documents: []
                    created_at: '2025-07-29T10:48:19.014533Z'
                    currency: EUR
                    documents: []
                    holding_currency: USD
                    holding_fx_transaction:
                      exchange_rate: 0.828672
                      final:
                        amount: 5000
                        currency: EUR
                      id: fx_d24adsmp89reuemeaujg
                      initial:
                        amount: 6034
                        currency: USD
                      object: fx_transaction
                    id: pot_d24adsnfccunngaiu280
                    local:
                      fund_transfer_network: sepa
                    logistics_tracking_details: []
                    metadata:
                      collect_id: col_d24ae102tsfj74sj23s0
                      transaction_hash: >-
                        0xie4el49kctwen8rf6urv7wirrtemva9bqhjlct7j1v9jp8r4eya4zg08c80xkgxo
                    mt103: ''
                    object: payout
                    on_behalf_of: ''
                    payout_fx_transaction:
                      exchange_rate: 1
                      final:
                        amount: 5000
                        currency: EUR
                      id: fx_d24adsmp89reuemeauj0
                      initial:
                        amount: 5000
                        currency: EUR
                      object: fx_transaction
                    purpose: PYR008
                    reference_id: ''
                    source: col_d24ae102tsfj74sj23s0
                    statement_descriptor: ''
                    status: processing
                    status_description: ''
                    failure: null
                    tracking_details: null
                    transaction_description: Payout Description
                    type: local
              schema:
                type: object
                properties:
                  amount:
                    type: number
                    description: Amount of the payout in payout currency
                  balance_transaction:
                    type: string
                    description: ID of the balance transaction associated with this payout
                  beneficiary:
                    type: string
                    description: Unique identifier of the payout beneficiary
                  beneficiary_details:
                    $ref: '#/components/schemas/BeneficiaryDetails'
                  charge_type:
                    type: string
                    description: Type of charge (e.g., shared, ours, beneficiary)
                  confirmation_documents:
                    type: array
                    description: List of confirmation documents uploaded for the payout
                  created_at:
                    type: string
                    description: Timestamp when the payout was created
                  currency:
                    type: string
                    description: Currency of the payout
                  documents:
                    type: array
                    description: List of payout-related documents
                  holding_currency:
                    type: string
                    description: Currency in which funds are held before conversion
                  holding_fx_transaction:
                    $ref: '#/components/schemas/FxTransaction'
                  id:
                    type: string
                    description: Unique payout ID
                  local:
                    type: object
                    description: Local payout information
                    properties:
                      fund_transfer_network:
                        type: string
                        description: Network used for local transfer
                  logistics_tracking_details:
                    type: array
                    description: >-
                      Tracking details for logistics-related payouts (if
                      applicable). This is mandatory for CNY local payouts.
                  metadata:
                    $ref: '#/components/schemas/Metadata'
                    properties:
                      collect_id:
                        type: string
                        description: Collection ID linked to this payout
                      transaction_hash:
                        type: string
                        description: Blockchain transaction hash (if applicable)
                  mt103:
                    type: string
                    description: SWIFT MT103 reference number, if applicable
                  object:
                    type: string
                    description: Type of object
                  on_behalf_of:
                    type: string
                    description: Entity on whose behalf the payout is made
                  payout_fx_transaction:
                    $ref: '#/components/schemas/FxTransaction'
                  purpose:
                    type: string
                    description: Purpose code or reason for the payout
                  reference_id:
                    type: string
                    description: External reference ID
                  source:
                    type: string
                    description: Source collection ID for the payout
                  statement_descriptor:
                    type: string
                    description: Statement descriptor shown on recipient’s statement
                  status:
                    type: string
                    description: Current status of the payout
                  status_description:
                    type: string
                    description: Additional 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: 'null'
                    description: Tracking details if available
                  transaction_description:
                    type: string
                    description: Description or purpose of the payout transaction
                  type:
                    type: string
                    description: Type of payout (e.g., local, swift)
components:
  schemas:
    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
    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

````