- HTTP request
- Request body
- Response body
- RefundResponse
- RefundResult
- AccountClosedAccountTakenOver
- AccountClosedFraud
- AccountOnHold
- RefundExceedsMaximumBalance
- RefundWindowExceeded
Refunds a portion of or the entire transaction initiated through capture
. The combination of requestId
within the header and paymentIntegratorAccountId
is the idempotency key, which uniquely identifies this transaction.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 2
},
"requestId": "liUrreQY233839dfFFb24gaQM",
"requestTimestamp": {
"epochMillis": "1502220434778"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"transactionId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"refundAmount": {
"amountMicros": "208000000",
"currencyCode": "INR"
}
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481900013178"
}
},
"result": {
"success": {}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/refundable-one-time-payment-code-v2/refund
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
transactionId |
REQUIRED: A unique identifier for this transaction. This is a |
refundAmount |
REQUIRED: The amount of the refund. Must be a positive number. |
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 |
|
RefundResponse
Response object for the refund method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this refund. |
RefundResult
Result codes for refunds.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
success |
Successful refund. |
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 |
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 |
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 |
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 |
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 |
refundWindowExceeded |
The refund cannot be processed because the request is outside of the allowed refund period. |
AccountClosedAccountTakenOver
The user's account with the integrator has been closed, suspected account take over.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
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 |
AccountClosedFraud
The user's account held with the integrator has been closed because of fraud.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
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 |
AccountOnHold
The account is on hold.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
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 |
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 ( |
Fields | |
---|---|
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 |
RefundWindowExceeded
The refund cannot be processed because the request is outside of the allowed refund period.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
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 |