Visa Account Updater API Reference
Visa Account Updater
Issuer Stop Advice API
Issuers can place stop advices in VAU to block specific merchants from receiving an automatic VAU credential update (e.g., following reported fraud) while still allowing their cardholder to transact with the merchant where appropriately authorized.
Issuer Stop Advice API v1 - Latest
Issuer can place stop advice by providing following requested information
Request
header Parameters
| Accept | string Value:"application/json" |
Request Body schema: application/json
| issuerSegmentId required |
integer [This field must contain a valid VAU issuer segment id] Example: 2 |
| stopadvices required |
Array of objects [List of stop advice] |
| Array |
| cardAcceptorId required |
string [This field must contain card acceptor id.] Example: "89389898" |
| cardholderAccountNumber required |
string [This field must contain the account number (Visa, Mastercard, American Express, or Discover).] Example: "400000XX00000000" |
| merchantName required |
string [This field must contain merchant name.] Example: "TestMerchant" |
| startDate | string [This field contains the start date, which shouldn't be less than the current date, and its format is yyyy-mm-dd, the default value is the current date.] |
Responses
200 This response code will be returned in scenarios where the stop advice is successful, all possible response codes are explained below in the model.
Response Schema: application/json
| issuerSegmentId required |
integer [This field must contain a valid VAU issuer segment id.] Example: 2 |
| rejects required |
Array of objects [List of rejected stop advice responses] |
| Array |
| cardAcceptorId required |
string [This field must contain card acceptor id.] Example: "89389898" |
| cardholderAccountNumber required |
string [This field must contain the account number (Visa, Mastercard, American Express, or Discover).] Example: "400000XX00000000" |
| merchantName required |
string [This field must contain merchant name.] Example: "TestMerchant" |
| rejectCode | string [This field contains one of the following reject codes: - H—Account number does not start with 2, 3, 4, 5 or 6 - G—Account number contains non-numeric characters or is blank - L—Account number is not of proper length (must be 13, 15, 16 or 19) - M—Account number is not mod 10 compliant - N—No stop advice applied, unable to find merchant information for the requested card acceptor id - R—Account number is not associated with requested segment id - S—Start date must not be less than the current date - D—Duplicate stop advice in the request - I—Mandatory field cardholderAccountNumber is missing or blank in the request - J—Mandatory field cardAcceptorId is missing or blank in the request - K—Mandatory field merchantName is missing or blank in the request - F—Stop advice is already placed for requested account number and merchant] Example: "G" |
| rejectMessage | string [This field contains the description of reject message: - H—Account number does not start with 2, 3, 4, 5 or 6 - G—Account number contains non-numeric characters or is blank - L—Account number is not of proper length (must be 13, 15, 16 or 19) - M—Account number is not mod 10 compliant - N—No stop advice applied, unable to find merchant information for the requested card acceptor id - R—Account number is not associated with requested segment id - S—Start date must not be less than the current date - D—Duplicate stop advice in the request - I—Mandatory field cardholderAccountNumber is missing or blank in the request - J—Mandatory field cardAcceptorId is missing or blank in the request - K—Mandatory field merchantName is missing or blank in the request - F—Stop advice is already placed for requested account number and merchant] Example: "Account Number contains non-numeric characters or is blank" |
| startDate | string [This field contains the start date, which shouldn't be less than the current date, and its format is yyyy-mm-dd, the default value is the current date.] |
| responses required |
Array of objects [List of successful stop advice responses] |
| Array |
| cardAcceptorId required |
string [This field must contain card acceptor id.] Example: "89389898" |
| cardholderAccountNumber required |
string [This field must contain the account number (Visa, Mastercard, American Express, or Discover).] Example: "400000XX00000000" |
| merchantName required |
string [This field must contain merchant name.] Example: "TestMerchant" |
| responseCode | string [This field contains one of the following response codes: - 1—Stop advice applied in both RTVAU and VAU - 2—Stop advice applied in VAU - 3—Stop advice applied in RTVAU Example: "1" |
| responseMessage | string [This field contains the description of the response message: - 1—Stop advice applied in both RTVAU and VAU - 2—Stop advice applied in VAU - 3—Stop advice applied in RTVAU Example: "Stop advice applied in both RTVAU and VAU" |
| startDate | string [This field contains the start date, which shouldn't be less than the current date, and its format is yyyy-mm-dd, the default value is the current date.] |