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 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"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1519996752221"
},
"acceptRemittanceStatementResultCode": "SUCCESS"
}
HTTP request
POST https://vgw.googleapis.com/secure-serving/gsp/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
Response object for the acceptRemittanceStatement
method.
If successful, the response body contains data with the following structure:
Fields |
responseHeader |
object (ResponseHeader )
REQUIRED: Common header for all responses.
|
acceptRemittanceStatementResultCode |
enum (AcceptRemittanceStatementResultCode )
REQUIRED: Result of the v1.acceptRemittanceStatement call.
|
AcceptRemittanceStatementResultCode
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 2024-09-03 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 2024-09-03 UTC."],[[["\u003cp\u003eThis endpoint enables Google to recognize a statement as paid, specifically the one indicated in the request.\u003c/p\u003e\n"],["\u003cp\u003eUpon error, the endpoint responds with an \u003ccode\u003eErrorResponse\u003c/code\u003e object, with empty responses possible to prevent information leakage.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes essential information like request header, payment integrator account ID, and statement ID.\u003c/p\u003e\n"],["\u003cp\u003eThe response, upon success, includes a response header and a result code signifying acceptance status.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAcceptRemittanceStatementResultCode\u003c/code\u003e signifies the result, with \u003ccode\u003eSUCCESS\u003c/code\u003e indicating successful acceptance of the remittance statement.\u003c/p\u003e\n"]]],["This document details how to notify Google that a payment statement will be paid via the `acceptRemittanceStatement` method. A `POST` HTTP request is sent to a specified URL, including a request body with a `requestHeader`, `paymentIntegratorAccountId`, and `statementId`. Successful requests return a response body with a `responseHeader` and an `acceptRemittanceStatementResultCode`, indicating success or `UNKNOWN_RESULT`. Errors may yield an `ErrorResponse` or an empty response body with an HTTP 404 status.\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 - [JSON representation](#body.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 response from this endpoint will be of type [`ErrorResponse`](/standard-payments/payment-update-service-api/v1/ErrorResponse).\n\nResponses 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`](/standard-payments/payment-update-service-api/v1/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.\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/secure-serving/gsp/v1/acceptRemittanceStatement/`[:PIAID](/standard-payments/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 (/standard-payments/payment-update-service-api/v1/RequestHeader) }, \"paymentIntegratorAccountId\": string, \"statementId\": string } ``` |\n\n| Fields ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/standard-payments/payment-update-service-api/v1/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\nResponse object for the `acceptRemittanceStatement` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/standard-payments/payment-update-service-api/v1/ResponseHeader) }, \"acceptRemittanceStatementResultCode\": enum (/standard-payments/payment-update-service-api/v1/TopLevel/acceptRemittanceStatement#AcceptRemittanceStatementResultCode) } ``` |\n\n| Fields ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/standard-payments/payment-update-service-api/v1/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `acceptRemittanceStatementResultCode` | `enum (`[AcceptRemittanceStatementResultCode](/standard-payments/payment-update-service-api/v1/TopLevel/acceptRemittanceStatement#AcceptRemittanceStatementResultCode)`)` **REQUIRED**: Result of the v1.acceptRemittanceStatement call. |\n\nAcceptRemittanceStatementResultCode\n-----------------------------------\n\n| Enums ||\n|------------------|--------------------------------------------|\n| `UNKNOWN_RESULT` | Do not ever set this default value! |\n| `SUCCESS` | Remittance statement accepted successfully |"]]