Method: asynchronousRefund

  • This endpoint enables refunding a portion or the entire transaction initiated through generateReferenceNumber, using requestId and paymentIntegratorAccountId as the idempotency key.

  • The request body includes details such as request header, payment integrator account ID, original request ID, and the refund amount with currency.

  • Upon successful request, the response acknowledges the refund request initiation, with further updates provided via refundResultNotification API.

  • If an error occurs, the response will be of type ErrorResponse and conform to the defined HTTP status codes.

  • The refund amount is specified in micros and must be less than or equal to the remaining balance of the original payment.

Refunds a portion of or the entire transaction initiated through generateReferenceNumber. The requestId within the header 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": 1,
      "minor": 3,
      "revision": 0
    },
    "requestId": "G18FCDTLD5B0SR4",
    "requestTimestamp": "1482489410000"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "generateReferenceNumberRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
  "refundAmount": {
    "amountMicros": "728000000",
    "currencyCode": "INR"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": "1482489412366"
  },
  "result": {
    "acknowledged": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/refundable-one-time-payment-code-v1/asynchronousRefund

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "refundAmount": {
    object (Amount)
  },

  // Union field payment_request_id can be only one of the following:
  "generateReferenceNumberRequestId": string,
  "captureRequestId": string
  // End of list of possible types for union field payment_request_id.
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
paymentIntegratorAccountId

string

REQUIRED: This is the payment integrator account ID that defines contractual constraints around this transaction.
refundAmount

object (Amount)

REQUIRED: The amount of the refund, this will be a positive number, and should always be less-than or equal-to the remaining balance for the cash payment.
Union field payment_request_id. REQUIRED: A unique identifier for the cash payment which is to be refunded. payment_request_id can be only one of the following:
generateReferenceNumberRequestId

string

The requestId of the initial payment event to be refunded. This is used for: 1. Refunds of one-time reference number payments. 2. Refunds of the initial mandate payment. This ID corresponds to the requestId in the requestHeader of the generateReferenceNumber or createMandateWithOptionalInstantPayment call for the payment being refunded.
captureRequestId

string

The requestId of the capture event to be refunded. This is used for refunds of subsequent/recurring payments made against a mandate. This ID corresponds to the requestId in the requestHeader of the capture call for the payment being refunded.

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 (AsynchronousRefundResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

AsynchronousRefundResponse

Response object for the payment integrator hosted asynchronousRefund method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (AsynchronousRefundResult)

REQUIRED: The result of the asynchronous refund call.

AsynchronousRefundResult

Result of this asynchronous refund.

JSON representation 
{

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

object (Empty)

The refund has been requested and the integrator will do additional steps to determine if the refund was successful. Once the integrator knows the result of the refund, they will inform Google of the result by calling the refundResultNotification API.