Visa Subscription Manager API Reference

Visa Subscription Manager

\ Start a Project](https://developer.visa.com/portal/#users/new) \ API Overview](https://developer.visa.com/capabilities/visa-subscription-manager)

Search API Reference

Download Visa Subscription Manager API Reference

Card-On-File Data Service API

Card-On-File Data API allows to enable digital control capabilities in Issuer’s online mobile application or web application to provide visibility to the consumers where their card (PAN)/token credentials are stored to initiate Card-On-File Data API/e-commerce transactions and where the credentials are updated in case of a card reissuance or token status updates

Card-on-File Merchant Aggregation v1 - Latest

The API will return data layer aggregated at cleansed merchant name level.

Request

Request Body schema: application/json

Card-On-File Data request query for merchants
requestData
required		 object
Request body for querying Card-on-file merchant.
--- ---
group
required		 stringSTANDARD
Identifies the set of response fields the customer is eligible to receive. If the group name is "STANDARD", all available response fields are included.
Value:"STANDARD"
Example: "STANDARD"
pANs
required		 Array of strings 1 items
List of PANs for requesting merchant data. The PAN has a format of 12–19 decimal digits starting with a "4" (indicating Visa accounts).
Example: ["4000123456789010"]
requestHeader
required		 object
Fields contained in the header of each request.
--- ---
messageDateTime
required		 string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time at which request is sent (up to milliseconds in UTC).
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-09-19 06:01:00.601"
requestMessageId
required		 string [ 0 .. 50 ] characters ^[\w-._]+$
A string that uniquely identifying the service request. The requesting application creates this unique message ID.
Example: "6da60e1b8b024532a2e0eacb1af5858132a2e0eacb1af58581"

Responses

200 Successful

Response Schema: application/json
responseHeader
required		 object
Fields contained in the header of each response.
--- ---
messageDateTime
required		 string^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9...Show pattern
Date and time at which response is sent (up to milliseconds in UTC).
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-09-19 06:01:00.601"
numRecordsReturned
required		 integer [ 0 .. 2147483647 ]
Number of successful PAN records returned.
Example: 3
requestMessageId
required		 string [ 0 .. 50 ] characters ^$|^[\w-._]+$
A string that uniquely identifies the service request. Response will contain the same message ID as received from requesting application.
Example: "6da60e1b8b024532a2e0eacb1af5858132a2e0eacb1af58581"
responseMessageId
required		 string [ 0 .. 50 ] characters
Correlation id which uniquely identifies the current request-response processing
Example: "1561737829_569_743208831_l55c014_VDP_WS"
status
required		 object
Status details, which include the application status code and corresponding message.
--- ---
statusCode
required		 string 6 characters
Status Code of the Service Request.
Example: "CDI000"
statusDescription
required		 string
A string description of the statusCode element. A brief description indicating the result of the service request.
Example: "COF Service - Success"
responseData object
Response data, which includes merchant information for the requested PANs.
--- ---
group
required		 string [ 0 .. 100 ] characters STANDARD
Identifies the set of response fields the customer is eligible to receive.
Value:"STANDARD"
Example: "STANDARD"
panList
required		 Array of objects 1 items
An array of response objects for each PAN.
Array\
\
--- ---
panData object
Response Object for a single PAN
--- ---
pAN
required		 string
The request account number (PAN value).
Example: "4000123456789010"
panResponseMsg
required		 string [ 0 .. 128 ] characters
Indicates whether data retrieval for a given PAN was successful; field contains either "Success" or the reason for the error if data retrieval was not successful.
Example: "Success"
merchants Array of objects
List of merchants who have Card-On-File Data for the requested PAN.
Array\
\
--- ---
acctNumOld4Digit
required		 string^$|^[0-9]{4}$
Last 4 digits of the old account number in Visa Account Updater (VAU).
Note: This field may return an empty string.
Example: "1234"
cardAcceptorId
required		 string [ 0 .. 15 ] characters
Card Acceptor ID (CAID) of the merchant. The value reflects the most recent CAID included in the last transaction.
Note: This field may return an empty string.
Example: "235251000762203"
confidenceInd
required		 string^$|^[CEM]$
Confidence indicator.
C - Highly likely a COF merchant
M - May be a COF merchant
E - Not a COF merchant
Example: "C"
lastMrchTranDt
required		 string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when the last transaction was made with the merchant in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18"
lastTranAmt
required		 string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34"
mCC
required		 string^$|^\d{4}$
Merchant Category Code.
Note: This field may return an empty string.
Example: "5942"
mrchAddr
required		 string [ 0 .. 255 ] characters
Merchant address.
Note: This field may return an empty string.
Example: "111 Any St AnyCity 90000 AnyState USA"
mrchDbaId
required		 string [ 0 .. 6 ] characters
"Doing Business As" (DBA) ID of the merchant. Use mrchName instead; this field may become deprecated.
Note: This field may return an empty string.
Example: "148"
mrchDbaName
required		 string [ 0 .. 40 ] characters
Merchant "Doing Business As" name. Use mrchName instead; this field may become deprecated.
Example: "ANYMERCHANT"
mrchName
required		 string [ 0 .. 255 ] characters
Cleansed Merchant Name.
Example: "ABC"
mrchPhoneNum
required		 string [ 0 .. 40 ] characters
Merchant phone number.
Note: This field may return an empty string.
Example: "5551212"
mrchRef
required		 string^[A-Za-z0-9-_=]{1,512}$
Correlation ID to uniquely identify the merchant. The reference ID is not static and may change.
Example: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTpBTUFaT04="
mrchURL
required		 string [ 0 .. 255 ] characters
Merchant URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com"
tokenPANReplacementDate
required		 string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
tokenPANReplacementStatus update date in UTC time zone.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18"
tokenPANReplacementStatus
required		 string^$|^Y{1}$|^N{1}$
Status of whether the token’s underlying PAN has been updated, based on issuer updates sent to Visa.
Y - PAN was updated.
N - PAN was not updated.
Note: This field may return an empty string.
Example: "N"
tokenReqstrId
required		 string [ 0 .. 11 ] characters
The token requestor ID of the merchant or payment facilitator, if any, assigned by Visa Token Service.
Note: This field may return an empty string.
Example: "00000000"
totalTranCount
required		 string [ 0 .. 19 ] characters
Total transaction count for all transaction type.
Example: "3"
vAULastUpdateDate
required		 string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when merchant last polled Visa Account Updater (VAU) for new PAN data in UTC time zone.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18"
vAUUpdateStatus
required		 string^(Y|N|NA)?$
Visa Account Updater (VAU) polling status.
Y - PAN update was polled by the merchant.
N - No PAN update was polled by the merchant.
NA - Issuer has not reissued a PAN nor updated expiry date.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Example: "Y"
lastTranAmtBillCurrency string [ 0 .. 24 ] characters
Last transaction amount in billing currency; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34"
lastTranAmtUSD string [ 0 .. 24 ] characters
Last transaction amount in USD; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "25.68"
lastTranBillCurrency string [ 0 .. 3 ] characters
Billing currency of last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD"
lastTranCurrency string [ 0 .. 3 ] characters
Currency used in last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD"
lastTranDateTime string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-10-05 09:45:17.000"
mrchLogoURL string [ 0 .. 255 ] characters
Merchant Logo URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com/logo"
paymentFacilitatorId string [ 0 .. 15 ] characters
Payment Facilitator ID.
Example: "10071854"
sponsoredMerchantId string [ 0 .. 20 ] characters
Sponsored Merchant ID.
Example: "7494990"
tranTypeDetails Array of objects
List of transaction details by transaction type. Each transaction type can appear once and only if there’s an associated transaction.
Array\
\
--- ---
lastTranAmt
required		 string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction for the type.
Example: "22.72"
tranCount
required		 integer >= 0
Transaction count for the type.
Example: 10
tranType
required		 string
The transaction type code.
Value:"SCHEDULED_RECURRING, UNSCHEDULED_RECURRING, INSTALLMENT, MERCHANT_COF, CUSTOMER_COF, UNKNOWN_COF, MAIL_TELEPHONE, BILL_PAY, ECOM_OTHER, AUTH_VERIFICATION"
Example: "MERCHANT_COF"
lastTranAmtBillCurrency string [ 0 .. 24 ] characters
Last transaction amount in billing currency.
Example: "22.72"
lastTranAmtUSD string [ 0 .. 24 ] characters
Last transaction amount in USD.
Example: "15.22"
lastTranBillCurrency string [ 0 .. 3 ] characters
Billing currency of last transaction.
Format: ISO 4217 standard
Example: "AUD"
lastTranCurrency string [ 0 .. 3 ] characters
Currency used in last transaction for the type.
Format: ISO 4217 standard
Example: "AUD"
lastTranDateTime string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp for the type in UTC time zone.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2021-07-11 07:05:04.000"
\
400\
Invalid request\
\
Response Schema: application/json\


| | |
| --- | --- |
| responseHeader
required | object
Fields contained in the header of each response. |
| | | |
| --- | --- |
| messageDateTime
required | string^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9...Show pattern
Date and time at which response is sent (up to milliseconds in UTC).
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-09-19 06:01:00.601" |
| numRecordsReturned
required | integer [ 0 .. 2147483647 ]
Number of successful PAN records returned.
Example: 3 |
| requestMessageId
required | string [ 0 .. 50 ] characters ^$|^[\w-._]+$
A string that uniquely identifies the service request. Response will contain the same message ID as received from requesting application.
Example: "6da60e1b8b024532a2e0eacb1af5858132a2e0eacb1af58581" |
| responseMessageId
required | string [ 0 .. 50 ] characters
Correlation id which uniquely identifies the current request-response processing
Example: "1561737829_569_743208831_l55c014_VDP_WS" | |
| status
required | object
Status details, which include the application status code and corresponding message. |
| | | |
| --- | --- |
| statusCode
required | string 6 characters
Status Code of the Service Request.
Example: "CDI000" |
| statusDescription
required | string
A string description of the statusCode element. A brief description indicating the result of the service request.
Example: "COF Service - Success" | |
| responseData | object
Response data, which includes merchant information for the requested PANs. |
| | | |
| --- | --- |
| group
required | string [ 0 .. 100 ] characters STANDARD
Identifies the set of response fields the customer is eligible to receive.
Value:"STANDARD"
Example: "STANDARD" |
| panList
required | Array of objects 1 items
An array of response objects for each PAN. |
| Array

| | |
| --- | --- |
| panData | object
Response Object for a single PAN |
| | | |
| --- | --- |
| pAN
required | string
The request account number (PAN value).
Example: "4000123456789010" |
| panResponseMsg
required | string [ 0 .. 128 ] characters
Indicates whether data retrieval for a given PAN was successful; field contains either "Success" or the reason for the error if data retrieval was not successful.
Example: "Success" |
| merchants | Array of objects
List of merchants who have Card-On-File Data for the requested PAN. |
| Array

| | |
| --- | --- |
| acctNumOld4Digit
required | string^$|^[0-9]{4}$
Last 4 digits of the old account number in Visa Account Updater (VAU).
Note: This field may return an empty string.
Example: "1234" |
| cardAcceptorId
required | string [ 0 .. 15 ] characters
Card Acceptor ID (CAID) of the merchant. The value reflects the most recent CAID included in the last transaction.
Note: This field may return an empty string.
Example: "235251000762203" |
| confidenceInd
required | string^$|^[CEM]$
Confidence indicator.
C - Highly likely a COF merchant
M - May be a COF merchant
E - Not a COF merchant
Example: "C" |
| lastMrchTranDt
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when the last transaction was made with the merchant in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| mCC
required | string^$|^\d{4}$
Merchant Category Code.
Note: This field may return an empty string.
Example: "5942" |
| mrchAddr
required | string [ 0 .. 255 ] characters
Merchant address.
Note: This field may return an empty string.
Example: "111 Any St AnyCity 90000 AnyState USA" |
| mrchDbaId
required | string [ 0 .. 6 ] characters
"Doing Business As" (DBA) ID of the merchant. Use mrchName instead; this field may become deprecated.
Note: This field may return an empty string.
Example: "148" |
| mrchDbaName
required | string [ 0 .. 40 ] characters
Merchant "Doing Business As" name. Use mrchName instead; this field may become deprecated.
Example: "ANYMERCHANT" |
| mrchName
required | string [ 0 .. 255 ] characters
Cleansed Merchant Name.
Example: "ABC" |
| mrchPhoneNum
required | string [ 0 .. 40 ] characters
Merchant phone number.
Note: This field may return an empty string.
Example: "5551212" |
| mrchRef
required | string^[A-Za-z0-9-_=]{1,512}$
Correlation ID to uniquely identify the merchant. The reference ID is not static and may change.
Example: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTpBTUFaT04=" |
| mrchURL
required | string [ 0 .. 255 ] characters
Merchant URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com" |
| tokenPANReplacementDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
tokenPANReplacementStatus update date in UTC time zone.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| tokenPANReplacementStatus
required | string^$|^Y{1}$|^N{1}$
Status of whether the token’s underlying PAN has been updated, based on issuer updates sent to Visa.
Y - PAN was updated.
N - PAN was not updated.
Note: This field may return an empty string.
Example: "N" |
| tokenReqstrId
required | string [ 0 .. 11 ] characters
The token requestor ID of the merchant or payment facilitator, if any, assigned by Visa Token Service.
Note: This field may return an empty string.
Example: "00000000" |
| totalTranCount
required | string [ 0 .. 19 ] characters
Total transaction count for all transaction type.
Example: "3" |
| vAULastUpdateDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when merchant last polled Visa Account Updater (VAU) for new PAN data in UTC time zone.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| vAUUpdateStatus
required | string^(Y|N|NA)?$
Visa Account Updater (VAU) polling status.
Y - PAN update was polled by the merchant.
N - No PAN update was polled by the merchant.
NA - Issuer has not reissued a PAN nor updated expiry date.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Example: "Y" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "25.68" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-10-05 09:45:17.000" |
| mrchLogoURL | string [ 0 .. 255 ] characters
Merchant Logo URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com/logo" |
| paymentFacilitatorId | string [ 0 .. 15 ] characters
Payment Facilitator ID.
Example: "10071854" |
| sponsoredMerchantId | string [ 0 .. 20 ] characters
Sponsored Merchant ID.
Example: "7494990" |
| tranTypeDetails | Array of objects
List of transaction details by transaction type. Each transaction type can appear once and only if there’s an associated transaction. |
| Array

| | |
| --- | --- |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction for the type.
Example: "22.72" |
| tranCount
required | integer >= 0
Transaction count for the type.
Example: 10 |
| tranType
required | string
The transaction type code.
Value:"SCHEDULED_RECURRING, UNSCHEDULED_RECURRING, INSTALLMENT, MERCHANT_COF, CUSTOMER_COF, UNKNOWN_COF, MAIL_TELEPHONE, BILL_PAY, ECOM_OTHER, AUTH_VERIFICATION"
Example: "MERCHANT_COF" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency.
Example: "22.72" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD.
Example: "15.22" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction for the type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp for the type in UTC time zone.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2021-07-11 07:05:04.000" | | | | | |

401
Unauthorized request
\

Response Schema: application/json\


| | |
| --- | --- |
| responseHeader
required | object
Fields contained in the header of each response. |
| | | |
| --- | --- |
| messageDateTime
required | string^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9...Show pattern
Date and time at which response is sent (up to milliseconds in UTC).
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-09-19 06:01:00.601" |
| numRecordsReturned
required | integer [ 0 .. 2147483647 ]
Number of successful PAN records returned.
Example: 3 |
| requestMessageId
required | string [ 0 .. 50 ] characters ^$|^[\w-._]+$
A string that uniquely identifies the service request. Response will contain the same message ID as received from requesting application.
Example: "6da60e1b8b024532a2e0eacb1af5858132a2e0eacb1af58581" |
| responseMessageId
required | string [ 0 .. 50 ] characters
Correlation id which uniquely identifies the current request-response processing
Example: "1561737829_569_743208831_l55c014_VDP_WS" | |
| status
required | object
Status details, which include the application status code and corresponding message. |
| | | |
| --- | --- |
| statusCode
required | string 6 characters
Status Code of the Service Request.
Example: "CDI000" |
| statusDescription
required | string
A string description of the statusCode element. A brief description indicating the result of the service request.
Example: "COF Service - Success" | |
| responseData | object
Response data, which includes merchant information for the requested PANs. |
| | | |
| --- | --- |
| group
required | string [ 0 .. 100 ] characters STANDARD
Identifies the set of response fields the customer is eligible to receive.
Value:"STANDARD"
Example: "STANDARD" |
| panList
required | Array of objects 1 items
An array of response objects for each PAN. |
| Array

| | |
| --- | --- |
| panData | object
Response Object for a single PAN |
| | | |
| --- | --- |
| pAN
required | string
The request account number (PAN value).
Example: "4000123456789010" |
| panResponseMsg
required | string [ 0 .. 128 ] characters
Indicates whether data retrieval for a given PAN was successful; field contains either "Success" or the reason for the error if data retrieval was not successful.
Example: "Success" |
| merchants | Array of objects
List of merchants who have Card-On-File Data for the requested PAN. |
| Array

| | |
| --- | --- |
| acctNumOld4Digit
required | string^$|^[0-9]{4}$
Last 4 digits of the old account number in Visa Account Updater (VAU).
Note: This field may return an empty string.
Example: "1234" |
| cardAcceptorId
required | string [ 0 .. 15 ] characters
Card Acceptor ID (CAID) of the merchant. The value reflects the most recent CAID included in the last transaction.
Note: This field may return an empty string.
Example: "235251000762203" |
| confidenceInd
required | string^$|^[CEM]$
Confidence indicator.
C - Highly likely a COF merchant
M - May be a COF merchant
E - Not a COF merchant
Example: "C" |
| lastMrchTranDt
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when the last transaction was made with the merchant in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| mCC
required | string^$|^\d{4}$
Merchant Category Code.
Note: This field may return an empty string.
Example: "5942" |
| mrchAddr
required | string [ 0 .. 255 ] characters
Merchant address.
Note: This field may return an empty string.
Example: "111 Any St AnyCity 90000 AnyState USA" |
| mrchDbaId
required | string [ 0 .. 6 ] characters
"Doing Business As" (DBA) ID of the merchant. Use mrchName instead; this field may become deprecated.
Note: This field may return an empty string.
Example: "148" |
| mrchDbaName
required | string [ 0 .. 40 ] characters
Merchant "Doing Business As" name. Use mrchName instead; this field may become deprecated.
Example: "ANYMERCHANT" |
| mrchName
required | string [ 0 .. 255 ] characters
Cleansed Merchant Name.
Example: "ABC" |
| mrchPhoneNum
required | string [ 0 .. 40 ] characters
Merchant phone number.
Note: This field may return an empty string.
Example: "5551212" |
| mrchRef
required | string^[A-Za-z0-9-_=]{1,512}$
Correlation ID to uniquely identify the merchant. The reference ID is not static and may change.
Example: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTpBTUFaT04=" |
| mrchURL
required | string [ 0 .. 255 ] characters
Merchant URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com" |
| tokenPANReplacementDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
tokenPANReplacementStatus update date in UTC time zone.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| tokenPANReplacementStatus
required | string^$|^Y{1}$|^N{1}$
Status of whether the token’s underlying PAN has been updated, based on issuer updates sent to Visa.
Y - PAN was updated.
N - PAN was not updated.
Note: This field may return an empty string.
Example: "N" |
| tokenReqstrId
required | string [ 0 .. 11 ] characters
The token requestor ID of the merchant or payment facilitator, if any, assigned by Visa Token Service.
Note: This field may return an empty string.
Example: "00000000" |
| totalTranCount
required | string [ 0 .. 19 ] characters
Total transaction count for all transaction type.
Example: "3" |
| vAULastUpdateDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when merchant last polled Visa Account Updater (VAU) for new PAN data in UTC time zone.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| vAUUpdateStatus
required | string^(Y|N|NA)?$
Visa Account Updater (VAU) polling status.
Y - PAN update was polled by the merchant.
N - No PAN update was polled by the merchant.
NA - Issuer has not reissued a PAN nor updated expiry date.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Example: "Y" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "25.68" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-10-05 09:45:17.000" |
| mrchLogoURL | string [ 0 .. 255 ] characters
Merchant Logo URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com/logo" |
| paymentFacilitatorId | string [ 0 .. 15 ] characters
Payment Facilitator ID.
Example: "10071854" |
| sponsoredMerchantId | string [ 0 .. 20 ] characters
Sponsored Merchant ID.
Example: "7494990" |
| tranTypeDetails | Array of objects
List of transaction details by transaction type. Each transaction type can appear once and only if there’s an associated transaction. |
| Array

| | |
| --- | --- |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction for the type.
Example: "22.72" |
| tranCount
required | integer >= 0
Transaction count for the type.
Example: 10 |
| tranType
required | string
The transaction type code.
Value:"SCHEDULED_RECURRING, UNSCHEDULED_RECURRING, INSTALLMENT, MERCHANT_COF, CUSTOMER_COF, UNKNOWN_COF, MAIL_TELEPHONE, BILL_PAY, ECOM_OTHER, AUTH_VERIFICATION"
Example: "MERCHANT_COF" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency.
Example: "22.72" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD.
Example: "15.22" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction for the type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp for the type in UTC time zone.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2021-07-11 07:05:04.000" | | | | | |

500
Internal service failure
\

Response Schema: application/json\


| | |
| --- | --- |
| responseHeader
required | object
Fields contained in the header of each response. |
| | | |
| --- | --- |
| messageDateTime
required | string^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9...Show pattern
Date and time at which response is sent (up to milliseconds in UTC).
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-09-19 06:01:00.601" |
| numRecordsReturned
required | integer [ 0 .. 2147483647 ]
Number of successful PAN records returned.
Example: 3 |
| requestMessageId
required | string [ 0 .. 50 ] characters ^$|^[\w-._]+$
A string that uniquely identifies the service request. Response will contain the same message ID as received from requesting application.
Example: "6da60e1b8b024532a2e0eacb1af5858132a2e0eacb1af58581" |
| responseMessageId
required | string [ 0 .. 50 ] characters
Correlation id which uniquely identifies the current request-response processing
Example: "1561737829_569_743208831_l55c014_VDP_WS" | |
| status
required | object
Status details, which include the application status code and corresponding message. |
| | | |
| --- | --- |
| statusCode
required | string 6 characters
Status Code of the Service Request.
Example: "CDI000" |
| statusDescription
required | string
A string description of the statusCode element. A brief description indicating the result of the service request.
Example: "COF Service - Success" | |
| responseData | object
Response data, which includes merchant information for the requested PANs. |
| | | |
| --- | --- |
| group
required | string [ 0 .. 100 ] characters STANDARD
Identifies the set of response fields the customer is eligible to receive.
Value:"STANDARD"
Example: "STANDARD" |
| panList
required | Array of objects 1 items
An array of response objects for each PAN. |
| Array

| | |
| --- | --- |
| panData | object
Response Object for a single PAN |
| | | |
| --- | --- |
| pAN
required | string
The request account number (PAN value).
Example: "4000123456789010" |
| panResponseMsg
required | string [ 0 .. 128 ] characters
Indicates whether data retrieval for a given PAN was successful; field contains either "Success" or the reason for the error if data retrieval was not successful.
Example: "Success" |
| merchants | Array of objects
List of merchants who have Card-On-File Data for the requested PAN. |
| Array

| | |
| --- | --- |
| acctNumOld4Digit
required | string^$|^[0-9]{4}$
Last 4 digits of the old account number in Visa Account Updater (VAU).
Note: This field may return an empty string.
Example: "1234" |
| cardAcceptorId
required | string [ 0 .. 15 ] characters
Card Acceptor ID (CAID) of the merchant. The value reflects the most recent CAID included in the last transaction.
Note: This field may return an empty string.
Example: "235251000762203" |
| confidenceInd
required | string^$|^[CEM]$
Confidence indicator.
C - Highly likely a COF merchant
M - May be a COF merchant
E - Not a COF merchant
Example: "C" |
| lastMrchTranDt
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when the last transaction was made with the merchant in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| mCC
required | string^$|^\d{4}$
Merchant Category Code.
Note: This field may return an empty string.
Example: "5942" |
| mrchAddr
required | string [ 0 .. 255 ] characters
Merchant address.
Note: This field may return an empty string.
Example: "111 Any St AnyCity 90000 AnyState USA" |
| mrchDbaId
required | string [ 0 .. 6 ] characters
"Doing Business As" (DBA) ID of the merchant. Use mrchName instead; this field may become deprecated.
Note: This field may return an empty string.
Example: "148" |
| mrchDbaName
required | string [ 0 .. 40 ] characters
Merchant "Doing Business As" name. Use mrchName instead; this field may become deprecated.
Example: "ANYMERCHANT" |
| mrchName
required | string [ 0 .. 255 ] characters
Cleansed Merchant Name.
Example: "ABC" |
| mrchPhoneNum
required | string [ 0 .. 40 ] characters
Merchant phone number.
Note: This field may return an empty string.
Example: "5551212" |
| mrchRef
required | string^[A-Za-z0-9-_=]{1,512}$
Correlation ID to uniquely identify the merchant. The reference ID is not static and may change.
Example: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTpBTUFaT04=" |
| mrchURL
required | string [ 0 .. 255 ] characters
Merchant URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com" |
| tokenPANReplacementDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
tokenPANReplacementStatus update date in UTC time zone.
Note: This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| tokenPANReplacementStatus
required | string^$|^Y{1}$|^N{1}$
Status of whether the token’s underlying PAN has been updated, based on issuer updates sent to Visa.
Y - PAN was updated.
N - PAN was not updated.
Note: This field may return an empty string.
Example: "N" |
| tokenReqstrId
required | string [ 0 .. 11 ] characters
The token requestor ID of the merchant or payment facilitator, if any, assigned by Visa Token Service.
Note: This field may return an empty string.
Example: "00000000" |
| totalTranCount
required | string [ 0 .. 19 ] characters
Total transaction count for all transaction type.
Example: "3" |
| vAULastUpdateDate
required | string^$|^((19|2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[...Show pattern
Date when merchant last polled Visa Account Updater (VAU) for new PAN data in UTC time zone.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Format: yyyy-MM-dd
Example: "2018-07-18" |
| vAUUpdateStatus
required | string^(Y|N|NA)?$
Visa Account Updater (VAU) polling status.
Y - PAN update was polled by the merchant.
N - No PAN update was polled by the merchant.
NA - Issuer has not reissued a PAN nor updated expiry date.
Note:
Issuers must be subscribed to VAU to provide updates. Merchants must be subscribed to VAU in order to receive updates.
This field may return an empty string.
Example: "Y" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "22.34" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD; not applicable for “AUTH_VERIFICATION” transaction type.
Example: "25.68" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction; not applicable for “AUTH_VERIFICATION” transaction type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp in UTC time zone; not applicable for “AUTH_VERIFICATION” transaction type.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2018-10-05 09:45:17.000" |
| mrchLogoURL | string [ 0 .. 255 ] characters
Merchant Logo URL.
Note: This field may return an empty string.
Example: "www.anymerchant.com/logo" |
| paymentFacilitatorId | string [ 0 .. 15 ] characters
Payment Facilitator ID.
Example: "10071854" |
| sponsoredMerchantId | string [ 0 .. 20 ] characters
Sponsored Merchant ID.
Example: "7494990" |
| tranTypeDetails | Array of objects
List of transaction details by transaction type. Each transaction type can appear once and only if there’s an associated transaction. |
| Array

| | |
| --- | --- |
| lastTranAmt
required | string [ 0 .. 24 ] characters
Last transaction amount in currency used in transaction for the type.
Example: "22.72" |
| tranCount
required | integer >= 0
Transaction count for the type.
Example: 10 |
| tranType
required | string
The transaction type code.
Value:"SCHEDULED_RECURRING, UNSCHEDULED_RECURRING, INSTALLMENT, MERCHANT_COF, CUSTOMER_COF, UNKNOWN_COF, MAIL_TELEPHONE, BILL_PAY, ECOM_OTHER, AUTH_VERIFICATION"
Example: "MERCHANT_COF" |
| lastTranAmtBillCurrency | string [ 0 .. 24 ] characters
Last transaction amount in billing currency.
Example: "22.72" |
| lastTranAmtUSD | string [ 0 .. 24 ] characters
Last transaction amount in USD.
Example: "15.22" |
| lastTranBillCurrency | string [ 0 .. 3 ] characters
Billing currency of last transaction.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranCurrency | string [ 0 .. 3 ] characters
Currency used in last transaction for the type.
Format: ISO 4217 standard
Example: "AUD" |
| lastTranDateTime | string^([0-9]{4})-([0-1][0-9])-([0-3][0-9])\s([0-1]...Show pattern
Date and time of last transaction timestamp for the type in UTC time zone.
Format: yyyy-MM-dd HH:mm:ss.SSS (ISO 8601 standard)
Example: "2021-07-11 07:05:04.000" | | | | | |

© 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/cofds-web/v1/datainfo

Try it

Sandbox server

https://sandbox.api.visa.com/cofds-web/v1/datainfo\
Copy

Request samples
\