Payment Account Attributes Inquiry Documentation

Ready to start coding?

Things To Know

The General Attributes Inquiry and Funds Transfer Attributes Inquiry APIs are available to all developers in the sandbox and in production. Visa retains the right to review your project's implementation of these APIs before on-boarding to ensure that they are being used appropriately.

Availablility

The following table lists the regional availability for Payment Account Attributes Inquiry. To view availability of all products, refer to Availability Matrix.

Available in entire region

Limited availability in region

Not available

Product Name Availability Notes
Payment Account Attributes Inquiry
Product Name Availability Notes
Payment Account Attributes Inquiry
Product Name Availability Notes
Payment Account Attributes Inquiry
Product Name Availability Notes
Payment Account Attributes Inquiry
Product Name Availability Notes
Payment Account Attributes Inquiry

What's New - Release Notes

May 2017

A new version of the Funds Transfer Attribute Inquiry API (v2) has been recently launched to ensure that this API returns information about all the networks clearly. If the PAN provided in the request message matches multiple networks (Visa and/or other US Debit Networks), then the response provides the attributes corresponding to each network separately (in an array). Attributes for each network will be identified by the corresponding Network Id. Originators planning to use the Push Payment Gateway Service to connect to the other US Debit Networks can now use this API to get PAN attributes for each network separately. 

Getting Started

Payment Account Attributes Inquiry enables the caller to look up information about a payment account. Using Payment Account Attributes Inquiry, applications can access both general attributes of the account (such as card type and issuer information) and specific attributes that are needed to use a payment account as part of a funds transfer.

The Payment Account Attributes Inquiry service has two APIs that let you look up important attributes of a Visa account that you may need to know in order to successfully implement your project. The General Attributes Inquiry API provides basic information about a Visa account that is generally applicable to many different types of projects.

To use the General Attributes Inquiry API, you must provide a valid Visa primary account number (PAN) in the request message. In the response message, you will receive a response status for the request and the following attributes for the requested account:

  • Product ID Code and Product Name. This two-character code indicates the product type of the requested account. The Product ID uniquely defines a product within the Visa network for the purposes of driving processing, interchange qualification, billing, benefits, reporting, and other services. The Product ID represents a unique combination of brand (such as Visa, MasterCard, or American Express), platform (such as Consumer or Business), class (such as Basic, Premium, or Purchasing), and scheme within class (such as Gold, Infinite, or Platinum).
  • Product Sub-Type Code and Product Sub-Type Name. The two-character Product Sub-Type code offers an additional level of differentiation within the product type of the account, such as a gift versus general purpose usage.Card Type Code. This one-character code indicates whether the account is credit, debit, prepaid, deferred debit, or charge.
  • Card Sub-Type Code. For prepaid accounts, this one-character code is used to differentiate between reloadable and non-reloadable accounts.
  • Product Platform Code. This two-character code identifies the product platform to which the account belongs, such as consumer, commercial, business, or government.
  • Issuer Information. This includes the name, numeric ISO country code, and Bank Identification Number (BIN) of the issuer of the requested account.

The technical details can be found on the API Reference link. A complete listing of all of these code values and their names is in the Request and Response Code Reference.

How Does it Work?

Payment Account Attributes Inquiry includes two APIs: General Attributes Inquiry API and Funds Transfer Attributes Inquiry API. The two APIs take the primary account number (PAN) as input and return a variety of attributes associated with the payment account.

Why Use It?

Customized User Experience

The General Attributes Inquiry API provides a variety of attributes that can be used to provide a customized user experience.

Aid Funds Transfer Transactions

The Funds Transfer Attributes Inquiry API works in conjunction with the Visa Direct Funds Transfer API. It provides clients with key characteristics of recipient accounts that are needed to initiate a push-payment as well as apply the necessary compliance logic.

APIs Included

General Attributes Inquiry

The General Attributes Inquiry API provides easy access to an array of general payment account attributes, such as product ID, product name, card type, and issuer information.

Funds Transfer Attributes Inquiry

The Funds Transfer Attributes Inquiry API is often used with a funds transfer to/from a Visa payment account to determine key characteristics of a recipient card before initiating the transfer, such as country, card type, block status, etc.

Visa Direct

Transfer funds seamlessly, securely, and quickly

Using the Funds Transfer Attributes Inquiry API

The Funds Transfer Attributes Inquiry API provides information that clients and partners need to use to apply appropriate business rules and logic before initiating a push-payment transaction for projects that include person-to-person transfers, funds disbursements, prepaid loads, and credit card bill payments.

To use the Funds Transfer Inquiry API, you must provide a valid Visa primary account number (PAN) in the request message. In the response message, you will receive a response status for the request and the following attributes of the requested account:

  • Card Type Code. This one-character code indicates whether the account is credit, debit, prepaid, deferred debit, or charge. (This is the same Card Type Code field available through the General Attributes Inquiry API.)
  • Billing Currency Code and Minor Digits. This three-digit numeric ISO code is for the billing currency denomination of the account as defined within VisaNet and the number of decimal positions that should be displayed in any amounts denominated in that currency.
  • Issuer Name and Country Code. This is the name and numeric ISO country code of the issuer of the account. (This is the same Issuer Name and Country Code available through the General Attributes Inquiry API.)
  • Fast Funds Indicator. For use in push-payment transactions, this code indicates whether or not the issuer of the recipient account participates in the Fast Funds service for Original Credit Transactions (OCTs).
  • Push Payments Indicator. For use in push-payment transactions, this code indicates if the recipient account can receive push-payments (Original Credit Transactions).
  • Online Gambling Block Indicator. For use in push-payment transactions, this code indicates if the recipient account can receive push-payments for online gambling payouts.

The Funds Transfer Inquiry API can be used to query other U.S. debit networks as well. In order to use the API for this purpose, you must provide a valid Primary Account Number (PAN) in the request message. In the response message, you will receive a response status for the request and the following attributes of the requested account:

  • Destination Currency Code. This three-digit numeric ISO code is for the billing currency denomination of the account.
  • Number of Minor Units Used. This specifies the number of decimal positions that should be displayed in any amounts denominated in that currency.
  • Issuing Country Code. This is the numeric ISO country code of the issuer of the account.
  • OCT Domestic Participant. For use in push-payment transactions to non-Visa accounts, this flag indicates if the recipient account can receive domestic push-payments (Original Credit Transactions).
  • OCT Cross-Border Participant. For use in push-payment transactions to non-Visa accounts, this flag indicates if the recipient account can receive cross-border push-payments (Original Credit Transactions).
  • AFT Domestic Participant. For use in push-payment transactions to non-Visa accounts, this flag indicates if the recipient account can receive domestic pull-payments (Account Funding Transactions).
  • AFT Cross-Border Participant. For use in push-payment transactions to non-Visa accounts, this flag indicates if the recipient account can receive cross-border pull-payments (Account Funding Transactions).

The technical details can be found on the Documentation tab. A complete listing of all of these code values and their names is in the Request and Response Code Reference.

If you will be using the Funds Transfer Attributes Inquiry API in conjunction with calls to the Funds Transfer API, please populate the following fields in the request message (Acquiring BIN and Acquirer Country Code) with the corresponding values that you plan to use in your Funds Transfer API calls. If not, you can exclude all of those fields from your request.

Security and Authentication Requirements

The General Attributes Inquiry and Funds Transfer Attributes Inquiry APIs use mutual SSL authentication and channel encryption, which requires the caller to obtain a user ID and password as well as to install a PKI certificate issued by Visa. Test credentials can be obtained online in the Project Console for sandbox testing. Production credentials will be supplied to you as part of the production on-boarding process. (Contact developer@visa.com for more information or to begin the production on-boarding process.)