Google Standard Payments Payment Integrator Hosted One Time Payment Codes API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators for One Time Payment Codes.
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 |
cancelReferenceNumber |
POST /one-time-payment-code-v1/cancelReferenceNumber
Cancels a reference number by invalidating it in the integrators system and preventing future payments. |
echo |
POST /one-time-payment-code-v1/echo
Echos back the clientMessage that is passed in. |
generateReferenceNumber |
POST /one-time-payment-code-v1/generateReferenceNumber
Creates a reference number and registers payment information (description, timestamp) with the integrator. |
remittanceStatementNotification |
POST /one-time-payment-code-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 services hosted by Payment Integrators for One Time Payment Codes, enabling functionalities like generating, canceling, and managing payment references.\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for interacting with these services, but the discovery document and service endpoint are available for custom integrations.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint \u003ccode\u003ehttps://www.integratorhost.example.com/integrator-base-path\u003c/code\u003e acts as the base URL for all API requests related to One Time Payment Codes.\u003c/p\u003e\n"],["\u003cp\u003eKey API methods include generating and canceling reference numbers, echoing client messages, and handling remittance statement notifications.\u003c/p\u003e\n"],["\u003cp\u003eA discovery document is provided for building client libraries and tools, ensuring seamless integration with Google Standard Payments APIs.\u003c/p\u003e\n"]]],["Payment Integrators host services for One Time Payment Codes, accessible via the `integrator-base-path`. API interactions can use Google's client libraries or custom ones, leveraging the provided Discovery Document. The service endpoint is `https://www.integratorhost.example.com/integrator-base-path`. Key actions include: `cancelReferenceNumber` to invalidate reference numbers, `echo` to echo back a message, `generateReferenceNumber` to create and register reference numbers, and `remittanceStatementNotification` to notify of new statements.\n"],null,["This includes services hosted by Payment Integrators for One Time Payment Codes.\n\n- [REST Resource: integrator-base-path.one-time-payment-code-v1](#integrator-base-path.one-time-payment-code-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/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/open-api-spec.json](/static/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-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| [cancelReferenceNumber](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/cancelReferenceNumber) | `POST /one-time-payment-code-v1/cancelReferenceNumber` Cancels a reference number by invalidating it in the integrators system and preventing future payments. |\n| [echo](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/echo) | `POST /one-time-payment-code-v1/echo` Echos back the `clientMessage` that is passed in. |\n| [generateReferenceNumber](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/generateReferenceNumber) | `POST /one-time-payment-code-v1/generateReferenceNumber` Creates a reference number and registers payment information (description, timestamp) with the integrator. |\n| [remittanceStatementNotification](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/remittanceStatementNotification) | `POST /one-time-payment-code-v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |"]]