# Payment Account Attributes Inquiry

## 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

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

| Field<br>Type<br>Description |
| --- | --- |
| retrievalReferenceNumber<br>required | string 12 characters <br>A numeric value is required. |
| systemsTraceAuditNumber<br>required | string 6 characters <br>A numeric value is required. |
| accountType | string 
| 5 .. 6 
| characters <br>This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values. <br>**DEBIT**<br>**CREDIT**<br>Processing codes for Debit account Type <br>10-Saving account<br>20-Checking account<br>Processing codes for Credit account Type<br>30-Credit card account<br>If accountType is not provided for Combo Card, then response will display<br>10 or 20 for Combo Card <br>30 for Combo Card<br>Enum:"DEBIT""CREDIT" |
| acquirerCountryCode | string 3 characters <br>This is an optional field. <br>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<br>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. |
| paymentCredentialReference | object<br>Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID<br>**Conditional**<br>Only one of 'primaryAccountNumber' and 'paymentCredentialReference' is provided in a request |
| type<br>required | string<br>Enum:"PCI_TOKEN_REFID""PHONE""EMAIL""DIRECTORY_ALIASID""PAYMENT_CREDENTIAL_ID" |
| value<br>required | string 
| 1 .. 128 
| characters

For "PCI_TOKEN_REFID", length is 1-75 and must accompany with "merchantId".

For "PAYMENT_CREDENTIAL_ID" length is 1-36 characters.

For "PHONE", "EMAIL", "DIRECTORY_ALIASID", length is 1-128 characters.

If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure.

| Country | Country Code | Examples |
| --- | --- | --- |
| United States | 1 | 1650xxxxxxx |
| Ukraine | 380 | 38067xxxxxxx |
| Belarus | 375 | 37529xxxxxxx |
| Kazakhstan | 7 | 7701xxxxxxx |
| United Kingdom | 44 | 4478xxxxxxxx |
| Singapore | 65 | 659xxxxxxx |
| Hong Kong | 852 | 8529xxxxxxx |
| Kenya | 254 | 254701xxxxxx |
| merchantId | string 
| 1 .. 50 
| characters <br>**Conditional**<br>Unique Merchant Identification assigned by Token Service Provider. |
| primaryAccountNumber | string 
| 13 .. 19 
| characters <br>The primary account number or Token for which account attributes are being requested |
| sharingGroupCode | string 
| 1 .. 30 
| characters <br>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. |

### Responses

**200**
Funds Transfer Inquiry Response

#### Response Schema: application/json

| Field | Type |
| --- | --- |
| ppgsNetworkInfo<br>required | Array of objects<br>Conditional, should be present if PAN has non Visa Network associated |
| aftDomParticipant<br>required | string<br>Pull Funds(AFT) Domestic Indicator.<br>**Note:**<br>Supported only in US for domestic transactions involving Push Payments Gateway Service. |
| aftXbParticipant<br>required | string<br>Pull Funds(AFT) Cross Border Indicator. |
| billingCurrencyCode<br>required | integer<br>Use a 3-digit numeric currency code for the card billing currency of the PAN. |
| billingCurrencyMinorDigits<br>required | integer<br>Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency. |
| cardIssuerCountryCode<br>required | integer<br>Refer to [ISO Codes](https://developer.visa.com/request_response_codes#iso_country_codes) |
| networkId<br>required | integer<br>This contains a code that identifies the network. |
| octDomParticipant<br>required | string<br>Push Funds(OCT) Domestic Indicator.<br>**Note:**<br>Supported only in US for domestic transactions involving Push Payments Gateway Service. |
| octXbParticipant<br>required | string<br>Push Funds(OCT) Cross Border Indicator. |
| cardPlatformCode | string <= 2 characters <br>Indicates the type of card. This is a 2-character alphabetic code. |
| cardTypeCode | string 1 characters <br>The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit. |
| gamingAndGambling | string 1 characters <br>Indicates whether OCTs online gaming or Gambling payout are allowed. <br>true - Issuer is participating in gaming payments. <br>false - Issuer is not participating in gaming payments. |
| octFastFunds | string 1 characters <br>Indicates whether OCTs fast push funds are allowed. |
| visaNetworkInfo<br>required | Array of objects<br>Conditional, should be present if PAN has Visa Network associated |
| billingCurrency<br>required | integer<br>3-digit numeric currency code for the card billing currency of the PAN. |
| billingCurrencyCodeMinorDigits<br>required | string 1 characters <br>Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency. |
| cardPlatformCode<br>required | string 
| 1 .. 2 
| characters <br>Indicates the type of card. This is a 2-character alphabetic code. |
| cardProductType<br>required | string 1 characters <br>The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit. |
| comboCardRange<br>required | string 1 characters <br>Indicates the type of Combo card.<br>0 - Not a Combo card.<br>2 - Combo card. |
| issuerCountryCode<br>required | integer<br>Country code of the recipient issuer’s country. |
| issuerName<br>required | string <= 240 characters <br>Name of the recipient issuer. |
| moneyTransferFastFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border money transfer OCTs (fast push funds) are allowed. |
| moneyTransferFastFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic money transfer OCTs (fast push funds) are allowed. |
| moneyTransferPushFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border money transfer OCTs (push funds) are allowed. |
| moneyTransferPushFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic money transfer OCTs (push funds) are allowed. |
| nonMoneyTransferFastFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border non-money transfer OCTs (fast push funds) are allowed. |
| nonMoneyTransferFastFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic non-money transfer OCTs (fast push funds) are allowed. |
| nonMoneyTransferPushFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border non-money transfer OCTs (push funds) are allowed. |
| nonMoneyTransferPushFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic non-money transfer OCTs (push funds) are allowed. |
| onlineGamblingFastFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border gambling OCTs (fast push funds) are allowed. |
| onlineGamblingFastFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic gambling OCTs (fast push funds) are allowed. |
| onlineGamblingPushFundsCrossBorder<br>required | string 1 characters <br>Indicates whether cross-border gambling OCTs (push funds) are allowed. |
| onlineGamblingPushFundsDomestic<br>required | string 1 characters <br>Indicates whether domestic gambling OCTs (push funds) are allowed. |
| accountCurrencyCode | integer<br>Indicates a currency code, use a 3-digit numeric currency code for the card billing currency of the PAN. |
| accountType | string 
| 2 .. 8 
| characters <br>This is used to identify the account type of the recipientPrimaryAccountNumber in the request. |
| cardSubTypeCode | string 1 characters <br>This is an Optional Field. Indicates the type of prepaid card. |
| geoRestrictionInd | string 1 characters <br>This field will determine if the recipient issuer can accept transactions from the Originator country. |
| prepaidSubtypeCode | string 2 characters <br>Indicates the subtype code of prepaid product. |
| pullFundsCrossBorder | string 1 characters <br>Cross-border pull funds transfer eligibility. |
| pullFundsDomestic | string 1 characters <br>Domestic pull funds transfer eligibility. |
| pushFundsCrossBorderAuthApprovalInd | string 
| 2 .. 16 
| characters <br>Indicates an auth approval rate for Cross border OCT of the issuer account range/BIN of the recipient card for the last three months. |

**400**
Invalid request parameter

### Response Schema: application/json

```json
{
    "systemsTraceAuditNumber": "451018",
    "primaryAccountNumber": "4060320000000127",
    "retrievalReferenceNumber": "412770452025"
}
```

### Response samples

- 200
- 400

```json
{
    "ppgsNetworkInfo": [{
        "billingCurrencyMinorDigits": 0,
        "octDomParticipant": "string",
        "octXbParticipant": "string",
        "aftXbParticipant": "string",
        "networkId": 0,
        "aftDomParticipant": "string",
        "cardIssuerCountryCode": 0,
        "billingCurrencyCode": 0
    },
    {
        "billingCurrencyMinorDigits": 0,
        "octDomParticipant": "string",
        "octXbParticipant": "string",
        "aftXbParticipant": "string",
        "networkId": 0,
        "aftDomParticipant": "string",
        "cardIssuerCountryCode": 0,
        "billingCurrencyCode": 0
    }],
    "visaNetworkInfo": [{
        "nonMoneyTransferFastFundsDomestic": "string",
        "moneyTransferPushFundsDomestic": "string",
        "nonMoneyTransferPushFundsDomestic": "string",
        "nonMoneyTransferPushFundsCrossBorder": "string",
        "issuerName": "string",
        "moneyTransferFastFundsDomestic": "string",
        "issuerCountryCode": 0,
        "comboCardRange": "string",
        "billingCurrencyCodeMinorDigits": "string",
        "onlineGamblingFastFundsDomestic": "string",
        "onlineGamblingPushFundsDomestic": "string",
        "onlineGamblingFastFundsCrossBorder": "string",
        "billingCurrency": 0,
        "moneyTransferFastFundsCrossBorder": "string",
        "cardPlatformCode": "string",
        "cardSubTypeCode": "string",
        "cardProductType": "string",
        "onlineGamblingPushFundsCrossBorder": "string",
        "moneyTransferPushFundsCrossBorder": "string",
        "nonMoneyTransferFastFundsCrossBorder": "string"
    }]
}
```