- HTTP request
- Request body
- Response body
- CaptureFundsReservationResultCode
- CaptureFundsReservationResultNotificationResponse
- CaptureFundsReservationResultNotificationResultCode
Notifies Google of the final result of an asynchronousCaptureFundsReservation
request.
The captureFundsReservationResult
value is idempotent for this captureFundsReservationRequestId
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": 0,
"revision": 0
},
"requestId": "b558bd2b-5c61-4c75-b622-c0357e74c5ff",
"requestTimestamp": "1481907920000"
},
"captureFundsReservationRequestId": "G112YZH4XPDV88J",
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR",
"captureFundsReservationResult": "SUCCESS",
"rawResult": {
"scope": "VISA",
"rawCode": "00"
}
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1481907920560"
},
"result": "SUCCESS"
}
HTTP request
POST https://vgw.googleapis.com/gsp/v1/payment-integrator-card-fop-api/captureFundsReservationResultNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object (RequestHeader)
},
"captureFundsReservationRequestId": string,
"paymentIntegratorAccountId": string,
"captureFundsReservationResult": enum ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all responses. |
captureFundsReservationRequestId |
REQUIRED: A unique identifier for this transaction. This is the |
paymentIntegratorAccountId |
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |
captureFundsReservationResult |
REQUIRED: The result of this capture attempt. |
rawResult |
OPTIONAL: The raw response code from the network to this capture call. This is informational only. |
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 |
|
CaptureFundsReservationResultCode
Result codes for captures.
Enums | |
---|---|
CAPTURE_FUNDS_RESERVATION_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
The capture completed successfully. |
RESERVATION_OF_FUNDS_EXPIRED |
The prior reservation of funds has expired. |
REVOCATION_OF_AUTHORIZATION |
The network returned "Revocation of authorization order". |
CaptureFundsReservationResultNotificationResponse
Response object for the Google hosted card-fop-v1.captureFundsReservationResultNotification method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"result": enum ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
CaptureFundsReservationResultNotificationResultCode
Result codes for the captureResultNotification
method.
Enums | |
---|---|
CAPTURE_FUNDS_RESERVATION_RESULT_NOTIFICATION_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
Capture Funds Reservation notification was successfully processed. |