Method: acceptRemittanceStatementWithModifications

Tells Google that the statement indicated in this request will be paid after modifications are made to the statement such as fee to VAT reclassification.

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 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": "0123434-abc",
    "requestTimestamp": "1502545413098"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "statementId": "0123434-statement-abc",
  "feeToVatModification": {
    "vatToFeeRatioInMicros": "150000"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": "1519996752221"
  },
  "acceptRemittanceStatementWithModificationsResultCode": "SUCCESS"
}

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "feeToVatModification": {
    object (FeeToVATModification)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorAccountId

string

REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this statement.

statementId

string

REQUIRED: Request ID of the statement notification this request modifies.

feeToVatModification

object (FeeToVATModification)

REQUIRED: Requested modification to reattribute a portion of fees to value-added-tax (VAT).

Response body

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

Response object for the acceptRemittanceStatementWithModifications method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "acceptRemittanceStatementWithModificationsResultCode": enum (AcceptRemittanceStatementWithModificationsResultCode)
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

acceptRemittanceStatementWithModificationsResultCode

enum (AcceptRemittanceStatementWithModificationsResultCode)

REQUIRED: Result of the v1.acceptRemittanceStatement call.

FeeToVATModification

This object provides tax modifications to be applied to remittance statements.

JSON representation
{
  "vatToFeeRatioInMicros": string
}
Fields
vatToFeeRatioInMicros

string (Int64Value format)

REQUIRED: Ratio of VAT to Fee amount in micros. This is the percentage of the fees to reattribute to VAT and must be greater than or equal to zero. Rounding should be "half even" or "banker's" rounding, meaning round to the even neighbor in the case that both numbers are equidistant. For example: 2.5 -> 2, 5.5 -> 6

AcceptRemittanceStatementWithModificationsResultCode

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS Remittance statement accepted with modifications successfully.
INVALID_VAT_MODIFICATION The VAT modification was not accepted due to an invalid request.