Method: paycache.userPinNotification

A notification about a change to the user's PIN.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "googleUserToken": "User12345",
  "event": {
    "pinBlocked": {}
  },
  "updateSequenceTimestamp": {
    "epochMillis":1481899949606
   }
}

An example response looks like:


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

HTTP request

POST https://billpaynotification.googleapis.com/secure-serving/gsp/v1/paycache/userPinNotification

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "googleUserToken": string,
  "updateSequenceTimestamp": {
    object (Timestamp)
  },
  "event": {
    object (Event)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

googleUserToken

string

REQUIRED: Contains the googleUserToken value identifying a user. This is the user with which the PIN is associated, as in the related setUserPin API method.

UTF-8 encoded, 100 character max length, contains only characters "a-z", "A-Z", "0-9", ":", "-", and "_".

updateSequenceTimestamp

object (Timestamp)

REQUIRED: A timestamp describing when the event took effect. This allows Google to establish an order, for example, for a PIN_BLOCKED notification and a related setUserPin call.

event

object (Event)

REQUIRED: Details about the event that occurred.

Response body

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

Response object for the userPinNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (Result)

REQUIRED: Details corresponding to the result.

Event

Details corresponding to the result.

JSON representation
{

  // Union field event can be only one of the following:
  "pinSet": {
    object (Empty)
  },
  "pinBlocked": {
    object (Empty)
  },
  "pinUnset": {
    object (Empty)
  }
  // End of list of possible types for union field event.
}
Fields

Union field event.

event can be only one of the following:

pinSet

object (Empty)

The PIN was set through some non-Google surface, for example at a bank ATM.

pinBlocked

object (Empty)

The PIN has been blocked, generally due to being entered incorrectly too many times. The PIN must be reset.

pinUnset

object (Empty)

The PIN was unset through some non-Google surface, for example by the bank as a fraud prevention measure.

Result

Details corresponding to the result.

JSON representation
{
  "success": {
    object (Empty)
  }
}
Fields
success

object (Empty)

The notification was received successfully.