Google Standard Payments Payment Integrator Hosted Tokenized FOP API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators for Tokenized 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 REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. 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
| Methods |
associateAccount |
POST /v2/associateAccount
Associates the customer's account with the payment processor to the Google instrument being added. |
asynchronousRefund |
POST /v2/asynchronousRefund
Refunds a portion or all of the entire transaction. |
authenticateIdentity |
POST /v2/authenticateIdentity
Authenticates a user's account using data about the user's Google account and current context. |
cancelFundsReservation |
POST /v2/cancelFundsReservation
Initiates canceling the funds that were reserved by a reserveFunds call. |
capture |
POST /v2/capture
Initiates money movement between a customer's account held with Google and the payment processor. |
captureFundsReservation |
POST /v2/captureFundsReservation
Initiates a capture of the funds reserved by a reserveFunds call. |
refund |
POST /v2/refund
Refunds a portion of or the entire transaction initiated through capture. |
reserveFunds |
POST /v2/reserveFunds
Reserve funds on a token. |
sendOtp |
POST /v2/sendOtp
Requests the integrator send an OTP to the phone number. |
simulateSms |
POST /v2/simulateSms
Simulates the sending of an SMS message to the payment integrator. |
verifyOtp |
POST /v2/verifyOtp
Verifies an OTP value was sent by the integrator for the account. |
| Methods |
cancelReferenceNumber |
POST /v2/payment-integrator-tokenized/cancelReferenceNumber
Cancels a reference number by invalidating it in the integrators system and preventing future payments. |
generateReferenceNumber |
POST /v2/payment-integrator-tokenized/generateReferenceNumber
Creates a reference number and registers payment information (description, timestamp) with the integrator. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-03 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 2024-09-03 UTC."],[[["\u003cp\u003eThis API outlines services hosted by Payment Integrators for tokenized Forms of Payment (FOPs).\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for interacting with the API, but the discovery document and service endpoint are available for custom integrations.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for all API requests is \u003ccode\u003ehttps://www.integratorhost.example.com\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods for key payment functionalities like associating accounts, processing refunds, capturing payments, and reserving funds.\u003c/p\u003e\n"],["\u003cp\u003eAdditional methods are available for managing reference numbers, including generating and canceling them for payment integrations.\u003c/p\u003e\n"]]],["The document details API services for Payment Integrators handling Tokenized FOPs, accessible via `https://www.integratorhost.example.com`. Key actions include: associating accounts, processing refunds (synchronous and asynchronous), authenticating identities, managing fund reservations (cancel, capture), capturing payments, sending and verifying OTPs, and simulating SMS. Additional methods are provided to generate and cancel reference numbers, registering and invalidating them within the integrator's system. These are to be called using POST requests to the provided URIs.\n"],null,["# Google Standard Payments Payment Integrator Hosted Tokenized FOP API\n\nThis includes services hosted by Payment Integrators for Tokenized FOPs.\n\n- [REST Resource: v2](#v2)\n- [REST Resource: v2.payment-integrator-tokenized](#v2.payment-integrator-tokenized)\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 REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\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`\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [associateAccount](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/associateAccount) | `POST /v2/associateAccount` Associates the customer's account with the payment processor to the Google instrument being added. |\n| [asynchronousRefund](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/asynchronousRefund) | `POST /v2/asynchronousRefund` Refunds a portion or all of the entire transaction. |\n| [authenticateIdentity](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/authenticateIdentity) | `POST /v2/authenticateIdentity` Authenticates a user's account using data about the user's Google account and current context. |\n| [cancelFundsReservation](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/cancelFundsReservation) | `POST /v2/cancelFundsReservation` Initiates canceling the funds that were reserved by a `reserveFunds` call. |\n| [capture](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/capture) | `POST /v2/capture` Initiates money movement between a customer's account held with Google and the payment processor. |\n| [captureFundsReservation](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/captureFundsReservation) | `POST /v2/captureFundsReservation` Initiates a capture of the funds reserved by a `reserveFunds` call. |\n| [refund](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/refund) | `POST /v2/refund` Refunds a portion of or the entire transaction initiated through `capture`. |\n| [reserveFunds](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/reserveFunds) | `POST /v2/reserveFunds` Reserve funds on a token. |\n| [sendOtp](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/sendOtp) | `POST /v2/sendOtp` Requests the integrator send an OTP to the phone number. |\n| [simulateSms](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/simulateSms) | `POST /v2/simulateSms` Simulates the sending of an SMS message to the payment integrator. |\n| [verifyOtp](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/TopLevel/verifyOtp) | `POST /v2/verifyOtp` Verifies an OTP value was sent by the integrator for the account. |\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [cancelReferenceNumber](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/payment-integrator-tokenized/cancelReferenceNumber) | `POST /v2/payment-integrator-tokenized/cancelReferenceNumber` Cancels a reference number by invalidating it in the integrators system and preventing future payments. |\n| [generateReferenceNumber](/standard-payments/payment-integrator-tokenized-fop-api-v2/v2/payment-integrator-tokenized/generateReferenceNumber) | `POST /v2/payment-integrator-tokenized/generateReferenceNumber` Creates a reference number and registers payment information (description, timestamp) with the integrator. |"]]