Google Standard Payments Payment Integrator Hosted e-Wallets API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators for e-Wallets.
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:
https://www.integratorhost.example.com/integrator-base-path
| Methods |
associateAccount |
POST /e-wallets-v1/associateAccount
Associates the customer's account with the payment processor to the Google instrument being added. |
asynchronousCapture |
POST /e-wallets-v1/asynchronousCapture
Triggers the start of a money movement operation between a customer's account and the integrator. |
authenticateIdentity |
POST /e-wallets-v1/authenticateIdentity
Authenticates a user's account using data about the user's Google account and current context. |
cancelFundsReservation |
POST /e-wallets-v1/cancelFundsReservation
Initiates canceling the funds that were reserved by a reserveFunds call. |
cancelMandate |
POST /e-wallets-v1/cancelMandate
Initiates a mandate cancellation on the user's account with the integrator. |
capture |
POST /e-wallets-v1/capture
Initiates money movement between a customer's account held with Google and the payment processor. |
captureFundsReservation |
POST /e-wallets-v1/captureFundsReservation
Initiates a capture of the funds reserved by a reserveFunds call. |
defendChargeback |
POST /e-wallets-v1/defendChargeback
This method is called by Google to defend an Inquiry or a Chargeback. |
echo |
POST /e-wallets-v1/echo
Echos back the clientMessage that is passed in. |
getBalanceAndLimits |
POST /e-wallets-v1/getBalanceAndLimits
Initiates a request for the current account balance associated with the association ID provided in the request. |
getTransferFundsTransactionStatus |
POST /e-wallets-v1/getTransferFundsTransactionStatus
This method fetches the status of a TransferFunds transaction. |
refreshToken |
POST /e-wallets-v1/refreshToken
Refreshes a payment token's expiration date. |
refund |
POST /e-wallets-v1/refund
Refunds a portion of or the entire transaction initiated through capture. |
remittanceStatementNotification |
POST /e-wallets-v1/remittanceStatementNotification
Notifies the integrator of a new remittance statement. |
reserveFunds |
POST /e-wallets-v1/reserveFunds
Reserve funds on a token. |
sendOtp |
POST /e-wallets-v1/sendOtp
Requests the integrator send an OTP to the phone number. |
simulatePayment |
POST /e-wallets-v1/simulatePayment
Initiates a request to simulate a payment from an account associated by the association ID for a given amount provided in the request. |
transferFunds |
POST /e-wallets-v1/transferFunds
Initiates money movement between a customer's account held with Google and the payment processor. |
upcomingTransactionNotification |
POST /e-wallets-v1/upcomingTransactionNotification
Requests the integrator notify the user of an upcoming transaction for a recurring mandate. |
verifyOtp |
POST /e-wallets-v1/verifyOtp
Verifies an OTP value was sent by the integrator for the account. |
| Methods |
create |
POST /e-wallets-v1/createMandate
Initiates a mandate creation on the user's account with the integrator. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-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-07-28 UTC."],[[["\u003cp\u003eThis service enables e-Wallet functionalities for payment integrators, including features like associating accounts, capturing funds, and managing mandates.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers are encouraged to utilize Google-provided client libraries for seamless integration with this service.\u003c/p\u003e\n"],["\u003cp\u003eIf using custom libraries, the service endpoint is \u003ccode\u003ehttps://www.integratorhost.example.com/integrator-base-path\u003c/code\u003e and a discovery document is available.\u003c/p\u003e\n"],["\u003cp\u003eA comprehensive set of REST resources are provided for various e-Wallet operations, such as \u003ccode\u003eassociateAccount\u003c/code\u003e, \u003ccode\u003ecapture\u003c/code\u003e, and \u003ccode\u003ecreateMandate\u003c/code\u003e, each with specific functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThe service supports essential actions like reserving funds, initiating refunds, and handling transaction notifications.\u003c/p\u003e\n"]]],["This service provides API methods for payment integrators managing e-wallets. Key actions include associating customer accounts, capturing funds, and managing mandates. Other methods allow for identity authentication, reserving and canceling funds, initiating refunds, and checking transaction statuses. Integrators can also simulate transfers, refresh tokens, and request OTPs. The service offers a Discovery Document and a service endpoint for API interaction, and the use of client libraries is recommended.\n"],null,["This includes services hosted by Payment Integrators for e-Wallets.\n\n- [REST Resource: integrator-base-path.e-wallets-v1](#integrator-base-path.e-wallets-v1)\n- [REST Resource: integrator-base-path.e-wallets-v1.createMandate](#integrator-base-path.e-wallets-v1.createMandate)\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\nDiscovery 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/e-wallets-v1/payment-integrator-e-wallets-api/open-api-spec.json](/static/pay/e-wallets-v1/payment-integrator-e-wallets-api/open-api-spec.json)\n\nService 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- `https://www.integratorhost.example.com/integrator-base-path`\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [associateAccount](/pay/e-wallets-v1/payment-integrator-e-wallets-api/associateAccount) | `POST /e-wallets-v1/associateAccount` Associates the customer's account with the payment processor to the Google instrument being added. |\n| [asynchronousCapture](/pay/e-wallets-v1/payment-integrator-e-wallets-api/asynchronousCapture) | `POST /e-wallets-v1/asynchronousCapture` Triggers the start of a money movement operation between a customer's account and the integrator. |\n| [authenticateIdentity](/pay/e-wallets-v1/payment-integrator-e-wallets-api/authenticateIdentity) | `POST /e-wallets-v1/authenticateIdentity` Authenticates a user's account using data about the user's Google account and current context. |\n| [cancelFundsReservation](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelFundsReservation) | `POST /e-wallets-v1/cancelFundsReservation` Initiates canceling the funds that were reserved by a `reserveFunds` call. |\n| [cancelMandate](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelMandate) | `POST /e-wallets-v1/cancelMandate` Initiates a mandate cancellation on the user's account with the integrator. |\n| [capture](/pay/e-wallets-v1/payment-integrator-e-wallets-api/capture) | `POST /e-wallets-v1/capture` Initiates money movement between a customer's account held with Google and the payment processor. |\n| [captureFundsReservation](/pay/e-wallets-v1/payment-integrator-e-wallets-api/captureFundsReservation) | `POST /e-wallets-v1/captureFundsReservation` Initiates a capture of the funds reserved by a `reserveFunds` call. |\n| [echo](/pay/e-wallets-v1/payment-integrator-e-wallets-api/echo) | `POST /e-wallets-v1/echo` Echos back the `clientMessage` that is passed in. |\n| [getBalanceAndLimits](/pay/e-wallets-v1/payment-integrator-e-wallets-api/getBalanceAndLimits) | `POST /e-wallets-v1/getBalanceAndLimits` Initiates a request for the current account balance associated with the association ID provided in the request. |\n| [getTransferFundsTransactionStatus](/pay/e-wallets-v1/payment-integrator-e-wallets-api/getTransferFundsTransactionStatus) | `POST /e-wallets-v1/getTransferFundsTransactionStatus` This method fetches the status of a TransferFunds transaction. |\n| [refreshToken](/pay/e-wallets-v1/payment-integrator-e-wallets-api/refreshToken) | `POST /e-wallets-v1/refreshToken` Refreshes a payment token's expiration date. |\n| [refund](/pay/e-wallets-v1/payment-integrator-e-wallets-api/refund) | `POST /e-wallets-v1/refund` Refunds a portion of or the entire transaction initiated through `capture`. |\n| [remittanceStatementNotification](/pay/e-wallets-v1/payment-integrator-e-wallets-api/remittanceStatementNotification) | `POST /e-wallets-v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |\n| [reserveFunds](/pay/e-wallets-v1/payment-integrator-e-wallets-api/reserveFunds) | `POST /e-wallets-v1/reserveFunds` Reserve funds on a token. |\n| [sendOtp](/pay/e-wallets-v1/payment-integrator-e-wallets-api/sendOtp) | `POST /e-wallets-v1/sendOtp` Requests the integrator send an OTP to the phone number. |\n| [simulatePayment](/pay/e-wallets-v1/payment-integrator-e-wallets-api/simulatePayment) | `POST /e-wallets-v1/simulatePayment` Initiates a request to simulate a payment from an account associated by the association ID for a given amount provided in the request. |\n| [transferFunds](/pay/e-wallets-v1/payment-integrator-e-wallets-api/transferFunds) | `POST /e-wallets-v1/transferFunds` Initiates money movement between a customer's account held with Google and the payment processor. |\n| [upcomingTransactionNotification](/pay/e-wallets-v1/payment-integrator-e-wallets-api/upcomingTransactionNotification) | `POST /e-wallets-v1/upcomingTransactionNotification` Requests the integrator notify the user of an upcoming transaction for a recurring mandate. |\n| [verifyOtp](/pay/e-wallets-v1/payment-integrator-e-wallets-api/verifyOtp) | `POST /e-wallets-v1/verifyOtp` Verifies an OTP value was sent by the integrator for the account. |\n\n| Methods ||\n|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|\n| [create](/pay/e-wallets-v1/payment-integrator-e-wallets-api/createMandate) | `POST /e-wallets-v1/createMandate` Initiates a mandate creation on the user's account with the integrator. |"]]