Google Standard Payments Google Hosted Carrier Wallets API
Stay organized with collections
Save and categorize content based on your preferences.
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. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 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 2025-02-28 UTC."],[[["\u003cp\u003eGoogle provides a suite of RESTful APIs, collectively known as Carrier Wallets, enabling carriers to integrate with Google's payment services.\u003c/p\u003e\n"],["\u003cp\u003eThese APIs, documented with a Discovery Document and accessible via specific service endpoints, allow carriers to manage transactions, handle disputes, and interact with customer accounts.\u003c/p\u003e\n"],["\u003cp\u003eGoogle recommends using their client libraries to interact with these APIs; however, direct API calls are supported using provided specifications.\u003c/p\u003e\n"],["\u003cp\u003eThe Carrier Wallets APIs provide several methods, including \u003ccode\u003eauthenticationResultNotification\u003c/code\u003e, \u003ccode\u003ecaptureResultNotification\u003c/code\u003e, and \u003ccode\u003efraudNotification\u003c/code\u003e, for managing the payment lifecycle.\u003c/p\u003e\n"],["\u003cp\u003eCarriers can access both production and sandbox environments for testing and deployment purposes using distinct service endpoints.\u003c/p\u003e\n"]]],["Google hosts carrier services under the `gsp.carrier-wallets-v1` resource, accessible via client libraries or custom libraries using the provided discovery document. The service endpoints are `https://vgw.googleapis.com/gsp` for production and `https://vgw.sandbox.google.com/gsp` for sandbox. Key actions include: accepting remittance statements, completing authentication, notifying capture results, echoing strings, reporting fraud, getting dispute reports, retrieving statement details, and updating associated accounts. All actions use POST requests to specific URIs.\n"],null,["# Google Standard Payments Google Hosted Carrier Wallets API\n\nThis includes services hosted by Google for Carriers.\n\n- [REST Resource: gsp.carrier-wallets-v1](#gsp.carrier-wallets-v1)\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- [/pay/carrier-wallets-v1/google-carrier-wallets-api/open-api-spec.json](/static/pay/carrier-wallets-v1/google-carrier-wallets-api/open-api-spec.json)\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- Prod: `https://vgw.googleapis.com/gsp`\n- Sandbox: `https://vgw.sandbox.google.com/gsp`\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [acceptRemittanceStatement](/pay/carrier-wallets-v1/google-carrier-wallets-api/acceptRemittanceStatement) | `POST /carrier-wallets-v1/acceptRemittanceStatement/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Tells Google that the statement indicated in this request will be paid. |\n| [authenticationResultNotification](/pay/carrier-wallets-v1/google-carrier-wallets-api/authenticationResultNotification) | `POST /carrier-wallets-v1/authenticationResultNotification/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Completes an authentication request that was triggered by Google in a different context that cannot receive a synchronous response from the vendor. |\n| [captureResultNotification](/pay/carrier-wallets-v1/google-carrier-wallets-api/captureResultNotification) | `POST /carrier-wallets-v1/captureResultNotification/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Notify Google of the result of a capture after a `capture` or `asynchronousCapture` method call has been made. |\n| [echo](/pay/carrier-wallets-v1/google-carrier-wallets-api/echo) | `POST /carrier-wallets-v1/echo/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Echos back a string sent from the client. |\n| [fraudNotification](/pay/carrier-wallets-v1/google-carrier-wallets-api/fraudNotification) | `POST /carrier-wallets-v1/fraudNotification/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Notifies Google of a fraud dispute initiated by a customer. |\n| [getDisputeInquiryReport](/pay/carrier-wallets-v1/google-carrier-wallets-api/getDisputeInquiryReport) | `POST /carrier-wallets-v1/getDisputeInquiryReport/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Get a report that provides information to facilitate a customer support conversation with a user regarding a potential dispute of a payment. |\n| [remittanceStatementDetails](/pay/carrier-wallets-v1/google-carrier-wallets-api/remittanceStatementDetails) | `POST /carrier-wallets-v1/remittanceStatementDetails/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Returns transaction detail information about a remittance statement. |\n| [updateAssociatedAccount](/pay/carrier-wallets-v1/google-carrier-wallets-api/updateAssociatedAccount) | `POST /carrier-wallets-v1/updateAssociatedAccount/`[:PIAID](/pay/carrier-wallets-v1/reference/glossary#payment_integrator_account_id) Requests an update to an associated user account. |"]]