Method: cancelFundsReservationResultNotification

Notifies Google of the final result of an asynchronousCancelFundsReservation request.

The cancelFundsReservationResult value is idempotent for this cancelFundsReservationRequestId and cannot be changed by a subsequent call to this method.

If the reservation of funds has expired or the payment integrator has automatically canceled the reservation, consider it a successful cancel rather than an error. Therefore, use a SUCCESS result code.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "473da9f8-92c4-4481-b830-976481d928d2",
    "requestTimestamp": {
      "epochMillis": 1481907920000
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "cancelFundsReservationRequestId": "G1NMPDFX4AW395L",
  "cancelFundsReservationResult": "SUCCESS",
  "rawResult": {
    "scope": "VISA",
    "rawCode": "05"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": 1481907920760
    }
  },
  "result": "SUCCESS"
}

HTTP request

POST https://billpaynotification.googleapis.com/secure-serving/gsp/google-authenticated-card-fop-api/v1/cancelFundsReservationResultNotification

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "cancelFundsReservationRequestId": string,
  "cancelFundsReservationResult": enum (CancelFundsReservationResultCode),
  "rawResult": {
    object (RawResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all responses.

cancelFundsReservationRequestId

string

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

cancelFundsReservationResult

enum (CancelFundsReservationResultCode)

REQUIRED: The result of this cancel call.

rawResult

object (RawResult)

OPTIONAL: The raw response code from the network to this call call. This is informational only.

Response body

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

Response object for the Google CancelFundsReservationResultNotificationResponse method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (CancelFundsReservationResultNotificationResultCode)

REQUIRED: Result of this call.

CancelFundsReservationResultCode

Result codes for cancels.

Enums
CANCEL_FUNDS_RESERVATION_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS The cancel completed successfully.
WAIT_FOR_RESERVATION_EXPIRATION Due to an unretriable error, the reservation of funds can not be cancelled at this time but will automatically expire at the reservation_expiration_timestamp specified on the ReserveFundsResponse.

CancelFundsReservationResultNotificationResultCode

Result codes for the cancelFundsReservationResultNotification method.

Enums
CANCEL_FUNDS_RESERVATION_RESULT_NOTIFICATION_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS Cancel Funds Reservation notification was successfully processed.