Google Standard Payments Google Hosted Carriers API

  • Google provides RESTful services for Carriers, accessible via Google-provided client libraries or by directly using the service endpoints and discovery document.

  • Carriers can leverage these APIs to manage financial interactions, such as accepting remittance statements, handling fraud notifications, and updating user accounts.

  • The service offers a variety of methods to facilitate communication and transactions, including dispute inquiry reports and authentication result notifications.

  • Service endpoints for production and sandbox environments are provided, allowing carriers to test integrations before deployment.

  • All API requests should be directed to the respective service endpoint with the appropriate Payment Integrator Account ID.

This includes services hosted by Google for Carriers.

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming Google Standard Payments APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • Prod: https://vgw.googleapis.com/gsp
  • Sandbox: https://vgw.sandbox.google.com/gsp
Methods
acceptRemittanceStatement POST /carriers-v1/acceptRemittanceStatement/:PIAID
Tells Google that the statement indicated in this request will be paid.
authenticationResultNotification POST /carriers-v1/authenticationResultNotification/:PIAID
Completes an authentication request that was triggered by Google in a different context that cannot receive a synchronous response from the vendor.
echo POST /carriers-v1/echo/:PIAID
Echos back a string sent from the client.
fraudNotification POST /carriers-v1/fraudNotification/:PIAID
Notifies Google of a fraud dispute initiated by a customer.
getDisputeInquiryReport POST /carriers-v1/getDisputeInquiryReport/:PIAID
Get a report that provides information to facilitate a customer support conversation with a user regarding a potential dispute of a payment.
remittanceStatementDetails POST /carriers-v1/remittanceStatementDetails/:PIAID
Returns transaction detail information about a remittance statement.
updateAssociatedAccount POST /carriers-v1/updateAssociatedAccount/:PIAID
Requests an update to an associated user account.