- HTTP request
- Request body
- Response body
- FeeToVATModification
- AcceptRemittanceStatementWithModificationsResponse
- AcceptRemittanceStatementWithModificationsResultCode
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 endpoint encounters an error while processing the request, the response from this endpoint will be of type ErrorResponse
.
Responses to this query may be empty if this method does not return an HTTP 200. The response body is 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 an HTTP 404 with an empty body. If the request signature could be verified, additional information regarding the error will be returned in the response 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://vgw.googleapis.com/gsp/refundable-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 |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
paymentIntegratorAccountId |
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this statement. |
statementId |
REQUIRED: Request ID of the statement notification this request modifies. |
Union field
|
|
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 | |
HTTP 4XX / 5XX Status |
|
FeeToVATModification
This object provides tax modifications to be applied to remittance statements.
JSON representation |
---|
{ "vatToFeeRatioInMicros": string } |
Fields | |
---|---|
vatToFeeRatioInMicros |
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:
|
AcceptRemittanceStatementWithModificationsResponse
Response object for the acceptRemittanceStatementWithModifications
method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"acceptRemittanceStatementWithModificationsResultCode": enum ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
acceptRemittanceStatementWithModificationsResultCode |
REQUIRED: Result of the refundable-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. |