Method: setAcquirerReferenceNumberForRefundNotification

Notifies Google of the Acquirer Reference Number (ARN) for a refund.

The acquirerReferenceNumber value is unique for this refundRequestId and cannot be changed by a subsequent call to this method. If a new request is made with a different ARN for the same refundRequestId an HTTP 400 will be returned.

This is used to inform Google for the ARN for this refund. This is an identifier that is shared between the issuer, merchant, network and processor. It typically is known to the processor a few days after the refund request was made. Providing this value for a refund helps Google correctly handle requests involving the refund.

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": "b7256a33-864d-40cb-84be-7ad2482cf25a",
    "requestTimestamp": "1482797086000"
  },
  "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR",
  "refundRequestId": "G18FCDTLD5B0SR4",
  "acquirerReferenceNumber": "74896130957836587146723"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": "1482797086918"
  },
  "result": "SUCCESS"
}

HTTP request

POST https://vgw.googleapis.com/secure-serving/gsp/google-card-fop-api/v1/setAcquirerReferenceNumberForRefundNotification/:PIAID

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "refundRequestId": string,
  "acquirerReferenceNumber": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all responses.
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 transaction to associate this ARN with. This is the requestId generated by Google during the asynchronousRefund call for the refund.
acquirerReferenceNumber

string

REQUIRED: The acquirer generated reference number for the refund. This number is an identifier that is shared between the issuer, processor, network and merchant. It can be used to uniquely identify a transaction.

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

object (ErrorResponse)

SetAcquirerReferenceNumberForRefundNotificationResponse

Response object for the Google hosted SetAcquirerReferenceNumberNotificationForRefundNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

enum (SetAcquirerReferenceNumberForRefundNotificationResultCode)

REQUIRED: Result of this call.

SetAcquirerReferenceNumberForRefundNotificationResultCode

Result codes for the setAcquirerReferenceNumberNotification method.

Enums
SET_ACQUIRER_REFERENCE_NUMBER_FOR_REFUND_NOTIFICATION_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS The Acquirer Reference Number was successfully recorded.