--- title: "Fetch payout" method: GET path: "/v3/payout/{id}" --- # Fetch payout `GET /v3/payout/{id}` This lets you fetch the details of an existing payout ## Path parameters - `id` string, required ## Response `200` 200 - object - `status` string — Status of API request - `message` string — Message returned as part of the API response - `data` PayoutData — Contains detailed information about a payout object. - `amount` integer — Amount of the payout. - `available_balance` integer — Available balance in the holding currency account after this payout is processed. - `balance_transaction` string — Balance transaction ID associated with this payout. - `beneficiary` string — Beneficiary identifier. - `beneficiary_details` BeneficiaryDetails — Comprehensive beneficiary information including personal details and destination - `name` string, required — Name of the beneficiary - `email` string — Email address of the beneficiary - `type` 'business' | 'individual', required — Type of beneficiary entity - `address` Address — Address details - `line1` string — Address Line 1 - `line2` string — Address Line 2 - `city` string — Address city - `state` string — Address state - `country` string — Address country (ISO 3166-1 alpha-2 country code) - `postal_code` string — Postal Code - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `destination_details` DestinationDetails — Destination details for beneficiary payouts (discriminated union based on type) - `type` 'bank' | 'wallet' | 'local_payment_network' | 'tazapay_account', required — Type of destination - `bank` Bank — Bank account details - `account_number` string — Bank Account Number. Either account_number or IBAN is mandatory - `iban` string — IBAN. Either account_number or iban is mandatory - `bank_name` string — Name of the bank - `branch_name` string — Name of the branch - `country` string — Two-letter country code (ISO 3166-1 alpha-2) - `currency` string — Three-letter ISO currency code, in uppercase - `purpose_code` string — Purpose Code for INR bank accounts - `bank_codes` BankCodes — Bank specific identification codes - `swift_code` string — SWIFT Code - `bic_code` string — Bank Identifier Code (BIC) - `ifsc_code` string — IFS Code - `aba_code` string — ABA / Routing Number - `sort_code` string — SORT Code - `branch_code` string — Branch Code - `bsb_code` string — BSB Code - `bank_code` string — Bank Code - `cnaps` string — CNAPS - `firc_required` boolean — Pass true if you want FIRC for a payout to India - `account_type` 'savings' | 'checking' | 'payment' — Type of bank account - `account_holder_name` string — Name of the account holder - `transfer_type` string — Type of transfer (e.g., local, SWIFT) - `wallet` Wallet — Crypto wallet destination details - `deposit_address` string, required — Blockchain wallet address - `type` 'ethereum' | 'tron' | 'polygon' | 'solana' | 'bitcoin_lightning_network', required — Type of blockchain wallet (e.g., ethereum, bitcoin_lightning_network). Use `bitcoin_lightning_network` for BTC currency only. - `currency` string, required — Cryptocurrency code (e.g., USDC, BTC, ETH) - `hosted` 'yes' | 'no' — Whether wallet is hosted/custodial - `vasp_name` string — Virtual Asset Service Provider name (required for hosted wallets) - `vasp_website` string — VASP website URL (required for hosted wallets) - `local_payment_network` LocalPaymentNetwork — Local payment network destination details (e.g., PIX, UPI, PromptPay) - `type` string, required — Type of local payment network (e.g., pix_brl, upi_inr, promptpay_thb) - `deposit_key_type` string — Type of the deposit key (conditionally mandatory depending on network type) - `deposit_key` string, required — Deposit key for the local payment network (e.g., PIX key, UPI handle) - `currency` string — Currency code for the local payment network - `tazapay_account` TazapayAccount — Tazapay account destination details - `deposit_address` string, required — Tazapay account deposit address (format - xxxxx@tzp) - `tax_id` string — Tax ID of the beneficiary (e.g., CPF or CNPJ for Brazil) - `national_identification_number` string — National ID of the individual - `registration_number` string — Registration number of the business - `date_of_birth` string — Date of birth of individual (format DD-MM-YYYY) - `nationality` string — Nationality (ISO 3166-1 alpha-2 country code) - `destination` string — Destination identifier - `documents` unknown[] — Array of supporting documents - unknown - `name_local` string — Local name of the beneficiary - `party_classification` string — Party classification - `status` string — Status of the beneficiary - `charge_type` 'ours' | 'shared' — Charge type of payout. - `confirmation_documents` object[] — List of documents confirming payout. - `key` string - `type` string - `value` string - `created_at` string — Timestamp when payout was created. - `currency` string — Currency of the payout. - `documents` unknown[] — Documents associated with payout. - unknown - `holding_currency` string — Currency held for payout. - `holding_fx_quote` string — Holding FX quote ID. - `holding_fx_transaction` FxTransaction — Details of an FX conversion transaction - `exchange_rate` number — FX exchange rate applied - `final` object — Final amount and currency after FX conversion - `amount` number — Final amount after FX conversion - `currency` string — Currency of the final amount - `id` string — FX transaction ID - `initial` object — Initial amount and currency before FX conversion - `amount` number — Initial amount before FX conversion - `currency` string — Currency of the initial amount - `object` string — Object type (fx_transaction) - `id` string — Unique payout identifier. - `is_balance_sufficient` boolean — Indicates whether the account has sufficient balance to process this payout. - `local` object — Local payout configuration. - `fund_transfer_network` string — Local fund transfer network used. - `logistics_tracking_details` object[] — Logistics tracking details. Mandatory for CNY local payouts. - `tracking_number` string - `logistics_provider` object - `name` string - `code` string - `metadata` Metadata, nullable — Custom metadata key-value pairs attached to the object - `mt103` string — SWIFT MT103 details if available. - `object` string — Type of object (payout). - `on_behalf_of` string — Entity on whose behalf the payout is made. - `payout_fx_transaction` FxTransaction — Details of an FX conversion transaction - `exchange_rate` number — FX exchange rate applied - `final` object — Final amount and currency after FX conversion - `amount` number — Final amount after FX conversion - `currency` string — Currency of the final amount - `id` string — FX transaction ID - `initial` object — Initial amount and currency before FX conversion - `amount` number — Initial amount before FX conversion - `currency` string — Currency of the initial amount - `object` string — Object type (fx_transaction) - `payout_quote` string — Payout quote reference. - `purpose` string — Purpose code for the payout. - `quote` string — Quote ID from the payout quote API. - `reference_id` string — External reference ID for payout. - `reversal_balance_transaction` string — Id of the reverse balance transaction linked to this payout. Only present when status is 'reversed'. - `reversal_payout_fx_transaction` FxTransaction — Details of an FX conversion transaction - `exchange_rate` number — FX exchange rate applied - `final` object — Final amount and currency after FX conversion - `amount` number — Final amount after FX conversion - `currency` string — Currency of the final amount - `id` string — FX transaction ID - `initial` object — Initial amount and currency before FX conversion - `amount` number — Initial amount before FX conversion - `currency` string — Currency of the initial amount - `object` string — Object type (fx_transaction) - `statement_descriptor` string — Statement descriptor for the payout. - `status` string — Current status of the payout. - `status_description` string — Detailed status description. - `failure` object, nullable — Failure details of the payout. Only present when the payout has failed. - `code` string — Error code indicating the reason for the payout failure. Refer to the failure code list [**here**](/API-Reference/appendix/payout-failure-reasons-updated). - `description` string — Human-readable description of the failure reason. - `tracking_details` object — Tracking details of payout. - `tracking_number` string — Tracking number (UETR, UTR, transaction hash, etc.) - `tracking_type` 'uetr' | 'utr' | 'transaction_hash' — Tracking type used for payout. - `transaction_description` string — Description or memo for the payout transaction. - `items` PayoutItem[] — List of invoice line items for the payout - `name` string, required — Name of the goods item. Maximum 512 characters. - `quantity` integer, required — Number of units. Must be at least 1. - `amount` integer, required — Unit price of the item in minor units of the payout currency (e.g., 10000 = CNY 100.00). Must be greater than 0. - `category` 'Goods', required — Category of the item. Currently only "Goods" is accepted. - `description` string — Optional free-text description of the item. Maximum 512 characters. - `type` 'swift' | 'local' | 'wallet' | 'local_payment_network' | 'tazapay_account' — Type of payout. ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/tazapay/apis/sandbox.md) · [All operations](https://skmtc.net/tazapay/apis/sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tazapay/sandbox/versions/bf5f4b8f6f5d/schema)