Method: acceptRemittanceStatement

Tells Google that the statement indicated in this request will be paid.

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
    },
    "requestId": "0123434-abc",
    "requestTimestamp": {
      "epochMillis": "1502545413098"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "statementId": "0123434-statement-abc"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1519996752221"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://vgw.googleapis.com/gsp/carriers-v1/acceptRemittanceStatement/:PIAID

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.
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.

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (AcceptRemittanceStatementResult)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (AcceptRemittanceStatementResult)

REQUIRED: Result of the carriers-v1.acceptRemittanceStatement call.

AcceptRemittanceStatementResult

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields

Union field result.

result can be only one of the following:
success

object (Empty)

Remittance statement accepted successfully