Method: refundResultNotification

Notifies Google of the final result of an asynchronousRefund request.

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

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "8a986fe8-5a2c-45a4-a1bb-3bed6e651020",
    "requestTimestamp": {
      "epochMillis": 1482452962000
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "paymentIntegratorRefundId": "UJ97F3RY8R",
  "refundRequestId": "liUrreQY233839dfFFb24gaQM",
  "refundResultDeprecated": "SUCCESS",
  "rawResult": {
    "scope": "VISA",
    "rawCode": "00"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": 1482452962840
    }
  },
  "resultDeprecated": "SUCCESS"
}

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorRefundId": string,
  "refundRequestId": string,
  "result": {
    object (RefundResult)
  },
  "refundResultDeprecated": enum (RefundResultCode),
  "rawResult": {
    object (RawResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorRefundId

string

OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. The integrator identifies this refund in their system by this identifier.

For convenience, this identifier is included with in the remittance details

refundRequestId

string

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

result

object (RefundResult)

REQUIRED: Result of this refund.

refundResultDeprecated
(deprecated)

enum (RefundResultCode)

DEPRECATED: Result of this refund.

This is being deprecated in favor of the refundResult object.

It will be removed before the API is finalized.

rawResult

object (RawResult)

OPTIONAL: Raw result of this refund. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

This value is required if the result is not SUCCESS.

Response body

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

Response object for the Google hosted RefundNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (RefundResultNotificationResult)

REQUIRED: Result of this call.

resultDeprecated
(deprecated)

enum (RefundResultNotificationResultCode)

DEPRECATED: Result of this call.

This is being deprecated in favor of the refundResultNotificationResult object.

It will be removed before the API is finalized.

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)
  }
  // End of list of possible types for union field result.
}
Fields

Union field result.

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.

accountClosedAccountTakenOver

object (AccountClosedAccountTakenOver)

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

accountClosedFraud

object (AccountClosedFraud)

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

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.

AccountClosed

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

JSON representation
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

AccountClosedAccountTakenOver

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

JSON representation
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

AccountClosedFraud

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

JSON representation
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

AccountOnHold

The account is on hold.

JSON representation
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

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.

JSON representation
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

RefundResultCode

Result codes for refunds.

Enums
REFUND_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS Successful refund.
NO_MONEY_LEFT_ON_TRANSACTION Refund failed, there is no money left on the transaction. Typically this represents bug between the integrator and Google. Google should not ask to refund an amount greater than the original capture.

RefundResultNotificationResult

Result messages for the refundResultNotification method.

JSON representation
{
  "accepted": {
    object (Empty)
  }
}
Fields
accepted

object (Empty)

Refund result notification was accepted.

RefundResultNotificationResultCode

Result codes for the refundResultNotification method.

Enums
REFUND_RESULT_NOTIFICATION_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS Refund result notification was successfully processed.