Google Standard Payments Payment Integrator Hosted Redirect Payment Token API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators for Redirect Payment Tokens
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 |
cancelFundsReservation |
POST /redirect-payment-token-v1/cancelFundsReservation
Initiates canceling the funds that were reserved by a reserveFunds call. |
captureFundsReservation |
POST /redirect-payment-token-v1/captureFundsReservation
Initiates a capture of the funds reserved by a reserveFunds call. |
echo |
POST /redirect-payment-token-v1/echo
Echos back the clientMessage that is passed in. |
getGeneratePaymentTokenRedirectStatus |
POST /redirect-payment-token-v1/getGeneratePaymentTokenRedirectStatus
Get completion details about a specific redirect payment. |
refund |
POST /redirect-payment-token-v1/refund
Refunds a portion of or the entire transaction initiated through capture. |
remittanceStatementNotification |
POST /redirect-payment-token-v1/remittanceStatementNotification
Notifies the integrator of a new remittance statement. |
reserveFunds |
POST /redirect-payment-token-v1/reserveFunds
Reserve funds on a token. |
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 Redirect Payment Token API, hosted by Payment Integrators, for managing payment-related operations.\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for using this service, but the documentation also provides necessary information for using custom libraries.\u003c/p\u003e\n"],["\u003cp\u003eA machine-readable Discovery Document and service endpoint are available for developers to understand and interact with the API.\u003c/p\u003e\n"],["\u003cp\u003eThe service offers various methods for payment operations like reserving, capturing, canceling funds, and handling refunds.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the provided service endpoint and method paths to integrate with the Redirect Payment Token API for their applications.\u003c/p\u003e\n"]]],["Payment Integrators host services for Redirect Payment Tokens, accessible via a REST resource. The service utilizes a discovery document and a specific service endpoint: `https://www.integratorhost.example.com/integrator-base-path`. Key actions include `cancelFundsReservation`, `captureFundsReservation`, `refund`, and `reserveFunds`, all initiated via POST requests. Other methods allow checking the `getGeneratePaymentTokenRedirectStatus`, the `remittanceStatementNotification`, and `echo`. Google-provided client libraries are recommended for interacting with the API.\n"],null,["# Google Standard Payments Payment Integrator Hosted Redirect Payment Token API\n\nThis includes services hosted by Payment Integrators for Redirect Payment Tokens\n\n- [REST Resource: integrator-base-path.redirect-payment-token-v1](#integrator-base-path.redirect-payment-token-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-payment-token-v1/payment-integrator-redirect-payment-token-api/open-api-spec.json](/static/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-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| [cancelFundsReservation](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/cancelFundsReservation) | `POST /redirect-payment-token-v1/cancelFundsReservation` Initiates canceling the funds that were reserved by a `reserveFunds` call. |\n| [captureFundsReservation](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/captureFundsReservation) | `POST /redirect-payment-token-v1/captureFundsReservation` Initiates a capture of the funds reserved by a `reserveFunds` call. |\n| [echo](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/echo) | `POST /redirect-payment-token-v1/echo` Echos back the `clientMessage` that is passed in. |\n| [getGeneratePaymentTokenRedirectStatus](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/getGeneratePaymentTokenRedirectStatus) | `POST /redirect-payment-token-v1/getGeneratePaymentTokenRedirectStatus` Get completion details about a specific redirect payment. |\n| [refund](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/refund) | `POST /redirect-payment-token-v1/refund` Refunds a portion of or the entire transaction initiated through `capture`. |\n| [remittanceStatementNotification](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/remittanceStatementNotification) | `POST /redirect-payment-token-v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |\n| [reserveFunds](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/reserveFunds) | `POST /redirect-payment-token-v1/reserveFunds` Reserve funds on a token. |"]]