- HTTP request
- Request body
- Response body
- DeviceCaptureResultNotificationResponse
- 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.
If the endpoint encounters an error while processing the request, the response from this endpoint will be of type ErrorResponse
.
Responses to this query may be empty if this method does not return an HTTP 200. The response body is 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 an HTTP 404 with an empty body. If the request signature could be verified, additional information regarding the error will be returned in the response 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://vgw.googleapis.com/gsp/value-on-device-fop-v1/deviceCaptureResultNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object (RequestHeader) }, "paymentIntegratorAccountId": string, "generateDeviceCaptureTokenRequestId": string, "deviceCaptureResult": { object (DeviceCaptureResult) } } |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
payment |
REQUIRED: Payment integrator account identifier on which the device capture occurred. |
generate |
REQUIRED: A unique identifier for this transaction. This is the |
device |
REQUIRED: Result of this device capture. |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status | |
HTTP 4XX / 5XX Status |
|
DeviceCaptureResultNotificationResponse
Response object for the deviceCaptureResultNotification
method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"result": enum ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
DeviceCaptureResultNotificationResultCode
Result codes for the deviceCaptureResultNotification
method.
Enums | |
---|---|
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
Capture result notification was successful. |