Method: gsp.refundable-one-time-payment-code-v1.acceptRemittanceStatement

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/gsp/refundable-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

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

Response object for the acceptRemittanceStatement method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "acceptRemittanceStatementResultCode": enum (AcceptRemittanceStatementResultCode)
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

acceptRemittanceStatementResultCode

enum (AcceptRemittanceStatementResultCode)

REQUIRED: Result of the refundable-one-time-payment-code-v1.acceptRemittanceStatement call.

AcceptRemittanceStatementResultCode

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS Remittance statement accepted successfully