Google Standard Payments Payment Integrator Hosted Refundable 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 Refundable 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 |
asynchronousCapture |
POST /refundable-one-time-payment-code-v1/asynchronousCapture
Triggers the start of a money movement operation between a customer's account and the integrator. |
asynchronousRefund |
POST /refundable-one-time-payment-code-v1/asynchronousRefund
Refunds a portion of or the entire transaction initiated through generateReferenceNumber. |
cancelMandate |
POST /refundable-one-time-payment-code-v1/cancelMandate
Initiates a mandate cancellation on the user's account with the integrator. |
cancelReferenceNumber |
POST /refundable-one-time-payment-code-v1/cancelReferenceNumber
Cancels a reference number by invalidating it in the integrators system and preventing future payments. |
echo |
POST /refundable-one-time-payment-code-v1/echo
Echos back the clientMessage that is passed in. |
generateReferenceNumber |
POST /refundable-one-time-payment-code-v1/generateReferenceNumber
Creates a reference number and registers payment information (description, timestamp) with the integrator. |
refund |
POST /refundable-one-time-payment-code-v1/refund
Refunds a portion of or the entire transaction initiated through generateReferenceNumber. |
remittanceStatementNotification |
POST /refundable-one-time-payment-code-v1/remittanceStatementNotification
Notifies the integrator of a new remittance statement. |
| Methods |
create |
POST /refundable-one-time-payment-code-v1/createMandateWithOptionalInstantPayment
Initiates a mandate creation on the user's account with the integrator. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 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-05-16 UTC."],[[["\u003cp\u003eThis documentation outlines the services for Refundable One Time Payment Codes hosted by Payment Integrators.\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for utilizing these services; alternatively, the provided discovery document and service endpoint can be used with custom libraries.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for all API requests is \u003ccode\u003ehttps://www.integratorhost.example.com/integrator-base-path\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eKey API methods include generating and canceling reference numbers, processing refunds, and handling remittance statement notifications.\u003c/p\u003e\n"]]],["This document outlines the API for Refundable One Time Payment Codes hosted by Payment Integrators. Key actions include: initiating refunds via `asynchronousRefund` or `refund`; canceling reference numbers with `cancelReferenceNumber`; generating reference numbers with `generateReferenceNumber`; and receiving remittance statement notifications using `remittanceStatementNotification`. The `echo` method tests the connection. The service endpoint is `https://www.integratorhost.example.com/integrator-base-path`, and the API's machine-readable specification is available in the provided discovery document.\n"],null,["# Google Standard Payments Payment Integrator Hosted Refundable One Time Payment Codes API\n\nThis includes services hosted by Payment Integrators for Refundable One Time Payment Codes.\n\n- [REST Resource: integrator-base-path.refundable-one-time-payment-code-v1](#integrator-base-path.refundable-one-time-payment-code-v1)\n- [REST Resource:\n integrator-base-path.refundable-one-time-payment-code-v1.createMandateWithOptionalInstantPayment](#integrator-base-path.refundable-one-time-payment-code-v1.createMandateWithOptionalInstantPayment)\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/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/open-api-spec.json](/static/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-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| [asynchronousCapture](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/asynchronousCapture) | `POST /refundable-one-time-payment-code-v1/asynchronousCapture` Triggers the start of a money movement operation between a customer's account and the integrator. |\n| [asynchronousRefund](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/asynchronousRefund) | `POST /refundable-one-time-payment-code-v1/asynchronousRefund` Refunds a portion of or the entire transaction initiated through `generateReferenceNumber`. |\n| [cancelMandate](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/cancelMandate) | `POST /refundable-one-time-payment-code-v1/cancelMandate` Initiates a mandate cancellation on the user's account with the integrator. |\n| [cancelReferenceNumber](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/cancelReferenceNumber) | `POST /refundable-one-time-payment-code-v1/cancelReferenceNumber` Cancels a reference number by invalidating it in the integrators system and preventing future payments. |\n| [echo](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/echo) | `POST /refundable-one-time-payment-code-v1/echo` Echos back the `clientMessage` that is passed in. |\n| [generateReferenceNumber](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/generateReferenceNumber) | `POST /refundable-one-time-payment-code-v1/generateReferenceNumber` Creates a reference number and registers payment information (description, timestamp) with the integrator. |\n| [refund](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/refund) | `POST /refundable-one-time-payment-code-v1/refund` Refunds a portion of or the entire transaction initiated through `generateReferenceNumber`. |\n| [remittanceStatementNotification](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/remittanceStatementNotification) | `POST /refundable-one-time-payment-code-v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/createMandateWithOptionalInstantPayment) | `POST /refundable-one-time-payment-code-v1/createMandateWithOptionalInstantPayment` Initiates a mandate creation on the user's account with the integrator. |"]]