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"
    },
    "totalProcessedAmount": {
      "amountMicros": "1669000000",
      "currencyCode": "INR"
    },
    "totalFeesAmount": {
      "amountMicros": "100000000",
      "currencyCode": "INR"
    },
    "totalDirectTaxAmount": {
      "amountMicros": "100000",
      "currencyCode": "INR"
    },
    "totalWithholdingTaxAmount": {
      "amountMicros": "-1000000",
      "currencyCode": "INR"
    },
    "totalEvents": 15
  }
}

An example response looks like:


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

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/refundable-one-time-payment-code-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

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

object (ErrorResponse)

RemittanceStatementSummary

Summary object about a remittance statement.

JSON representation 
{
  "statementDate": {
    object (Timestamp)
  },
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": {
    object (Timestamp)
  },
  "totalDueByIntegrator": {
    object (Amount)
  },
  "totalEvents": integer,
  "totalProcessedAmount": {
    object (Amount)
  },
  "totalDirectTaxAmount": {
    object (Amount)
  },
  "totalFeesAmount": {
    object (Amount)
  },
  "totalWithholdingTaxAmount": {
    object (Amount)
  }
}
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 always positive.
totalEvents

integer

REQUIRED: Total number of events in this statement.
totalProcessedAmount

object (Amount)

TO_BE_REQUIRED: This value is the sum of all the event charges in this statement.
totalDirectTaxAmount

object (Amount)

OPTIONAL: This value is the sum of all direct taxes applied to all events in this statement. This value is populated for integrators on a contractual basis.
totalFeesAmount

object (Amount)

TO_BE_REQUIRED: This value is the sum of all fees applied for all events in this statement.
totalWithholdingTaxAmount

object (Amount)

OPTIONAL: This value is the total withholding tax applied for this statement. This value is populated for integrators on a contractual basis.

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

RemittanceStatementNotificationResponse

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.

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.