Method: reverseRefundNotification
Stay organized with collections
Save and categorize content based on your preferences.
Notifies Google of a refund that is being reversed.
This signifies that a previously successful refund is being reversed and funds are being returned to Google by the issuer.
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": 1,
"minor": 0,
"revision": 0
},
"requestId": "9e4a71df-bf46-44fb-8cad-f1b533e94a78",
"requestTimestamp": "1483711327000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR",
"refundRequestId": "8a986fe8-5a2c-45a4-a1bb-3bed6e651020",
"amount": "54390000",
"rawResult": {
"scope": "VISA",
"rawCode": "07"
}
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1483711328235"
},
"result": "SUCCESS"
}
HTTP request
POST https://vgw.googleapis.com/secure-serving/gsp/google-card-fop-api/v1/reverseRefundNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
{
"requestHeader": {
object (RequestHeader)
},
"paymentIntegratorAccountId": string,
"refundRequestId": string,
"amount": string,
"rawResult": {
object (RawResult)
}
} |
Fields |
requestHeader |
object (RequestHeader)
REQUIRED: Common header for all requests.
|
paymentIntegratorAccountId |
string
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction.
|
refundRequestId |
string
REQUIRED: A unique identifier for the refund that is being reversed. This is the requestId generated by the Google during the asynchronousRefund method call this request is associated with.
|
amount |
string (Int64Value format)
REQUIRED: The amount of the refund that is being reversed, in micros of the currency unit. This is greater than zero but can be less than or equal to the amount in the AsynchronousRefund request. It is in the same currency unit as the capture.
|
rawResult |
object (RawResult)
REQUIRED: Raw result of the refund reversal request from the issuer. Used to help inform Google's risk engine and analytics.
|
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 (ReverseRefundNotificationResponse )
|
HTTP 4XX / 5XX Status |
object (ErrorResponse)
|
ReverseRefundNotificationResponse
Response object for Google hosted card-fop-v1.reverseRefundNotification method.
ReverseRefundNotificationResultCode
Result codes for the reverseRefundNotification
method.
Enums |
REVERSE_REFUND_NOTIFICATION_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
Reverse refund notification was successfully processed. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThis API notifies Google of a refund reversal, signifying that funds are being returned to Google by the issuer after a previous refund.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes information like the refund request ID, amount, and raw result from the issuer.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests receive an HTTP 200 response with a \u003ccode\u003eReverseRefundNotificationResponse\u003c/code\u003e object indicating success.\u003c/p\u003e\n"],["\u003cp\u003eError scenarios result in HTTP 4xx or 5xx responses, potentially with an \u003ccode\u003eErrorResponse\u003c/code\u003e object containing further details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eReverseRefundNotificationResultCode\u003c/code\u003e enum provides status codes for the operation, primarily "SUCCESS" for successful processing.\u003c/p\u003e\n"]]],["This document details how to notify Google about a reversed refund via the `reverseRefundNotification` method. Key actions include sending a POST request to a specific URL with a JSON request body that includes a `requestHeader`, `paymentIntegratorAccountId`, `refundRequestId`, `amount`, and `rawResult`. Successful requests receive a 200 status and a response with a `responseHeader` and `result` of \"SUCCESS\". Errors result in 4xx or 5xx HTTP codes, potentially with an `ErrorResponse` or generic error message in the body.\n"],null,["# Method: reverseRefundNotification\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [ReverseRefundNotificationResponse](#ReverseRefundNotificationResponse)\n - [JSON representation](#ReverseRefundNotificationResponse.SCHEMA_REPRESENTATION)\n- [ReverseRefundNotificationResultCode](#ReverseRefundNotificationResultCode)\n\nNotifies Google of a refund that is being reversed.\n\nThis signifies that a previously successful refund is being reversed and funds are being returned to Google by the issuer.\n\nIf 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`](/pay/card-fop-v1/payment-integrator-card-fop-api/ErrorResponse) or contain a generic error (e.g. a message similar to \"There was an error. Please try again later.\").\n\nThe generic error is used in situations where an [`ErrorResponse`](/pay/card-fop-v1/payment-integrator-card-fop-api/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`](/pay/card-fop-v1/payment-integrator-card-fop-api/ErrorResponse).\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1,\n \"minor\": 0,\n \"revision\": 0\n },\n \"requestId\": \"9e4a71df-bf46-44fb-8cad-f1b533e94a78\",\n \"requestTimestamp\": \"1483711327000\"\n },\n \"paymentIntegratorAccountId\": \"SpeedyPaymentsIndia_INR\",\n \"refundRequestId\": \"8a986fe8-5a2c-45a4-a1bb-3bed6e651020\",\n \"amount\": \"54390000\",\n \"rawResult\": {\n \"scope\": \"VISA\",\n \"rawCode\": \"07\"\n }\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1483711328235\"\n },\n \"result\": \"SUCCESS\"\n }\n\n### HTTP request\n\n`POST https://vgw.googleapis.com/secure-serving/gsp/google-card-fop-api/v1/reverseRefundNotification/`[:PIAID](/pay/card-fop-v1/reference/glossary#payment_integrator_account_id)\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/card-fop-v1/payment-integrator-card-fop-api/RequestHeader) }, \"paymentIntegratorAccountId\": string, \"refundRequestId\": string, \"amount\": string, \"rawResult\": { object (/pay/card-fop-v1/payment-integrator-card-fop-api/CardNetworkResult#RawResult) } } ``` |\n\n| Fields ||\n|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/card-fop-v1/payment-integrator-card-fop-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |\n| `refundRequestId` | `string` **REQUIRED** : A unique identifier for the refund that is being reversed. This is the `requestId` generated by the Google during the `asynchronousRefund` method call this request is associated with. |\n| `amount` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED** : The amount of the refund that is being reversed, in micros of the currency unit. This is greater than zero but can be less than or equal to the amount in the `AsynchronousRefund` request. It is in the same currency unit as the capture. |\n| `rawResult` | `object (`[RawResult](/pay/card-fop-v1/payment-integrator-card-fop-api/CardNetworkResult#RawResult)`)` **REQUIRED**: Raw result of the refund reversal request from the issuer. Used to help inform Google's risk engine and analytics. |\n\n### Response body\n\nThis 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](/pay/card-fop-v1/guides/connectivity/protocol-standards#http_status_codes).\n\n| Possible response messages ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| HTTP 200 Status | `object (`[ReverseRefundNotificationResponse](/pay/card-fop-v1/google-card-fop-api/reverseRefundNotification#ReverseRefundNotificationResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/card-fop-v1/payment-integrator-card-fop-api/ErrorResponse)`)` |\n\nReverseRefundNotificationResponse\n---------------------------------\n\nResponse object for Google hosted card-fop-v1.reverseRefundNotification method.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/card-fop-v1/payment-integrator-card-fop-api/ResponseHeader) }, \"result\": enum (/pay/card-fop-v1/google-card-fop-api/reverseRefundNotification#ReverseRefundNotificationResultCode) } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/card-fop-v1/payment-integrator-card-fop-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `result` | `enum (`[ReverseRefundNotificationResultCode](/pay/card-fop-v1/google-card-fop-api/reverseRefundNotification#ReverseRefundNotificationResultCode)`)` **REQUIRED**: Result of this call. |\n\nReverseRefundNotificationResultCode\n-----------------------------------\n\nResult codes for the `reverseRefundNotification` method.\n\n| Enums ||\n|-------------------------------------------------------|---------------------------------------------------------|\n| `REVERSE_REFUND_NOTIFICATION_RESULT_CODE_UNSPECIFIED` | Do not ever set this default value! |\n| `SUCCESS` | Reverse refund notification was successfully processed. |"]]