Google Standard Payments Google Hosted Carrier Wallets API

  • Google provides a suite of RESTful APIs, collectively known as Carrier Wallets, enabling carriers to integrate with Google's payment services.

  • These APIs, documented with a Discovery Document and accessible via specific service endpoints, allow carriers to manage transactions, handle disputes, and interact with customer accounts.

  • Google recommends using their client libraries to interact with these APIs; however, direct API calls are supported using provided specifications.

  • The Carrier Wallets APIs provide several methods, including authenticationResultNotification, captureResultNotification, and fraudNotification, for managing the payment lifecycle.

  • Carriers can access both production and sandbox environments for testing and deployment purposes using distinct service endpoints.

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 /carrier-wallets-v1/acceptRemittanceStatement/:PIAID
Tells Google that the statement indicated in this request will be paid.
authenticationResultNotification POST /carrier-wallets-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.
captureResultNotification POST /carrier-wallets-v1/captureResultNotification/:PIAID
Notify Google of the result of a capture after a capture or asynchronousCapture method call has been made.
echo POST /carrier-wallets-v1/echo/:PIAID
Echos back a string sent from the client.
fraudNotification POST /carrier-wallets-v1/fraudNotification/:PIAID
Notifies Google of a fraud dispute initiated by a customer.
getDisputeInquiryReport POST /carrier-wallets-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 /carrier-wallets-v1/remittanceStatementDetails/:PIAID
Returns transaction detail information about a remittance statement.
updateAssociatedAccount POST /carrier-wallets-v1/updateAssociatedAccount/:PIAID
Requests an update to an associated user account.