Method: acceptRemittanceStatement
Stay organized with collections
Save and categorize content based on your preferences.
Tells Google that the statement indicated in this request will be paid.
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"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1519996752221"
},
"acceptRemittanceStatementResultCode": "SUCCESS"
}
HTTP request
POST https://vgw.googleapis.com/gsp/one-time-payment-code-v1/acceptRemittanceStatement/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
{
"requestHeader": {
object (RequestHeader)
},
"paymentIntegratorAccountId": string,
"statementId": string
} |
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.
|
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 (AcceptRemittanceStatementResponse )
|
HTTP 4XX / 5XX Status |
object (ErrorResponse)
|
AcceptRemittanceStatementResponse
Response object for the acceptRemittanceStatement
method.
AcceptRemittanceStatementResultCode
Result codes for the acceptRemittanceStatement
method.
Enums |
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
Remittance statement accepted successfully |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-29 UTC."],[[["\u003cp\u003eThis endpoint is used to inform Google that a specific statement will be paid.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an HTTP 200 response with an \u003ccode\u003eAcceptRemittanceStatementResponse\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eError scenarios result in HTTP 4xx or 5xx responses, potentially with an \u003ccode\u003eErrorResponse\u003c/code\u003e object or a generic error message for security reasons.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires \u003ccode\u003erequestHeader\u003c/code\u003e, \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e, and \u003ccode\u003estatementId\u003c/code\u003e fields.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAcceptRemittanceStatementResultCode\u003c/code\u003e indicates the outcome of the operation, with \u003ccode\u003eSUCCESS\u003c/code\u003e signaling successful acceptance of the remittance statement.\u003c/p\u003e\n"]]],["This API endpoint, via a POST request, informs Google that a specified statement will be paid. The request body requires `requestHeader`, `paymentIntegratorAccountId`, and `statementId`. Upon success, a 200 HTTP status is returned with a response body containing `responseHeader` and `acceptRemittanceStatementResultCode` which will indicate `SUCCESS`. Errors result in 4xx or 5xx HTTP codes, with either an `ErrorResponse` or a generic error. The `AcceptRemittanceStatementResultCode` enum can be either `UNKNOWN_RESULT` or `SUCCESS`.\n"],null,["# Method: acceptRemittanceStatement\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [AcceptRemittanceStatementResponse](#AcceptRemittanceStatementResponse)\n - [JSON representation](#AcceptRemittanceStatementResponse.SCHEMA_REPRESENTATION)\n- [AcceptRemittanceStatementResultCode](#AcceptRemittanceStatementResultCode)\n\nTells Google that the statement indicated in this request will be paid.\n\nIf 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`](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ErrorResponse) or contain a generic error (e.g. a message similar to \"There was an error. Please try again later.\").\n\nThe generic error is used in situations where an [`ErrorResponse`](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/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`](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ErrorResponse).\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1,\n \"minor\": 0,\n \"revision\": 0\n },\n \"requestId\": \"0123434-abc\",\n \"requestTimestamp\": \"1502545413098\"\n },\n \"paymentIntegratorAccountId\": \"InvisiCashUSA_USD\",\n \"statementId\": \"0123434-statement-abc\"\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1519996752221\"\n },\n \"acceptRemittanceStatementResultCode\": \"SUCCESS\"\n }\n\n### HTTP request\n\n`POST https://vgw.googleapis.com/gsp/one-time-payment-code-v1/acceptRemittanceStatement/`[:PIAID](/pay/one-time-payment-code-v1/reference/glossary#payment_integrator_account_id)\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/RequestHeader) }, \"paymentIntegratorAccountId\": string, \"statementId\": string } ``` |\n\n| Fields ||\n|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: This is the payment integrator account identifier that identifies contractual constraints around this statement. |\n| `statementId` | `string` **REQUIRED**: Request ID of the statement notification. |\n\n### Response body\n\nThis 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](/pay/one-time-payment-code-v1/guides/connectivity/protocol-standards#http_status_codes).\n\n| Possible response messages ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| HTTP 200 Status | `object (`[AcceptRemittanceStatementResponse](/pay/one-time-payment-code-v1/google-one-time-payment-code-api/acceptRemittanceStatement#AcceptRemittanceStatementResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ErrorResponse)`)` |\n\nAcceptRemittanceStatementResponse\n---------------------------------\n\nResponse object for the `acceptRemittanceStatement` method.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ResponseHeader) }, \"acceptRemittanceStatementResultCode\": enum (/pay/one-time-payment-code-v1/google-one-time-payment-code-api/acceptRemittanceStatement#AcceptRemittanceStatementResultCode) } ``` |\n\n| Fields ||\n|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `acceptRemittanceStatementResultCode` | `enum (`[AcceptRemittanceStatementResultCode](/pay/one-time-payment-code-v1/google-one-time-payment-code-api/acceptRemittanceStatement#AcceptRemittanceStatementResultCode)`)` **REQUIRED**: Result of the one-time-payment-code-v1.acceptRemittanceStatement call. |\n\nAcceptRemittanceStatementResultCode\n-----------------------------------\n\nResult codes for the `acceptRemittanceStatement` method.\n\n| Enums ||\n|------------------|--------------------------------------------|\n| `UNKNOWN_RESULT` | Do not ever set this default value! |\n| `SUCCESS` | Remittance statement accepted successfully |"]]