Method: setAcquirerReferenceNumberForCaptureNotification

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

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

This is used to inform Google of the ARN for a capture. 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 capture request was made. This value is also known as a Coupon Code. Providing this value for a capture helps Google respond to chargeback and fraud investigations.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "3d65cecb-db61-4081-8f6f-178dca6c94a6",
    "requestTimestamp": {
      "epochMillis": "1482192286000"
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "captureRequestId": "G112YZH4XPDV88J",
  "acquirerReferenceNumber": "15714820583910486038403"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1482192286743"
    },
    "requestId": "3d65cecb-db61-4081-8f6f-178dca6c94a6"
  },
  "result": "SUCCESS"
}

HTTP request

POST https://billpaynotification.googleapis.com/secure-serving/gsp/google-authenticated-card-fop-api/v1/setAcquirerReferenceNumberForCaptureNotification

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all responses.

captureRequestId

string

REQUIRED: A unique identifier for the capture to be refunded. This is the requestId generated by Google during the captureFundsReservation or capture which this request is associated with.

acquirerReferenceNumber

string

REQUIRED: The acquirer generated reference number for the capture. 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

If successful, the response body contains data with the following structure:

Response object for the Google hosted SetAcquirerReferenceNumberNotificationForCaptureNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (SetAcquirerReferenceNumberForCaptureNotificationResultCode)

REQUIRED: Result of this call.

SetAcquirerReferenceNumberForCaptureNotificationResultCode

Result codes for the setAcquirerReferenceNumberNotification method.

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