Payment Account Attributes Inquiry

Start a Project Start a Project API Overview API Overview

Download Payment Account Attributes Inquiry API Reference

Funds Transfer Attributes Inquiry API

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 like country, card-type, block status, etc.


Funds Transfer Inquiry
v5 - Latest
v1
v2
v5 - Latest

Retrieve the attributes, which determine the key characteristics of a recipient payment account before initiating a funds transfer, by providing the Primary Account Number (PAN) or Token for both Visa and Non-Visa cards

Request
Request Body schema: application/json

Request body for Funds Transfer Inquiry

primaryAccountNumber
required
string [ 13 .. 19 ] characters

The primary account number or Token for which account attributes are being requested

retrievalReferenceNumber
required
string 12 characters

A numeric value is required.

systemsTraceAuditNumber
required
string 6 characters

A numeric value is required.

accountType
string [ 5 .. 6 ] characters

This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

DEBIT
CREDIT

Processing codes for Debit account Type
10-Saving account
20-Checking account

Processing codes for Credit account Type
30-Credit card account

If accountType is not provided for Combo Card, then response will display

10 or 20 for Combo Card
30 for Combo Card

Enum: "DEBIT" "CREDIT"
acquirerCountryCode
string 3 characters

This is an optional field.
Use a 3-digit numeric country code for the country where the Funds Transfer solution is registered. This must match the information provided during program enrollment.

acquiringBin
integer

This is an optional field. The Bank Identification Number (BIN) under which your Funds Transfer application is registered. This must match the information provided during enrollment.

NOTE:
PAN check digit validation only occurs for mVisa BIN
If acquiring BIN is not passed in request there is no length/check digit validation even for mvisa

sharingGroupCode
string [ 1 .. 30 ] characters

This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code.
Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service.

Responses
200

Funds Transfer Inquiry Response

Response Schema: application/json
required
Array of objects

Conditional, should be present if PAN has non Visa Network associated

Array
aftDomParticipant
required
string

Pull Funds(AFT) Domestic Indicator.
Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service.

aftXbParticipant
required
string

Pull Funds(AFT) Cross Border Indicator.

billingCurrencyCode
required
integer

Use a 3-digit numeric currency code for the card billing currency of the PAN.
Refer to ISO Codes

billingCurrencyMinorDigits
required
integer

Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency.

cardIssuerCountryCode
required
integer

Refer to ISO Codes

networkId
required
integer

This contains a code that identifies the network.
Refer to Network Id

octDomParticipant
required
string

Push Funds(OCT) Domestic Indicator.
Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service.

octXbParticipant
required
string

Push Funds(OCT) Cross Border Indicator.

cardPlatformCode
string <= 2 characters

Indicates the type of card. This is a 2-character alphabetic code.
BZ - Business.
CN - Consumer.
CO - Commercial.
GV - Government.

cardTypeCode
string 1 characters

The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit.
Refer to cardTypeCode

gamingAndGambling
string 1 characters

Indicates whether OCTs online gaming or Gambling payout are allowed.

Y - Issuer is participating in gaming payments.
N - Issuer is not participating in gaming payments.

octFastFunds
string 1 characters

Indicates whether OCTs fast push funds are allowed.

Y - Fast Funds is supported for Domestic and cross-border.
D - Fast Funds is supported for Domestic only.
N - Fast Funds is not supported

required
Array of objects

Conditional, should be present if PAN has Visa Network associated

Array
billingCurrency
required
integer

3-digit numeric currency code for the card billing currency of the PAN.
Refer to ISO Codes

billingCurrencyCodeMinorDigits
required
string 1 characters

Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency.

cardPlatformCode
required
string [ 1 .. 2 ] characters

Indicates the type of card. This is a 2-character alphabetic code.
BZ - Business.
CN - Consumer.
CO - Commercial.
GV - Government.

cardProductType
required
string 1 characters

The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit.
Refer to cardProductType

comboCardRange
required
string 1 characters

Indicates the type of Combo card.
0 - Not a Combo card.
2 - Combo card.

issuerCountryCode
required
integer

Country code of the recipient issuer’s country.
Refer to ISO Country Codes (numeric)

issuerName
required
string <= 240 characters

Name of the recipient issuer.

moneyTransferFastFundsCrossBorder
required
string 1 characters

Indicates whether cross-border money transfer OCTs (fast push funds) are allowed.
Y - Cross-border money transfer Fast Fund OCTs are enabled.
N - Cross-border money transfer Fast Fund OCTs are not enabled.

moneyTransferFastFundsDomestic
required
string 1 characters

Indicates whether domestic money transfer OCTs (fast push funds) are allowed.
Y - Domestic money transfer Fast Fund OCTs are enabled.
N - Domestic money transfer Fast Fund OCTs are not enabled.

moneyTransferPushFundsCrossBorder
required
string 1 characters

Indicates whether cross-border money transfer OCTs (push funds) are allowed.
Y - Cross-border money transfer OCTs are allowed.
N - Cross-border money transfer OCTs are blocked.

moneyTransferPushFundsDomestic
required
string 1 characters

Indicates whether domestic money transfer OCTs (push funds) are allowed.
Y - Domestic money transfer OCTs are allowed.
N - Domestic money transfer OCTs are blocked.

nonMoneyTransferFastFundsCrossBorder
required
string 1 characters

Indicates whether cross-border non-money transfer OCTs (fast push funds) are allowed.
Y - Cross-border non-money transfer Fast Fund OCTs are enabled.
N - Cross-border non-money transfer Fast Fund OCTs are not enabled.

nonMoneyTransferFastFundsDomestic
required
string 1 characters

Indicates whether domestic non-money transfer OCTs (fast push funds) are allowed.
Y - Domestic non-money transfer Fast Fund OCTs are enabled.
N - Domestic non-money transfer Fast Fund OCTs are not enabled.

nonMoneyTransferPushFundsCrossBorder
required
string 1 characters

Indicates whether cross-border non-money transfer OCTs (push funds) are allowed.
Y - Cross-border non-money transfer OCTs are allowed.
N - Cross-border non-money transfer OCTs are blocked.

nonMoneyTransferPushFundsDomestic
required
string 1 characters

Indicates whether domestic non-money transfer OCTs (push funds) are allowed.
Y - Domestic non-money transfer OCTs are allowed.
N - Domestic non-money transfer OCTs are blocked.

onlineGamblingFastFundsCrossBorder
required
string 1 characters

Indicates whether cross-border gambling OCTs (fast push funds) are allowed.
Y - Cross-border gambling Fast Fund OCTs are enabled.
N - Cross-border gambling Fast Fund OCTs are not enabled.

onlineGamblingFastFundsDomestic
required
string 1 characters

Indicates whether domestic gambling OCTs (fast push funds) are allowed.
Y - Domestic gambling Fast Fund OCTs are enabled.
N - Domestic gambling Fast Fund OCTs are not enabled.

onlineGamblingPushFundsCrossBorder
required
string 1 characters

Indicates whether cross-border gambling OCTs (push funds) are allowed.
Y - Cross-border gambling OCTs are allowed.
N - Cross-border gambling OCTs are blocked.

onlineGamblingPushFundsDomestic
required
string 1 characters

Indicates whether domestic gambling OCTs (push funds) are allowed.
Y - Domestic gambling OCTs are allowed.
N - Domestic gambling OCTs are blocked.

accountCurrencyCode
integer

Indicates a currency code, use a 3-digit numeric currency code for the card billing currency of the PAN. Refer ISO Codes

accountType
string [ 2 .. 8 ] characters

This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

DEBIT
CREDIT

Processing codes for Debit account Type
10-Saving account
20-Checking account

Processing codes for Credit account Type
30-Credit card account

If accountType is not provided for Combo Card, then response will display

10 or 20 for Combo Card
30 for Combo Card

cardSubTypeCode
string 1 characters

This is an Optional Field. Indicates the type of prepaid card. This is a single-character alphabetic code.
R - Reloadable.
N - Non-reloadable.

geoRestrictionInd
string 1 characters

This field will determine if the recipient issuer can accept transactions from the Originator country.
Y - Transactions cannot be accepted from the sender country.
N - Transactions are allowed.

prepaidSubtypeCode
string 2 characters

Indicates the subtype code of prepaid product. This is a 2-character alphabetic code and below are the possible values.
GP = General Purpose
AC = Brazil Agriculture Maintenance Account/Custeio
AE = Brazil Agriculture Debit Account/Electron
AG = Brazil Agriculture
AI = Brazil Agriculture Investment Loan/Investimento
CG = Brazil Cargo
CS = Construction

DS = Distribution

EN = Large Market Enterprise
EX = Small Market Expenses

LP = Visa Large-Purchase Advantage (VLPA)
MA = mVISA Agent H
MB = mVisa Merchant Payment
MG = Visa Mobile General
MX = Merchant Agent
TK = Service Advantage
VA = Brazil Food or Supermarket/Alimentacao Visa Vale
VF = Brazil Fuel/Flex Visa Vale
VM = Meal Voucher
VN = Visa Vale Food Voucher
VR = Brazil Food or Restaurant/Refeicao Visa Vale

pullFundsCrossBorder
string 1 characters

Cross-border pull funds transfer eligibility. Below are the possible values,

Y
N

pullFundsDomestic
string 1 characters

Domestic pull funds transfer eligibility. Below are the possible values,

Y
N

pushFundsCrossBorderAuthApprovalInd
string [ 2 .. 16 ] characters

Indicates an auth approval rate for Cross border OCT of the issuer account range/BIN of the recipient card for the last three months. Below are the possible values.

READY
OPTIMIZED
NON-OPTIMIZED

400

Invalid request parameter

Response Schema: application/json
Schema not provided

© Copyright Visa. All Rights Reserved.

NOTICE: The software and accompanying information and documentation (together, the “Software”) remain the property of and are proprietary to Visa and its suppliers and affiliates. The Software remains protected by intellectual property rights and may be covered by U.S. and foreign patents or patent applications. The Software is licensed and not sold.

By accessing the Software you are agreeing to Visa's terms of use (developer.visa.com/terms) and privacy policy (usa.visa.com/legal/global-privacy-notice.html). In addition, all permissible uses of the Software must be in support of Visa products, programs and services provided through the Visa Developer Program (VDP) platform only (developer.visa.com). THE SOFTWARE AND ANY ASSOCIATED INFORMATION OR DOCUMENTATION IS PROVIDED ON AN “AS IS,” “AS AVAILABLE,” “WITH ALL FAULTS” BASIS WITHOUT WARRANTY OR CONDITION OF ANY KIND. YOUR USE IS AT YOUR OWN RISK.

post/paai/fundstransferattinq/v5/cardattributes/fundstransferinquiry

Sandbox server

https://sandbox.api.visa.com/paai/fundstransferattinq/v5/cardattributes/fundstransferinquiry
Request samples
application/json
FTAI Visa Card
FTAI Visa Card
FTAI Non-Visa Card
FTAI Invalid PAN
{
  • "systemsTraceAuditNumber": "451018",
  • "primaryAccountNumber": "4060320000000127",
  • "retrievalReferenceNumber": "412770452025"
}
Response samples
application/json
FTAI Visa Card
FTAI Visa Card
FTAI Non-Visa Card
{
  • "ppgsNetworkInfo": [
    ],
  • "visaNetworkInfo": [
    ]
}