> ## 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. # Fetch payout > This lets you fetch the details of an existing payout ## OpenAPI ````yaml get /v3/payout/{id} openapi: 3.1.0 info: title: sandbox version: '3' servers: - url: https://service-sandbox.tazapay.com security: - sec0: [] paths: /v3/payout/{id}: get: summary: Fetch payout description: This lets you fetch the details of an existing payout operationId: fetch-payout parameters: - name: id in: path description: ID of the existing payout schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Transfer with Tazapay: summary: Transfer with Tazapay value: status: success message: '' data: amount: 44000 balance_transaction: btr_d35sqe74qcl8im850 beneficiary: bnf_d35spsnl8imrh3gv0 beneficiary_details: address: {} date_of_birth: '' destination: '' destination_details: tazapay_account: deposit_address: ce4f51ue@tzp type: tazapay_account documents: [] email: info@trading.com name: T Co., Limited name_local: '' national_identification_number: '' party_classification: '' phone: {} registration_number: '' status: active tax_id: '' type: business charge_type: '' confirmation_documents: [] created_at: '2025-09-18T09:13:28.633167Z' currency: USD documents: [] holding_currency: USD holding_fx_quote: fx_d35sfigo4p2dsvsvg holding_fx_transaction: exchange_rate: 1 final: amount: 44000 currency: USD id: fx_d35sqe7figo4p2dsvsvg initial: amount: 44000 currency: USD object: fx_transaction id: pot_d5sqe7cl8imrh4810 local: fund_transfer_network: ach logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 44000 currency: USD id: fx_d35sqe7figo4psvt00 initial: amount: 44000 currency: USD object: fx_transaction purpose: PYR003 quote: poq_d5sqe7cl8imrh4811 reference_id: TZP-ACC-2024-1892 statement_descriptor: Trading Payment status: succeeded status_description: '' failure: null tracking_details: tracking_number: TZP-001-2024-9876 tracking_type: internal transaction_description: Payment for goods acc 001 type: tazapay_account Swift Bank Payout: value: status: success message: '' data: amount: 100000 balance_transaction: btr_d35pv4qcl8imrv60 beneficiary: bnf_d3inm6ami8u10oqfg beneficiary_details: address: country: CN line1: Zhen Rui Yun Lu 66 postal_code: '311011' date_of_birth: '' destination: '' destination_details: bank: account_number: '33050167624000001030' account_type: '' bank_codes: swift_code: PCBCCNBJZJX bank_name: CHINA CONSTRUCTION BANK, ZHEJIANG BRANCH branch_name: '' country: CN currency: USD firc_required: false purpose_code: '' transfer_type: swift type: bank documents: [] email: '' name: IMPORT AND EXPORT CO., LTD name_local: '' national_identification_number: '' party_classification: '' phone: calling_code: '86' registration_number: '' tax_id: '' type: business charge_type: ours confirmation_documents: - key: mt103 type: string value: >- {1:F01SCBLSG22AXXX0000000000}{2:I103SCBLUS33XXXXN}{3:{198:ST10302504172331}{111:001}{121:80 cb81fc-a590-4d6d-8f7e-b8b67f49h0b9}}{4: :20:ST10502504172331 :23B:CRED :32A:250417USD4930000,00 :33B:USD4930000,00 :50K:/0005751COCAEUR0001 FAC MONEY TRANSFER LIMITED 624a Romford Road, Manor Park /UNITED KINGDOM :52D:/0105552976 TAZAPAY PTE. LTD. 7 TEMASEK BOULEVARD,20-06 SUNTEC TO WER ONE,SINGAPORE,ZIP 038987 /SINGAPORE :57A:CITIUS33XXX :59:/10961809 AGRANI BANK PLC US /UNITED STATES :70:FAC Money Transfer Limited Money Remittance Fund :71A:OUR :72:/ACC/CITIUS33XXX/CITIBANK N.A./-} created_at: '2025-09-18T10:07:35.101708Z' currency: USD documents: [] holding_currency: USD holding_fx_quote: fx_d35tjpnfigp2dt2hgg holding_fx_transaction: exchange_rate: 1 final: amount: 10000000 currency: USD id: fx_d35tjpnfigp2dt2hgg initial: amount: 10000000 currency: USD object: fx_transaction id: pot_d35tjpn4qcl8iv30 logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 10000000 currency: USD id: fx_d35tfigo4p2dt2hh0 initial: amount: 10000000 currency: USD object: fx_transaction purpose: PYR003 reference_id: '' statement_descriptor: '' status: succeeded status_description: '' failure: null tracking_details: tracking_number: 7833d-34b4-478-aac8-1184beae tracking_type: uetr transaction_description: Payment for goods acc 125 type: swift summary: Swift Bank Payout Local Bank Payout: summary: Local Bank Payout value: status: success message: '' data: 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.832790Z' 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 Local Payment Network Payout: summary: Local Payment Network Payout value: status: success message: '' data: amount: 144 balance_transaction: btr_d35v6ddendp1ul1p0 beneficiary: bnf_d2pkuchg06m8tvjg beneficiary_details: address: null date_of_birth: '' destination: '' destination_details: local_payment_network: currency: BRL deposit_key: fep@gmail.com type: pix_brl type: local_payment_network documents: [] email: fep@gmail.com name: Feete Pereira name_local: '' national_identification_number: '' party_classification: '' phone: null registration_number: '' tax_id: '3879876743' type: individual charge_type: '' confirmation_documents: [] created_at: '2025-09-18T11:56:35.627500Z' currency: BRL documents: [] holding_currency: USD holding_fx_quote: fx_d35vfigo4p2dt8ecg holding_fx_transaction: exchange_rate: 5.158393 final: amount: 144 currency: BRL id: fx_d35vfigo4p2dt8ecg initial: amount: 28 currency: USD object: fx_transaction id: pot_d35v6sp8dp1ul1m0 local: fund_transfer_network: pix logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 144 currency: BRL id: fx_d35v6go4p2dt8ec0 initial: amount: 144 currency: BRL object: fx_transaction purpose: PYR001 reference_id: BR-PIX-2024-3879 statement_descriptor: Freelancer Payment status: succeeded status_description: '' failure: null tracking_details: tracking_number: E1234567820240918115635627 tracking_type: pix_id transaction_description: Freelance design services payment type: local_payment_network Crypto Payout: summary: Crypto Payout value: status: success message: '' data: amount: 122225 balance_transaction: btr_dag4eup1ekl94qrlg beneficiary: bnf_d35eag4eupl94qrig beneficiary_details: address: city: Vrtmore country: JM line1: it12 3cwth postal_code: '00000' state: Vortmore date_of_birth: '2003-04-04' destination: '' destination_details: type: wallet wallet: currency: USDC deposit_address: 09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8 type: ethereum documents: [] email: '' name: Scott name_local: '' national_identification_number: '' party_classification: third_party phone: {} registration_number: '' tax_id: '' type: individual charge_type: '' confirmation_documents: [] created_at: '2025-09-17T16:43:44.378053Z' currency: USD documents: [] holding_currency: USD holding_fx_quote: fx_d35eag74p2drbeug holding_fx_transaction: exchange_rate: 1 final: amount: 122225 currency: USD id: fx_d35eag74p2drbeug initial: amount: 122225 currency: USD object: fx_transaction id: pot_d35eag4ekl94qri0 local: fund_transfer_network: ethereum logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 122225 currency: USDC id: fx_d35igo4p2drbeu0 initial: amount: 122225 currency: USD object: fx_transaction purpose: PYR030 reference_id: '' statement_descriptor: '' status: succeeded status_description: '' failure: null tracking_details: tracking_number: >- 0xadef30173d3dd42333779a683c1404e50567e03fb4daef4f850f415789f559f tracking_type: transaction_hash transaction_description: commision type: wallet Reversed Payout: summary: Reversed Payout value: status: success message: '' data: amount: 9400 balance_transaction: btr_d66p4jdv8bk93hfrpqvg beneficiary: bnf_d66p36tv8bk93hfrpq40 beneficiary_details: address: city: chennai country: SG line1: line1 line2: test postal_code: '34567' state: test date_of_birth: '' destination: '' destination_details: bank: account_number: '123456789012' account_type: '' bank_codes: swift_code: DBSSSGSGXXX bank_name: Example Bank Ltd branch_name: '' country: SG currency: SGD firc_required: false purpose_code: '' transfer_type: any type: bank documents: [] email: '' is_doc_verification_required: false name: SGD name_local: '' national_identification_number: '' nationality: '' party_classification: '' phone: null registration_number: '' status: active tax_id: '' type: business verification_status: succeeded charge_type: '' confirmation_documents: [] created_at: '2026-02-12T08:41:49.433474Z' currency: SGD destination_fx_quote: fx_d66p4jc2rt3in2223tog documents: [] holding_currency: SGD holding_fx_quote: fx_d66p4jc2rt3in2223to0 holding_fx_transaction: exchange_rate: 1 final: amount: 9400 currency: SGD id: fx_d66p4jc2rt3in2223to0 initial: amount: 9400 currency: SGD object: fx_transaction id: pot_d66p4jdv8bk93hfrpqs0 local: fund_transfer_network: fast logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 1 final: amount: 9400 currency: SGD id: fx_d66p4jc2rt3in2223tog initial: amount: 9400 currency: SGD object: fx_transaction purpose: PYR001 quote: '' reference_id: '' reversal_balance_transaction: btr_d66qoo5v8bk93hfrqr40 reversal_holding_fx_transaction: exchange_rate: 1 final: amount: 9400 currency: SGD id: fx_d66qoo42rt3in2223vng initial: amount: 9400 currency: SGD object: fx_transaction reversal_payout_fx_transaction: exchange_rate: 1 final: amount: 9400 currency: SGD id: fx_d66qoo42rt3in2223vn0 initial: amount: 9400 currency: SGD object: fx_transaction statement_descriptor: '' status: reversed status_description: PR1001 failure: null tracking_details: tracking_number: '' tracking_type: '' transaction_description: 100.35 SGD will be deducted from your balance type: local Failed Payout: summary: Failed Payout value: status: success message: '' data: amount: 500000 balance_transaction: btr_d36abcqcl8imrv70 beneficiary: bnf_d36abc6ami8u10oqfg beneficiary_details: address: country: IN line1: 42 MG Road postal_code: '560001' date_of_birth: '' destination: '' destination_details: bank: account_number: '9876543210' account_type: '' bank_codes: swift_code: INVALIDINAK bank_name: STATE BANK OF INDIA branch_name: '' country: IN currency: INR firc_required: false purpose_code: '' transfer_type: swift type: bank documents: [] email: '' name: ACME EXPORTS PVT LTD name_local: '' national_identification_number: '' party_classification: '' phone: calling_code: '91' registration_number: '' tax_id: '' type: business charge_type: ours confirmation_documents: [] created_at: '2025-09-20T06:30:00.000000Z' currency: INR documents: [] holding_currency: USD holding_fx_quote: fx_d36abcfigp2dt2hgg holding_fx_transaction: exchange_rate: 83.94 final: amount: 500000 currency: INR id: fx_d36abcfigp2dt2hgg initial: amount: 5956 currency: USD object: fx_transaction id: pot_d36abcn4qcl8iv40 local: fund_transfer_network: swift logistics_tracking_details: [] metadata: null mt103: '' object: payout on_behalf_of: '' payout_fx_transaction: exchange_rate: 83.94 final: amount: 500000 currency: INR id: fx_d36abcgo4p2dt2hh0 initial: amount: 5956 currency: USD object: fx_transaction purpose: PYR003 reference_id: IN-EXP-2025-0042 statement_descriptor: Export payment status: failed status_description: PO1012 failure: code: PF020101 description: Bank identification code is missing/invalid tracking_details: null transaction_description: Payment for export goods type: swift 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: $ref: '#/components/schemas/PayoutData' '400': description: Bad Request content: application/json: examples: Result: value: status: error message: Resource not found errors: - code: 105 message: >- The resource you are trying to retrieve is not present. This error code happens when trying to Get or Read a data point (eg: transaction, user, KYB, etc) that does not exist. remarks: '' 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 ````