Method: remittanceStatementNotification

Notifies the integrator of a new remittance statement.

Statement notifications occur every time a new statement is raised that represents money that Google will pay the integrator or the money that the integrator owes Google.

If the integrator returns a success, then it acknowledges receipt of the statement.

The requestId is also the statement Id (used elsewhere). The combination of requestId and paymentIntegratorAccountId within the header is the idempotency key and uniquely identifies this statement.

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": 2
    },
    "requestId": "0123434-statement-abc",
    "requestTimestamp": {
      "epochMillis": "1502632800000"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "remittanceStatementSummary": {
    "statementDate": {
      "epochMillis": "1502521200000"
    },
    "billingPeriod": {
      "startDate": {
        "epochMillis": "1502434800000"
      },
      "endDate": {
        "epochMillis": "1502434800000"
      }
    },
    "dateDue": {
      "epochMillis": "1502348400000"
    },
    "totalDueByIntegrator": {
      "amountMicros": "1076000000",
      "currencyCode": "INR"
    },
    "totalEvents": 15
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1502632802000"
    }
  },
  "result": {
    "accepted": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/v2/remittanceStatementNotification

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
remittanceStatementSummary

object (RemittanceStatementSummary)

REQUIRED: Summary of this remittance statement.

Response body

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

Response object for the remittance statement notification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (StatementNotificationResult)

REQUIRED: Result of this statement notification.

RequestHeader

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

JSON representation 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
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

object (Timestamp)

REQUIRED: Timestamp of this request. The receiver must verify that this timestamp is ± 60s of 'now', and reject the request if it is not. This request timestamp is not idempotent upon retries.
protocolVersion

object (Version)

REQUIRED: The version of this request.
paymentIntegratorAccountId

string

REQUIRED: Identifies a unique account with contractual constraints.

Timestamp

A timestamp object representing a point on the ISO timeline in milliseconds since the Unix epoch.

JSON representation 
{
  "epochMillis": string
}
Fields
epochMillis

string (Int64Value format)

Milliseconds since the Unix epoch

Version

Version object contains the major version of the API. Versions of the same major version are guaranteed to be compatible. The integrator must support all requests for the same major version.

JSON representation 
{
  "major": integer
}
Fields
major

integer

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

RemittanceStatementSummary

Summary object about a remittance statement.

JSON representation 
{
  "statementDate": {
    object (Timestamp)
  },
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": {
    object (Timestamp)
  },
  "totalDueByIntegrator": {
    object (Amount)
  },
  "totalEvents": integer
}
Fields
statementDate

object (Timestamp)

REQUIRED: Date (in America/Los Angeles) that this statement was created.
billingPeriod

object (BillingPeriod)

REQUIRED: The billing period this statement covers.
dateDue

object (Timestamp)

OPTIONAL: The date that the remittance is due. This is represented as a Timestamp. It is a date (and therefore will always start at the first millisecond of the day in the billing timezone).

This is set as long as the totalDueByIntegrator is greater than 0.
totalDueByIntegrator

object (Amount)

REQUIRED: This value is in micros in the currency of currencyCode. This value is always positive.
totalEvents

integer

REQUIRED: Total number of events in this statement.

BillingPeriod

Billing period of this statement.

JSON representation 
{
  "startDate": {
    object (Timestamp)
  },
  "endDate": {
    object (Timestamp)
  }
}
Fields
startDate

object (Timestamp)

REQUIRED: The start date of the billing period. This is represented as a Timestamp. It is a date (and therefore will always start at the first millisecond of the day in the billing timezone).

This is the first millisecond of the day of the billing period, 00:00:00.000
endDate

object (Timestamp)

REQUIRED: The end date of the billing period. This is represented as a Timestamp.

This is the last millisecond of the last day of the billing period, 23:59:59.999

Amount

Associates an amount in micros with a currency code.

JSON representation 
{
  "amountMicros": string,
  "currencyCode": string
}
Fields
amountMicros

string (Int64Value format)

REQUIRED: An amount in micros.
currencyCode

string

REQUIRED: ISO 4217 3-letter currency code

ResponseHeader

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

JSON representation 
{
  "responseTimestamp": {
    object (Timestamp)
  }
}
Fields
responseTimestamp

object (Timestamp)

REQUIRED: Timestamp of this response. The receiver must verify that this timestamp is ± 60s of 'now', and reject the response if it is not.

StatementNotificationResult

Result of this statement notification.

JSON representation 
{

  // Union field result can be only one of the following:
  "accepted": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. The possible results of this statement notification. result can be only one of the following:
accepted

object (Empty)

Integrator acknowledges receipt of this notification.

Empty

This object is used for extensibility because booleans and enumerations often need to be extended with extra data. The implementer uses it to determine presence. The enumeration this represents may be extended to contain data in future versions.

The JSON representation for Empty is empty JSON object {}.