Method: refundResultNotification

  • This method notifies Google of a refund's result after a refund call, acting as a backup signal if the synchronous call fails.

  • The refundResult value is idempotent for a given refundRequestId and cannot be changed by subsequent calls.

  • Successful calls return an HTTP 200 response with a RefundResultNotificationResponse object.

  • Errors result in HTTP 4xx or 5xx responses with either an ErrorResponse or a generic error message.

  • The request body includes a requestHeader, refundRequestId, and the result of the refund.

Notify Google of the result of a refund after a refund method call has been made.

Refunds should be handled synchronously during the refund method call, but this method provides Google with a fast backup signal in case the synchronous call fails after it has performed the action but before it can return a result. This avoids the delay introduced by Google scheduling a retry for a future time.

The refundResult value is idempotent for this refundRequestId, so it's value can not be changed by a subsequent call to this method.

If the endpoint encounters an error while processing the request, the endpoint will return HTTP 4xx or 5xx and the HTTP body will either be of type ErrorResponse or contain a generic error (e.g. a message similar to "There was an error. Please try again later.").

The generic error is used 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 generic error. If the request signature could be verified, additional information regarding the error will be returned in an ErrorResponse.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": {
      "epochMillis": "1481852928293"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "refundRequestId": "hH1T32PI86CpKwjuf6oD2r",
  "result": {
    "success": {}
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481855928376"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://vgw.googleapis.com/gsp/refundable-one-time-payment-code-v2/refundResultNotification/:PIAID

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "refundRequestId": string,
  "result": {
    object (RefundResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
refundRequestId

string

REQUIRED: requestId of the asynchronousRefund call for this transaction.
result

object (RefundResult)

REQUIRED: Result of this refund.

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

object (RefundResultNotificationResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

RefundResult

Result codes for refunds.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  },
  "accountClosed": {
    object (AccountClosed)
  },
  "accountClosedAccountTakenOver": {
    object (AccountClosedAccountTakenOver)
  },
  "accountClosedFraud": {
    object (AccountClosedFraud)
  },
  "accountOnHold": {
    object (AccountOnHold)
  },
  "refundExceedsMaximumBalance": {
    object (RefundExceedsMaximumBalance)
  },
  "refundWindowExceeded": {
    object (RefundWindowExceeded)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The result of this refund. result can be only one of the following:
success

object (Empty)

Successful refund.
accountClosed

object (AccountClosed)

The account held with the integrator has been closed.

Returning this value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument by going through the association flow again.
accountClosedAccountTakenOver

object (AccountClosedAccountTakenOver)

The user's account with the integrator has been closed, suspected account take over.

Returning this value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument by going through the association flow again.
accountClosedFraud

object (AccountClosedFraud)

The user's account held with the integrator has been closed because of fraud.

Returning this value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument by going through the association flow again.
accountOnHold

object (AccountOnHold)

The user's account is currently on hold and cannot accept the refund, but the user's account may later be able to accept the refund. Google may request another refund in the future, but will do so with a new requestId, so this request should be considered finished.
refundExceedsMaximumBalance

object (RefundExceedsMaximumBalance)

The refund cannot be processed at the current time, because doing so would cause the user's balance to exceed the maximum allowed amount. Google may request another refund in the future, but will do so with a new requestId, so this request should be considered finished.
refundWindowExceeded

object (RefundWindowExceeded)

The refund cannot be processed because the request is outside of the allowed refund period.

RefundResultNotificationResponse

Response object for the refundResultNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (RefundResultNotificationResult)

REQUIRED: Result of this call.

RefundResultNotificationResult

Result messages for the refundResultNotification method.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The result of the refundResultNotification call. result can be only one of the following:
success

object (Empty)

Refund result notification was successful.