This feature is coming soon. The APIs listed here are for reference only
and are not yet available in production or sandbox.
curl --request GET \ --url 'https://service-sandbox.tazapay.com/v3/verification/payee/metadata?country=IN¤cy=INR' \ --header 'Authorization: Basic <encoded-value>'
{ "status" : "success" , "message" : "" , "data" : { "object" : "list" , "has_more" : false , "results" : [ { "country" : "IN" , "currency" : "INR" , "payout_type" : "local" , "destination_type" : "bank" , "coverage_percent" : 95 , "required_bank_fields" : [ "account_number" , "country" , "currency" ], "required_bank_codes" : [ "ifsc_code" ], "required_beneficiary_fields" : [ "name" , "type" ], "supported_verification_capabilities" : { "account_exists" : true , "name_check" : true , "match_score" : true , "match_type" : true , "corrected_name_returned" : false , "matched_name_translation" : false , "transaction_activity" : false } }, { "country" : "IN" , "currency" : "INR" , "payout_type" : "local_payment_network" , "destination_type" : "local_payment_network" , "local_payment_network" : { "type" : "upi_inr" , "deposit_key" : "example@upi" , "deposit_key_type" : "" }, "coverage_percent" : 95 , "required_bank_fields" : [], "required_bank_codes" : [], "required_beneficiary_fields" : [ "name" , "type" ], "supported_verification_capabilities" : { "account_exists" : true , "name_check" : true , "match_score" : true , "match_type" : true , "corrected_name_returned" : false , "matched_name_translation" : false , "transaction_activity" : false } }, { "country" : "IN" , "currency" : "INR" , "payout_type" : "swift" , "destination_type" : "bank" , "coverage_percent" : 60 , "required_bank_fields" : [ "account_number" , "country" , "currency" ], "required_bank_codes" : [ "swift_code" ], "required_beneficiary_fields" : [ "name" , "type" ], "supported_verification_capabilities" : { "account_exists" : true , "name_check" : true , "match_score" : true , "match_type" : true , "corrected_name_returned" : false , "matched_name_translation" : false , "transaction_activity" : false } } ] } }
Get Verification Metadata GET /v3/verification/payee/metadata
Use this endpoint before initiating a verification to check whether payee
verification is supported for a given corridor, and to retrieve the exact
fields required to run a verification.
Authorizations Basic authentication header of the form Basic <encoded-value>, where
<encoded-value> is the base64-encoded string username:password.
Query Parameters Destination country (ISO 3166-1 alpha-2, e.g. IN, US, GB).
Type of payout rail for which verification metadata is being requested.
Allowed: local, swift, local_payment_network.
Currency of the destination account (ISO 4217, e.g. INR, USD).
Required for currency-bound rails.
local_payment_network.type
Type of local payment network. Required if type = local_payment_network
(e.g. upi_inr, pix_brl, promptpay_thb).
Response Indicates whether the request to retrieve verification metadata was
successful.
Additional message providing context or status information about the
request.
Contains the verification capability details for the requested corridor
and rail. Indicates if more results exist beyond the current page.
List of verification method objects, each representing a supported
corridor. Destination country (ISO 3166-1 alpha-2).
Currency of the destination account (ISO 4217).
Type of payout rail for this corridor. Allowed: local, swift,
local_payment_network.
Present when payout_type = local_payment_network. Show local_payment_network
Type of local payment network (e.g. upi_inr, pix_brl,
promptpay_thb).
Deposit key for the network (e.g. UPI handle, PIX key).
Type of deposit key. Required for some networks (e.g. email,
cpf, phone for pix_brl).
Type of payout destination supported for verification. Allowed:
bank, local_payment_network.
Estimated coverage percentage for this corridor.
Bank fields required for verification (e.g. account_number,
iban, bank_name, branch_name, country, currency,
account_type). Applicable when destination_type = bank.
Bank routing codes required for verification (e.g. ifsc_code,
swift_code, aba_code, sort_code, branch_code, bsb_code,
bank_code, cnaps). Applicable when destination_type = bank.
required_beneficiary_fields
Beneficiary fields required to complete the verification (e.g.
name, type, phone, email, address, tax_id).
supported_verification_capabilities
Verification capabilities supported for this corridor and rail,
based on Tazapay’s providers. Show supported_verification_capabilities
Whether the provider can confirm if the account exists.
Whether the provider supports name matching against the
account holder.
Whether the provider returns a normalised confidence score
(0 to 1) for the name match.
Whether the provider classifies the match as strong, partial,
weak, or no match.
Whether the provider returns a corrected or suggested name
when a close but imperfect match is found.
Whether the provider returns a translation of the matched
name in local script.
Whether the provider can confirm recent transaction activity
on the account (Kinexys only).
