- HTTP request
- Request body
- Response body
- RefundResultNotificationResponse
- RefundResultNotificationResult
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 its value can not 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": 1,
"revision": 0
},
"requestId": "HsKv5pvtQKTtz7rdcw1YqE",
"requestTimestamp": "1481855928301"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"refundRequestId": "hH1T32PI86CpKwjuf6oD2r",
"refundResult": "SUCCESS"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1481855928376"
},
"result": {
"accepted": {}
}
}
HTTP request
POST https://vgw.googleapis.com/gsp/refundable-one-time-payment-code-v1/refundResultNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object (RequestHeader) }, "paymentIntegratorAccountId": string, "refundRequestId": string, "refundResult": enum (RefundResultCode), "paymentIntegratorRefundId": string } |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
payment |
REQUIRED: Payment integrator account identifier on which the refund occurred. |
refund |
REQUIRED: Unique identifier for this refund, established by the |
refund |
REQUIRED: Result of this refund. |
payment |
REQUIRED: This identifier is specific to the integrator and is generated by the integrator. This is the identifier that the integrator knows this refund by. For convenience, this identifier is included with in the remittance details |
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 |
|
RefundResultNotificationResponse
Response object for the refundResultNotification
method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"result": {
object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
RefundResultNotificationResult
Result messages for the refundResultNotification
method.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
accepted |
Refund result notification was accepted |