Visa Consumer Authentication Service API Reference

Visa Consumer Authentication Service

VCAS-CardStatus-API

APIs for managing Card Status information in VCAS product.

Upsert Card Status v1 - Latest

Upsert the card status

Request

Request Body schema: application/json

Card status upsert request

Array
accountNumber string [ 13 .. 19 ] characters ^[0-9]*$
Primary account number (PAN) is the key identifier for the cardholder's account.
Example: "1234567890123456"
orgUnitId string 24 characters ^[a-zA-Z0-9]*$
Unique ID given to each issuer
Example: "55555551dd3648c5b814d2ed"
status any
Enum:"ACTIVE" "BLOCKED" "BYPASS" "FORCED_CHALLENGE" "TIMED_BLOCK"
statusDuration string^(\d+)([mhdwy])$
Status will be maintained for the given duration and then it will be ACTIVE
Example: "15m"

Responses

200
Added/Updated the card status record

Response Schema: application/json

Array
responseCode
required		 any
Service response code 0 - Success; 10 - Invalid OrgUnitID; 11 - Invalid PAN; 20 - Forbidden; 30 - Not found; 40 - System error
Example: "0"
responseMessage
required		 any
Service response text specific for CRUD operations
Example: "Successfully Processed"
errorDetail any
Detailed error message in case of error response
Example: "null"

400
Incomplete or invalid request information

Response Schema: application/json
responseCode
required		 any
Service response code 0 - Success; 10 - Invalid OrgUnitID; 11 - Invalid PAN; 20 - Forbidden; 30 - Not found; 40 - System error
Example: "10"
responseMessage
required		 any
Service response text specific for CRUD operations
Example: "Invalid OrgUnitID"
errorDetail any
Detailed error message in case of error response
Example: "null"

401
Access denied

Response Schema: application/json
responseCode
required		 any
Service response code 0 - Success; 10 - Invalid OrgUnitID; 11 - Invalid PAN; 20 - Forbidden; 30 - Not found; 40 - System error
Example: "20"
responseMessage
required		 any
Service response text specific for CRUD operations
Example: "Forbidden access to the account information"
errorDetail any
Detailed error message in case of error response
Example: "null"

404
Account information not found

Response Schema: application/json
responseCode
required		 any
Service response code 0 - Success; 10 - Invalid OrgUnitID; 11 - Invalid PAN; 20 - Forbidden; 30 - Not found; 40 - System error
Example: "30"
responseMessage
required		 any
Service response text specific for CRUD operations
Example: "Account details not found"
errorDetail any
Detailed error message in case of error response
Example: "null"

500
Error while processing the request

Response Schema: application/json
responseCode
required		 any
Service response code 0 - Success; 10 - Invalid OrgUnitID; 11 - Invalid PAN; 20 - Forbidden; 30 - Not found; 40 - System error
Example: "40"
responseMessage
required		 any
Service response text specific for CRUD operations
Example: "Error while processing the request"
errorDetail any
Detailed error message in case of error response
Example: "null"

Request samples

application/json

[{"status": "ACTIVE",
"orgUnitId": "55555551dd3648c5b814d2ed",
"accountNumber": "1234567890123456",
"statusDuration": "15m"
}]

Response samples

application/json

[nul]