Payout

POST v3/payout

CodeMessageHTTP Status
20165Please provide either the beneficiary details or a beneficiary ID. One of these fields is mandatory for processing.422
20166Payout risk is not enabled to initiate payout403
20167Please provide a valid payout currency400
20168Please provide a valid holding currency400
20169Please provide a valid bank swift_code400
20170Payout creation failed: The bank transfer type is swift which is incompatible with the local payout type422
20171Please provide a valid purpose code to create payout400
20172The requested payout type does not match the beneficiary destination type422
20173The requested beneficiary is not associated with the account403
20174Please provide valid transaction source400
20175Payout invoice document is not found. Please provide valid invoice document400
20198Field on_behalf_of is required for creating this payout400
20199Please provide valid on_behalf_of should be valid xid type with prefix 'ent_'400
20200Entity doesn't match with tazapay compliance policy. Please contact us at [email protected]403
20201There is insufficient balance in your account to make the desired payout. Please ensure you have added sufficient funds to your account.422
20296Requested payout config is not supported please check the payout config400
20297Invalid or missing bank fields. Please provide a valid bank fields400
20298The specified transaction amount does not meet the required minimum or maximum limits.422
20300Field is required and must be either one of cpf/cnpj/email/phone/random400
20320Please provide the common bank fields to create a payout either through local or swift:%s400
20321Please provide all the valid bank local_fields to create a local payout:%s400
20322Please provide all the valid bank swift_fields to create a swift payout:%s400
20299Please provide a valid fx quote fx quote is expired or mismatch in from and to currency400
20110When the txn source is bfi funding interval should be configured please configure funding interval and try again later400

POST v3/metadata/payout/bank

Error CodeError MessageHTTP Status Code
1040Account Id is required. Please check whether id provided is in correct format. Example: acc_400
1091Invalid country provided in request.Please provide a valid alpha 2 country code.400
1092Invalid currency provided in request.Please provide a valid alpha 3 currency code.400
1093Invalid payout_type provided in request.Should be one of local or swift.Please provide a valid payout_type.400
1094Invalid entity_id provided in request.Should have 'ent_' as prefix followed by valid xid.Please provide a valid entity_id.400
1095Invalid source provided in request.Should be one of dashboard api or grpc.Please provide a valid source.400
1096Payout creation failed for provided country.Please contact [email protected] for more information.500
1097Payout methods not found for provided request data.Please contact [email protected] for more information.404
1098Invalid bank account number.Please check the account number and try again.404
1099Invalid or missing parameter. Please provide valid parameters.400
1086Field tax_id is required please provide a valid tax_id400
1049Document reference is invalid. Please provide valid document reference.400
1050Document type is missing. Please provide valid document type.400
1051Invalid URL format. Please make sure to provide a valid URL.400
1052Document name is missing. Please proivde valid document name.400
1053URL you have provided could not be reached404
1054URL you have provided does not have a downloadable document available404
1000country %s is not supported at this moment404
1011given currency %s is not supported404

POST v3/payout/:id/fund

CodeMessageHTTP Status
20290Field is required and must be a valid payout_id400
20291Field value must be either one of validate/confirm400
20201There is insufficient balance in your account to make the desired payout. Please ensure you have added sufficient funds to your account before retrying.422

POST v3/beneficiary

CodeMessageHTTP Status
20150Field is required please provide a valid name400
20151PLease provide a valid email address400
20152Please provide a valid type400
20153Please provide a valid beneficiary_details400
20154Please provide a valid bank_name400
20155Please provide a valid country. Must be alpha-2 country code. Ex: IN SG400
20156Please provide a valid currency400
20157Please provide a valid bank codes400
20158Please provide a valid payout_wallet deposit_address400
20159Bank payout functionality is currently disabled. Please contact support for assistance.403
20160Wallet payout functionality is currently disabled. Please contact support for assistance.403
20163Field is required please provide a valid tax_id400
20164Field 'url' is required and must be a valid url400
20270Invalid or missing account type. Please provide a valid account type. Accepted values are 'savings' 'checking' or 'payment'400
20320Please provide the common bank fields to create a payout either through local or swift:%s400
20321Please provide all the valid bank local_fields to create a local payout:%s400
20322Please provide all the valid bank swift_fields to create a swift payout:%s400
20325Invalid bank fields. Please provide a valid value for following fields:%s400
20361Please provide the missing required beneficiary fields:%s400

GET v3/payout/:id

CodeMessageHTTP Status
20197Field is required and must be a valid payout_id400
20180Payout might not exist or it is invalid please verify and try again404
20195You do not have permission to access this resource403

GET v3/beneficiary/:id

CodeMessageHTTP Status
20161Field is required and must be a valid beneficiary id. Example: bnf_xid400
20180Beneficiary might not exist or it is invalid please verify and try again404
20195You do not have permission to access this resource403

PUT v3/beneficiary/:id

CodeMessageHTTP Status
20161Field is required and must be a valid beneficiary id. Example: bnf_xid400
20323Please provide a valid transfer type for the selected beneficiary400
20324Please provide a valid existing beneficiary id400
20325Restricted field update attempt:%s422
20195You do not have permission to access this resource403