Payout
POST v3/payout
| Code | Message | HTTP Status |
|---|---|---|
| 20003 | Please provide a valid amount | 400 |
| 20028 | Please provide beneficiary name in Chinese | 400 |
| 20029 | Please provide valid beneficiary national identification number | 400 |
| 20030 | Field is required and must be valid logistic tracking details | 400 |
| 20035 | Transaction not allowed as the ultimate remitter and beneficiary are in the same region and is restricted. | 400 |
| 20036 | Account holder name is required and cannot be empty | 400 |
| 20037 | When the txn source is bfi, funding interval should be configured please configure funding interval and try again later | 400 |
| 20038 | Both holding_fx_quote and destination_fx_quote cannot be provided | 400 |
| 20039 | The amount locked in fx quote is not the same as the amount in request | 400 |
| 20040 | this purpose code is not supported for the Remitter and Beneficiary type combination | 400 |
| 20041 | Invalid source for providing destination_info | 400 |
| 20042 | EURC currency is not supported | 400 |
| 20043 | Mismatch detected: The provided destination currency does not align with our system records | 400 |
| 20044 | Non-fiat currency is not supported or invalid | 400 |
| 20045 | Business-to-business payouts are not permitted for Pakistan. Please select an eligible remitter or beneficiary type. | 400 |
| 20061 | Field is required and must be valid ISO 4217 alpha-3 currency code | 400 |
| 20067 | Holding currency not found for the specified account. | 400 |
| 20152 | Please provide a valid type | 400 |
| 20165 | Please provide either the beneficiary details or a beneficiary ID. One of these fields is mandatory for processing. | 400 |
| 20166 | Payout risk is not enabled to initiate payout | 400 |
| 20167 | Please provide a valid payout currency | 400 |
| 20168 | Please provide a valid holding currency | 400 |
| 20170 | Payout creation failed: The bank transfer type is swift, which is incompatible with the local payout type | 400 |
| 20171 | Please provide a valid purpose code to create payout | 400 |
| 20172 | The requested payout type does not match the beneficiary destination type | 400 |
| 20173 | The requested beneficiary is not associated with the account | 400 |
| 20174 | Please provide valid transaction source | 400 |
| 20175 | Payout invoice document is not found. Please provide valid invoice document | 400 |
| 20196 | Field on_behalf_of is required for creating this payout | 400 |
| 20197 | Please provide valid on_behalf_of, should be valid xid type with prefix ent_ | 400 |
| 20198 | Entity doesn’t match with tazapay compliance policy. Please contact us at ops@tazapay.com | 400 |
| 20199 | There is insufficient balance in your account to make the desired payout. Please ensure you have added sufficient funds to your account before retrying. | 400 |
| 20201 | Payout failed: No available provider for the data provided. The following fields are required by our network for this destination: %s | 400 |
| 20231 | Field is required and must be a valid document type. | 400 |
| 20283 | Provided document is not sufficient to create payout | 400 |
| 20296 | Requested payout config is not supported, please check the payout config | 400 |
| 20298 | The specified transaction amount does not meet the required minimum or maximum limits. | 400 |
| 20299 | Please provide a valid quote, payout or fx quote is expired or mismatch in from and to currency | 400 |
| 20380 | Mismatch detected: The provided beneficiary registration number does not align with our system records | 400 |
| 20381 | Mismatch detected: The provided beneficiary business name does not align with our system records | 400 |
| 20382 | Mismatch detected: The provided beneficiary business address country does not align with our system records | 400 |
| 20383 | Beneficiary date of birth is required and can’t be empty when beneficiary type is individual | 400 |
| 20384 | Third Party Wallet payout functionality is currently disabled. Please contact support for assistance. | 400 |
| 20385 | Beneficiary registration number is required and can’t be empty | 400 |
| 20386 | Beneficiary address details are required and can’t be empty | 400 |
| 20387 | Beneficiary party classification is required, please pass valid party classification | 400 |
| 20388 | Mismatch detected: The provided individual name does not align with our system records | 400 |
| 20389 | Individual business must be a sole proprietorship | 400 |
| 20400 | Mismatch detected: The provided date of birth does not align with our system records | 400 |
| 20401 | VASP name is required for wallet beneficiary | 400 |
| 20403 | This wallet beneficiary is not yet approved, please get your beneficiary approved before creating a payout | 400 |
| 20426 | Field is required and must be a valid payout_quote_id | 400 |
| 20427 | Payout Quote cannot be validated if either holding_fx_quote or destination_fx_quote is present | 400 |
| 20428 | Payout quote mismatch with Create Payout request | 400 |
| 20434 | Please provide a valid payout quote, payout quote is expired | 400 |
| 20437 | Please provide a valid destination_fx_quote starting with ‘fx_‘ | 400 |
| 20438 | Please provide a valid quote starting with ‘poq_‘ | 400 |
| 20643 | Please provide a valid holding_fx_quote starting with ‘fx_‘ | 400 |
POST v3/metadata/payout/bank
| Code | Message | HTTP Status |
|---|---|---|
| 1040 | Account Id is required. Please check whether id provided is in correct format. Example: acc_ | 400 |
| 1091 | Invalid country provided in request. Please provide a valid alpha 2 country code. | 400 |
| 1092 | Invalid currency provided in request. Please provide a valid alpha 3 currency code. | 400 |
| 1093 | Invalid payout_type provided in request. Should be one of local or swift. Please provide a valid payout_type. | 400 |
| 1094 | Invalid entity_id provided in request. Should have ‘ent_’ as prefix followed by valid xid. Please provide a valid entity_id. | 400 |
| 1095 | Invalid source provided in request. Should be one of dashboard api or grpc. Please provide a valid source. | 400 |
| 1096 | Payout creation failed for provided country. Please contact support@tazapay.com for more information. | 500 |
| 1097 | Payout methods not found for provided request data. Please contact support@tazapay.com for more information. | 404 |
| 1098 | Invalid bank account number. Please check the account number and try again. | 404 |
| 1099 | Invalid or missing parameter. Please provide valid parameters. | 400 |
| 1086 | Field tax_id is required please provide a valid tax_id | 400 |
| 1049 | Document reference is invalid. Please provide valid document reference. | 400 |
| 1050 | Document type is missing. Please provide valid document type. | 400 |
| 1051 | Invalid URL format. Please make sure to provide a valid URL. | 400 |
| 1052 | Document name is missing. Please provide valid document name. | 400 |
| 1053 | URL you have provided could not be reached | 404 |
| 1054 | URL you have provided does not have a downloadable document available | 404 |
| 1000 | country %s is not supported at this moment | 404 |
| 1011 | given currency %s is not supported | 404 |
| 1100 | Invalid fund_transfer_network provided. The specified fund transfer network is not supported for this country and currency combination. | 400 |
POST v3/payout/{id}/fund
| Code | Message | HTTP Status |
|---|---|---|
| 20290 | Field is required and must be a valid payout_id | 400 |
| 20291 | Field value must be either one of validate/confirm | 400 |
| 20182 | Payout status cannot be changed for the current status | 400 |
| 20193 | You do not have permission to access this resource | 403 |
| 20199 | There is insufficient balance in your account to make the desired payout. Please ensure you have added sufficient funds to your account before retrying. | 400 |
POST v3/payout/{id}/confirm
| Code | Message | HTTP Status |
|---|---|---|
| 20195 | Field is required and must be a valid payout_id | 400 |
| 20390 | Field cannot be empty, must be a valid transaction hash | 400 |
| 20391 | Field cannot be empty, must be valid xid type with prefix ‘col_‘ | 400 |
| 20392 | Transaction hash already used for other payment, please try again with different transaction hash. | 400 |
| 20393 | Payout status is invalid to perform this action, payout has moved to higher status. | 409 |
| 20394 | The collect created is already linked to a payout. Please try with different collect id or transaction hash. | 400 |
| 20395 | The transaction hash provided is not valid or mismatched with collect id. Please try with different transaction hash. | 400 |
| 20396 | The balance impact or the currency of the collect does not match with the payout. Please try with different transaction hash or collect id. | 400 |
| 20397 | The account ID of the payout does not match the account ID of the collect. Please ensure both transactions belong to the same account. | 401 |
| 20398 | Collect status is invalid to perform this action | 400 |
| 20399 | Payout status is invalid to perform this action, payout was not funded within the time limit and has failed. | 409 |
| 20631 | Holding currency of payout and collect do not match | 400 |
POST v3/beneficiary
| Code | Message | HTTP Status |
|---|---|---|
| 20150 | Field is required, please provide a valid name | 400 |
| 20151 | Please provide a valid email address | 400 |
| 20152 | Please provide a valid type | 400 |
| 20153 | Please provide a valid beneficiary_details | 400 |
| 20154 | Please provide a valid bank_name | 400 |
| 20155 | Please provide a valid country. Must be alpha-2 country code. Ex: IN, SG | 400 |
| 20156 | Please provide a valid currency | 400 |
| 20157 | Please provide a valid bank codes | 400 |
| 20158 | Please provide a valid payout_wallet deposit_address | 400 |
| 20159 | Bank payout functionality is currently disabled. Please contact support for assistance. | 400 |
| 20160 | Wallet payout functionality is currently disabled. Please contact support for assistance. | 400 |
| 20320 | Please provide the common bank fields to create a payout either through local or swift: %s | 400 |
| 20321 | Please provide all the valid bank local_fields to create a local payout: %s | 400 |
| 20322 | Please provide all the valid bank swift_fields to create a swift payout: %s | 400 |
| 20326 | Invalid bank fields. Please provide a valid value for following fields: %s | 400 |
| 20361 | Please provide the missing required beneficiary fields: %s | 400 |
GET v3/payout/{id}
| Code | Message | HTTP Status |
|---|---|---|
| 20195 | Field is required and must be a valid payout_id | 400 |
| 20180 | Payout might not exist or it is invalid, please verify and try again | 404 |
| 20193 | You do not have permission to access this resource | 403 |
GET v3/beneficiary/{id}
| Code | Message | HTTP Status |
|---|---|---|
| 20161 | Field is required and must be a valid beneficiary id. Example: bnf_xid | 400 |
| 20180 | Beneficiary might not exist or it is invalid, please verify and try again | 404 |
| 20193 | You do not have permission to access this resource | 403 |
PUT v3/beneficiary/{id}
| Code | Message | HTTP Status |
|---|---|---|
| 20161 | Field is required and must be a valid beneficiary id. Example: bnf_xid | 400 |
| 20323 | Please provide a valid existing beneficiary id | 400 |
| 20324 | Field is required, please provide a valid tax_id | 400 |
| 20325 | Restricted field update attempt: %s | 400 |
| 20193 | You do not have permission to access this resource | 403 |