Method: referenceNumberPaidNotification

Stay organized with collections Save and categorize content based on your preferences.

Notify Google that a customer completed payment of a reference number.

It is expected that this will be called within milliseconds of the user paying. While this call can be enqueued if the network is down, Google expects the user will typically receive notification that their payment has been paid by the time they are leaving the store.

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": 2
    },
    "requestId": "cmVxdWVzdDE",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "paymentIntegratorTransactionId": "abc-e34-21343",
  "generateReferenceNumberRequestId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA",
  "paymentTimestamp": {
    "epochMillis": "1481855969203"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481907920760"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://vgw.googleapis.com/gsp/refundable-one-time-payment-code-v2/referenceNumberPaidNotification/:PIAID

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorTransactionId": string,
  "generateReferenceNumberRequestId": string,
  "paymentTimestamp": {
    object (Timestamp)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorTransactionId

string

OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. This is the identifier by which the integrator knows this transaction.

For convenience, this identifier is included when the payment integrator requests remittanceStatementDetails.

generateReferenceNumberRequestId

string

REQUIRED: requestId of the generateReferenceNumber call for this transaction.

paymentTimestamp

object (Timestamp)

REQUIRED: Timestamp recorded by the integrator when the user paid this reference 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

object (ReferenceNumberPaidNotificationResponse)

HTTP 4XX / 5XX Status

object (ErrorResponse)

ReferenceNumberPaidNotificationResponse

Response object for the referenceNumberPaidNotification method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (ReferenceNumberPaidNotificationResult)
  },
  "googlePaymentTransactionId": string
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (ReferenceNumberPaidNotificationResult)

REQUIRED: Result of this referenceNumberPaidNotification call.

googlePaymentTransactionId

string

OPTIONAL: Populated if result is SUCCESS, otherwise not populated. A Google-generated identifier for this transaction that is included when the payment integrator requests remittanceStatementDetails.

ReferenceNumberPaidNotificationResult

Result of this referenceNumberPaidNotification call.

JSON representation
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  },
  "invalidReferenceNumber": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. Result of this referenceNumberPaidNotification call. result can be only one of the following:
success

object (Empty)

The reference number was successfully recorded as paid.

invalidReferenceNumber

object (Empty)

The reference number was not found.