Method: referenceNumberPaidNotification

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.

Responses to this query may be empty if this method does not return an HTTP 200. They are 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 a HTTP 404 with an empty body.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "ZWNobyB0cmFuc2FjdGlvbg",
    "requestTimestamp": 1481855969503
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "paymentIntegratorTransactionId": "abc-e34-21343",
  "referenceNumber": "a1234567",
  "paymentTimestamp": "1481855969203",
  "paymentLocation": {
    "brandName": "ExampleMart",
    "locationId": "7783"
  }
}

An example response looks like:


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

HTTP request

POST https://billpaynotification.googleapis.com/secure-serving/gsp/v1/referenceNumberPaidNotification

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "paymentIntegratorTransactionId": string,
  "referenceNumber": string,
  "paymentTimestamp": string,
  "paymentLocation": {
    object (PaymentLocation)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorAccountId

string

REQUIRED: This is the payment integrator account identifier on which the reference number was created.

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.

referenceNumber

string

REQUIRED: Reference number that the user has paid.

paymentTimestamp

string (int64 format)

REQUIRED: Timestamp recorded by the integrator when the user paid this reference number (milliseconds since epoch).

paymentLocation

object (PaymentLocation)

REQUIRED: Information about the physical location where the user paid.

Response body

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

Response object for the referenceNumberPaidNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (ReferenceNumberPaidNotificationResultCode)

REQUIRED: Result of the 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.

RequestHeader

Header object that is defined on all requests sent to the server.

JSON representation
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Fields
requestId

string

REQUIRED: Unique identifier of this request.

This is a string that has a max length of 100 characters, and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_".

requestTimestamp

string (int64 format)

REQUIRED: Timestamp of this request represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'. This request timestamp is not idempotent upon retries.

userLocale
(deprecated)

string

OPTIONAL: A two- or three-letter ISO 639-2 Alpha 3 language code optionally followed by a hyphen and an ISO 3166-1 Alpha-2 country code, e.g.'pt', 'pt-BR', 'fil', or 'fil-PH'. Use this to help drive the user_message fields in the response.

protocolVersion

object (Version)

REQUIRED: The version of this request.

Version

Version object which is a structured form of the classic a.b.c version structure. Major versions of the same number are guaranteed to be compatible. Note that minor and revisions can change frequently and without notice. The integrator must support all requests for the same major version.

JSON representation
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Fields
major

integer

REQUIRED: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible.

minor

integer

REQUIRED: Minor version. This denotes significant bug fixes.

revision

integer

REQUIRED: Minor version. This denotes minor bug fixes.

PaymentLocation

Information about the physical location where the user paid.

JSON representation
{
  "brandName": string,
  "locationId": string
}
Fields
brandName

string

REQUIRED: The brand name of the location where the user paid (for example, the brand name of the store chain).

locationId

string

REQUIRED: A unique name, number, or other identifier for the specific location where the user paid (for example a number representing the particular store within a brand of stores).

ResponseHeader

Header object that is defined on all responses sent from the server.

JSON representation
{
  "responseTimestamp": string
}
Fields
responseTimestamp

string (int64 format)

REQUIRED: Timestamp of this response represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'.

ReferenceNumberPaidNotificationResultCode

Result codes for the payReferenceNumber method.

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS The reference number was successfully recorded as paid.
INVALID_REFERENCE_NUMBER The reference number was not found.