Method: paycache.getCardSecurityCode

Gets the Card Security Code (CVV, CVN, CID, etc.) for a given card. Since this value cannot be stored persistently, if the users needs to view it, it must be requested by the user-in-session.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "googleInstrumentToken": "Instrument12345"
}

An example success response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":1481899950236
    }
  },
  "result": {
    "success": {
      "securityCode": "123"
    }
  }
}

HTTP request

POST https://www.integratordomain.com/v1/paycache/getCardSecurityCode

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "googleInstrumentToken": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

googleInstrumentToken

string

REQUIRED: Contains the googleInstrumentToken value that was provided during the issueCard call.

Response body

If successful, the response body contains data with the following structure:

Response object for the getCardSecurityCode method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (GetCardSecurityCodeResult)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (GetCardSecurityCodeResult)

REQUIRED: Details corresponding to the result.

GetCardSecurityCodeResult

Details corresponding to the result.

JSON representation
{

  // Union field result can be only one of the following:
  "success": {
    object (SuccessDetails)
  },
  "riskDecline": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields

Union field result.

result can be only one of the following:

success

object (SuccessDetails)

The Security Code has been successfully retrieved.

riskDecline

object (Empty)

The bank's risk engine has decided not to return the security code.

SuccessDetails

JSON representation
{
  "securityCode": string
}
Fields
securityCode

string

REQUIRED: The security code.