Method: deviceCaptureResultNotification

Notify Google of the result of a device capture after a generateDeviceCaptureToken method call has been made.

The deviceCaptureResult value is idempotent for this generateDeviceCaptureTokenRequestId, so its value must be identical to any value communicated via generateDeviceCaptureToken or getDeviceCaptureResult, and cannot be changed by a subsequent call to this method.

Responses to this query may be empty if this method does not return an HTTP 200. They are empty in situations where an ErrorResponse with a clear description could be used to help an attacker understand the payment integrator account identifier of other integrators. In these situations, where either the signing key doesn't match, the payment integrator identifier was not found, or the encryption key was unknown, this method will return a HTTP 404 with an empty body.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "KcgwSKrV76eVNDUbsZ4UA3",
    "requestTimestamp": "1481852928293"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "generateDeviceCaptureTokenRequestId": "awNaC510cefae3IJdNEvW2",
  "deviceCaptureResult": {
    "deviceCaptureResultCode": "SUCCESS"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": "1481852928324"
  },
  "result": "SUCCESS"
}

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "generateDeviceCaptureTokenRequestId": string,
  "deviceCaptureResult": {
    object (DeviceCaptureResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorAccountId

string

REQUIRED: Payment integrator account identifier on which the device capture occurred.

generateDeviceCaptureTokenRequestId

string

REQUIRED: A unique identifier for this transaction. This is the requestId generated by Google during the generateDeviceCaptureToken call which this request is associated with.

deviceCaptureResult

object (DeviceCaptureResult)

REQUIRED: Result of this device capture.

Response body

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

Response object for the deviceCaptureResultNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (DeviceCaptureResultNotificationResultCode)

REQUIRED: Result of this call.

RequestHeader

Header object that is defined on all requests sent to the server.

JSON representation
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Fields
requestId

string

REQUIRED: Unique identifier of this request.

This is a string that has a max length of 100 characters, and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_".

requestTimestamp

string (int64 format)

REQUIRED: Timestamp of this request represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'. This request timestamp is not idempotent upon retries.

userLocale
(deprecated)

string

OPTIONAL: A two- or three-letter ISO 639-2 Alpha 3 language code optionally followed by a hyphen and an ISO 3166-1 Alpha-2 country code, e.g.'pt', 'pt-BR', 'fil', or 'fil-PH'. Use this to help drive the user_message fields in the response.

protocolVersion

object (Version)

REQUIRED: The version of this request.

Version

Version object which is a structured form of the classic a.b.c version structure. Major versions of the same number are guaranteed to be compatible. Note that minor and revisions can change frequently and without notice. The integrator must support all requests for the same major version.

JSON representation
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Fields
major

integer

REQUIRED: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible.

minor

integer

REQUIRED: Minor version. This denotes significant bug fixes.

revision

integer

REQUIRED: Minor version. This denotes minor bug fixes.

DeviceCaptureResult

Information about the final result of a device capture.

JSON representation
{
  "deviceCaptureResultCode": enum (DeviceCaptureResultCode),

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
Fields
deviceCaptureResultCode

enum (DeviceCaptureResultCode)

REQUIRED: Result code of this device capture.

Union field FailureDetail.

FailureDetail can be only one of the following:

transactionMaxLimit

string (Int64Value format)

OPTIONAL: If deviceCaptureResultCode is CHARGE_EXCEEDS_TRANSACTION_LIMIT then this is the value of the maximum allowable transaction. This is used for structured, user facing messaging and decline rate analysis.

This amount is micros of the same currencyCode as the original generateDeviceCaptureToken method call.

transactionMinLimit

string (Int64Value format)

OPTIONAL: If deviceCaptureResultCode is CHARGE_UNDER_TRANSACTION_LIMIT then this is the value of the minimum allowable transaction. This is used for structured, user facing messaging and decline rate analysis.

This amount is micros of the same currencyCode as the original generateDeviceCaptureToken method call.

DeviceCaptureResultCode

Result codes for a device capture.

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS Device capture successful.
CHARGE_UNDER_TRANSACTION_LIMIT Requested device capture amount does not meet the integrator's minimum per-transaction amount. If this code is used, populate the transactionMinLimit field with the minimum transaction amount for user messaging purposes.
CHARGE_EXCEEDS_TRANSACTION_LIMIT Requested device capture amount exceeds the integrator's maximum per-transaction limit. If this code is used, populate the transactionMaxLimit field with the transaction limit for user messaging purposes.
CHARGE_EXCEEDS_DAILY_LIMIT User's account cannot be used for purchases right now as it has exceeded its daily limit.
CHARGE_EXCEEDS_MONTHLY_LIMIT User's account cannot be used for purchases right now as it has exceeded its monthly limit.
ACCOUNT_CLOSED User's account held with the integrator has been closed. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER User's account with the integrator has been closed, suspected account take over. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_CLOSED_FRAUD User's account held with the integrator has been closed because of fraud. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_ON_HOLD User's account is on hold.
INSUFFICIENT_FUNDS This account does not have sufficient funds to guarantee this capture.

ResponseHeader

Header object that is defined on all responses sent from the server.

JSON representation
{
  "responseTimestamp": string
}
Fields
responseTimestamp

string (int64 format)

REQUIRED: Timestamp of this response represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'.

DeviceCaptureResultNotificationResultCode

Result codes for the deviceCaptureResultNotification method.

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS Capture result notification was successful.