- HTTP request
- Request body
- Response body
- GetDeviceCaptureResultResponse
- GetDeviceCaptureResultResultCode
- DeviceCaptureResult
- DeviceCaptureResultCode
Requests the result of the execution of a previously generated device capture token.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"requestTimestamp": "1502220196077"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"deviceCaptureRequestId": "WW91IHN1cFyZW4ndCB5b3U"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"result": "SUCCESS",
"deviceCaptureResult": {
"deviceCaptureResultCode": "SUCCESS"
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/value-on-device-fop-v1/getDeviceCaptureResult
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
payment |
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |
device |
REQUIRED: A unique identifier for this transaction that is a reference to the requestId provided at generateDeviceCaptureToken time. |
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 |
|
GetDeviceCaptureResultResponse
Response object for the getDeviceCaptureResult method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: The result of this API call. This result is not the same as the device capture's result; this is an indicator of whether the integrator was able to successfully determine/look up the device capture's result. A |
device |
REQUIRED: The result of the device capture attempt. |
GetDeviceCaptureResultResultCode
Result codes for getDeviceCaptureResult.
Enums | |
---|---|
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
Device capture result successfully retrieved. |
DeviceCaptureResult
Information about the final result of a device capture.
JSON representation |
---|
{ "deviceCaptureResultCode": enum ( |
Fields | |
---|---|
device |
REQUIRED: Result code of this device capture. |
Union field
|
|
transaction |
OPTIONAL: If This amount is micros of the same |
transaction |
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. |