Google Standard Payments Google Hosted Redirect FOP API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Google for Redirect FOPs.
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 /redirect-fop-v1/acceptRemittanceStatement/:PIAID
Tells Google that the statement indicated in this request will be paid. |
acceptRemittanceStatementWithModifications |
POST /redirect-fop-v1/acceptRemittanceStatementWithModifications/:PIAID
Tells Google that the statement indicated in this request will be paid after modifications are made to the statement such as fee to VAT reclassification. |
echo |
POST /v1/echo/:PIAID
Echos back a string sent from the client. |
redirectPaymentCompleteNotification |
POST /redirect-fop-v1/redirectPaymentCompleteNotification/:PIAID
Notify Google of the status of a redirect payment. |
refundResultNotification |
POST /redirect-fop-v1/refundResultNotification/:PIAID
Notify Google of the result of a refund after an asynchronousRefund method call has been made. |
remittanceStatementDetails |
POST /redirect-fop-v1/remittanceStatementDetails/:PIAID
Returns transaction detail information about a remittance statement. |
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 hosts services for Redirect FOPs, accessible through Google-provided client libraries or by using the provided service endpoints and discovery document.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoints for Redirect FOPs are \u003ccode\u003ehttps://vgw.googleapis.com/gsp\u003c/code\u003e for production and \u003ccode\u003ehttps://vgw.sandbox.google.com/gsp\u003c/code\u003e for sandbox environments.\u003c/p\u003e\n"],["\u003cp\u003eA discovery document, located at \u003ccode\u003e/pay/redirect-fop-v1/google-redirect-fop-api/open-api-spec.json\u003c/code\u003e, provides a machine-readable specification for interacting with these APIs.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are available within the Redirect FOPs service, including accepting remittance statements, handling payment notifications, and managing refunds, each with its own specific endpoint and functionality.\u003c/p\u003e\n"]]],["Google hosts services for Redirect FOPs, accessible via REST resources. To interact, use Google-provided client libraries or custom libraries with the provided discovery document. The service offers both production (`https://vgw.googleapis.com/gsp`) and sandbox (`https://vgw.sandbox.google.com/gsp`) endpoints. Key methods include: notifying Google about statement payments (with/without modifications), echoing client strings, reporting redirect payment status, conveying refund results, and fetching remittance statement details. All the methods use POST.\n"],null,["This includes services hosted by Google for Redirect FOPs.\n\n- [REST Resource: gsp.redirect-fop-v1](#gsp.redirect-fop-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\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/redirect-fop-v1/google-redirect-fop-api/open-api-spec.json](/static/pay/redirect-fop-v1/google-redirect-fop-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- Prod: `https://vgw.googleapis.com/gsp`\n- Sandbox: `https://vgw.sandbox.google.com/gsp`\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [acceptRemittanceStatement](/pay/redirect-fop-v1/google-redirect-fop-api/acceptRemittanceStatement) | `POST /redirect-fop-v1/acceptRemittanceStatement/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Tells Google that the statement indicated in this request will be paid. |\n| [acceptRemittanceStatementWithModifications](/pay/redirect-fop-v1/google-redirect-fop-api/acceptRemittanceStatementWithModifications) | `POST /redirect-fop-v1/acceptRemittanceStatementWithModifications/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Tells Google that the statement indicated in this request will be paid after modifications are made to the statement such as fee to VAT reclassification. |\n| [echo](/pay/redirect-fop-v1/google-redirect-fop-api/echo) | `POST /v1/echo/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Echos back a string sent from the client. |\n| [redirectPaymentCompleteNotification](/pay/redirect-fop-v1/google-redirect-fop-api/redirectPaymentCompleteNotification) | `POST /redirect-fop-v1/redirectPaymentCompleteNotification/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Notify Google of the status of a redirect payment. |\n| [refundResultNotification](/pay/redirect-fop-v1/google-redirect-fop-api/refundResultNotification) | `POST /redirect-fop-v1/refundResultNotification/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Notify Google of the result of a refund after an `asynchronousRefund` method call has been made. |\n| [remittanceStatementDetails](/pay/redirect-fop-v1/google-redirect-fop-api/remittanceStatementDetails) | `POST /redirect-fop-v1/remittanceStatementDetails/`[:PIAID](/pay/redirect-fop-v1/reference/glossary#payment_integrator_account_id) Returns transaction detail information about a remittance statement. |"]]