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.

If the echo is successful, the endpoint will return an HTTP 200 and the response will be of type EchoResponse.

If the endpoint encounters an error while processing the request, the endpoint will return HTTP 4xx or 5xx and the HTTP body will either be of type ErrorResponse or contain a generic error (e.g. a message similar to "There was an error. Please try again later.").

The generic error is used 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 generic error. If the request signature could be verified, additional information regarding the error will be returned in an ErrorResponse.

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://vgw.googleapis.com/gsp/one-time-payment-code-v1/acceptRemittanceStatementWithModifications/:PIAID

Request body

The request body contains data with the following structure:

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

  // Union field modification_type can be only one of the following:
  "feeToVatModification": {
    object (FeeToVATModification)
  }
  // End of list of possible types for union field modification_type.
}
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.

Union field modification_type.

modification_type can be only one of the following:
feeToVatModification

object (FeeToVATModification)

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

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

object (ErrorResponse)

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 (e.g. 2.5 -> 2, 5.5 -> 6).

A sample for calculating tax is as follows:

  • Tax-inclusive processing fee collected by payment integrator: 1000 USD
  • Tax rate: 10%
  • Thus, 1000 USD = (processing fee) + (10% * processing fee)
  • Processing fee (sans tax) = 1000 / 1.1 = 909.090909 USD
  • Tax paid by payment integrator = 1000 - 909.090909 = 90.909091 USD
  • vatToFeeRatioInMicros = (90.909091 / 1000) * 1000000 = 90909.091
  • Half-even rounding on 90909.091 = 90909

AcceptRemittanceStatementWithModificationsResponse

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 one-time-payment-code-v1.acceptRemittanceStatement call.

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.