Google Standard Payments Payment Integrator Hosted Redirect FOP API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators 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:
https://www.integratorhost.example.com/integrator-base-path
Methods |
asynchronousRefund |
POST /v1/payment-integrator-redirect/asynchronousRefund
Refunds a portion of or the entire redirect payment. |
echo |
POST /v1/echo
Echos back a string sent from the client. |
generateRedirectPaymentUrl |
POST /v1/payment-integrator-redirect/generateRedirectPaymentUrl
Provides basic information about this transaction to allow the integrator to create a redirect URL. |
getRedirectPaymentStatus |
POST /v1/payment-integrator-redirect/getRedirectPaymentStatus
Get completion details about a specific redirect payment. |
remittanceStatementNotification |
POST /v1/remittanceStatementNotification
Notifies the integrator of a new 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\u003eThis documentation outlines the services hosted by Payment Integrators for Redirect First Out of Pocket (FOPs).\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for interacting with these services.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the provided discovery document and service endpoint for custom integrations.\u003c/p\u003e\n"],["\u003cp\u003eKey functionalities include refunding payments, generating redirect URLs, and retrieving payment status.\u003c/p\u003e\n"],["\u003cp\u003eIntegrators receive notifications for remittance statements and can leverage an echo service for testing purposes.\u003c/p\u003e\n"]]],["Payment Integrators host redirect FOP services accessed via the `integrator-base-path.redirect-fop-v1` REST resource, with a service endpoint at `https://www.integratorhost.example.com/integrator-base-path`. Key actions include: `asynchronousRefund` to refund payments, `generateRedirectPaymentUrl` to create redirect URLs, `getRedirectPaymentStatus` to check payment details, `echo` to send back string from the client and `remittanceStatementNotification` to alert of new remittance statement. The service's machine-readable specification is available in the provided Discovery Document.\n"],null,["# Google Standard Payments Payment Integrator Hosted Redirect FOP API\n\nThis includes services hosted by Payment Integrators for Redirect FOPs.\n\n- [REST Resource: integrator-base-path.redirect-fop-v1](#integrator-base-path.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\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/redirect-fop-v1/payment-integrator-redirect-fop-api/open-api-spec.json](/static/pay/redirect-fop-v1/payment-integrator-redirect-fop-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- `https://www.integratorhost.example.com/integrator-base-path`\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [asynchronousRefund](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/asynchronousRefund) | `POST /v1/payment-integrator-redirect/asynchronousRefund` Refunds a portion of or the entire redirect payment. |\n| [echo](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/echo) | `POST /v1/echo` Echos back a string sent from the client. |\n| [generateRedirectPaymentUrl](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/generateRedirectPaymentUrl) | `POST /v1/payment-integrator-redirect/generateRedirectPaymentUrl` Provides basic information about this transaction to allow the integrator to create a redirect URL. |\n| [getRedirectPaymentStatus](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/getRedirectPaymentStatus) | `POST /v1/payment-integrator-redirect/getRedirectPaymentStatus` Get completion details about a specific redirect payment. |\n| [remittanceStatementNotification](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/remittanceStatementNotification) | `POST /v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |"]]