- HTTP request
- Request body
- Response body
- DeviceCaptureResult
- DeviceCaptureResultCode
- DeviceCaptureResultNotificationResultCode
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 ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
paymentIntegratorAccountId |
REQUIRED: Payment integrator account identifier on which the device capture occurred. |
generateDeviceCaptureTokenRequestId |
REQUIRED: A unique identifier for this transaction. This is the |
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 ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
DeviceCaptureResult
Information about the final result of a device capture.
JSON representation | |
---|---|
{ "deviceCaptureResultCode": enum ( |
Fields | ||
---|---|---|
deviceCaptureResultCode |
REQUIRED: Result code of this device capture. |
|
Union field
|
||
transactionMaxLimit |
OPTIONAL: If This amount is micros of the same |
|
transactionMinLimit |
OPTIONAL: If This amount is micros of the same |
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. |
DeviceCaptureResultNotificationResultCode
Result codes for the deviceCaptureResultNotification
method.
Enums | |
---|---|
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
Capture result notification was successful. |