AI-generated Key Takeaways
-
This documentation outlines services hosted by Payment Integrators for One Time Payment Codes, enabling functionalities like generating, canceling, and managing payment references.
-
Google-provided client libraries are recommended for interacting with these services, but the discovery document and service endpoint are available for custom integrations.
-
The service endpoint
https://www.integratorhost.example.com/integrator-base-path
acts as the base URL for all API requests related to One Time Payment Codes. -
Key API methods include generating and canceling reference numbers, echoing client messages, and handling remittance statement notifications.
-
A discovery document is provided for building client libraries and tools, ensuring seamless integration with Google Standard Payments APIs.
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. |