Google Standard Payments Payment Integrator Hosted Carriers API
Stay organized with collections
Save and categorize content based on your preferences.
This includes services hosted by Payment Integrators for Carriers.
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 |
associateAccount |
POST /carriers-v1/associateAccount
Associates the customer's account with the payment processor to the Google instrument being added. |
authenticateWithToken |
POST /carriers-v1/authenticateWithToken
Attempts to authenticate a user with an existing token. |
cancelFundsReservation |
POST /carriers-v1/cancelFundsReservation
Initiates canceling the funds that were reserved by a reserveFunds call. |
capture |
POST /carriers-v1/capture
Initiates money movement between a customer's account held with Google and the payment processor. |
captureFundsReservation |
POST /carriers-v1/captureFundsReservation
Initiates a capture of the funds reserved by a reserveFunds call. |
echo |
POST /carriers-v1/echo
Echos back a string sent from the client. |
refund |
POST /carriers-v1/refund
Refunds a portion of or the entire transaction initiated through capture. |
remittanceStatementNotification |
POST /carriers-v1/remittanceStatementNotification
Notifies the integrator of a new remittance statement. |
reserveFunds |
POST /carriers-v1/reserveFunds
Reserve funds on a token. |
simulateSms |
POST /carriers-v1/simulateSms
Simulates the sending of an SMS message to the payment integrator. |
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 for Payment Integrators to manage carrier billing interactions.\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for interacting with these services; however, the Discovery Document and service endpoint details are provided for custom integrations.\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\u003eAvailable methods include account association, authentication, funds reservation and capture, refunds, and remittance statement notifications.\u003c/p\u003e\n"],["\u003cp\u003eThese services facilitate money movement between Google and payment processors for carrier billing transactions.\u003c/p\u003e\n"]]],["Payment Integrators host services for Carriers, accessible via a REST resource. API requests can be made using Google's client libraries or custom libraries, referencing the provided Discovery Document. The service endpoint is `https://www.integratorhost.example.com/integrator-base-path`. Key actions include account association, user authentication, reserving/canceling/capturing funds, initiating refunds, sending SMS, and notification of remittance statements. It also allows echoing and initiating money transfers. All actions are accessed using POST requests to specific URIs.\n"],null,["# Google Standard Payments Payment Integrator Hosted Carriers API\n\nThis includes services hosted by Payment Integrators for Carriers.\n\n- [REST Resource: integrator-base-path.carriers-v1](#integrator-base-path.carriers-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/carriers-v1/payment-integrator-carriers-api/open-api-spec.json](/static/pay/carriers-v1/payment-integrator-carriers-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| [associateAccount](/pay/carriers-v1/payment-integrator-carriers-api/associateAccount) | `POST /carriers-v1/associateAccount` Associates the customer's account with the payment processor to the Google instrument being added. |\n| [authenticateWithToken](/pay/carriers-v1/payment-integrator-carriers-api/authenticateWithToken) | `POST /carriers-v1/authenticateWithToken` Attempts to authenticate a user with an existing token. |\n| [cancelFundsReservation](/pay/carriers-v1/payment-integrator-carriers-api/cancelFundsReservation) | `POST /carriers-v1/cancelFundsReservation` Initiates canceling the funds that were reserved by a `reserveFunds` call. |\n| [capture](/pay/carriers-v1/payment-integrator-carriers-api/capture) | `POST /carriers-v1/capture` Initiates money movement between a customer's account held with Google and the payment processor. |\n| [captureFundsReservation](/pay/carriers-v1/payment-integrator-carriers-api/captureFundsReservation) | `POST /carriers-v1/captureFundsReservation` Initiates a capture of the funds reserved by a `reserveFunds` call. |\n| [echo](/pay/carriers-v1/payment-integrator-carriers-api/echo) | `POST /carriers-v1/echo` Echos back a string sent from the client. |\n| [refund](/pay/carriers-v1/payment-integrator-carriers-api/refund) | `POST /carriers-v1/refund` Refunds a portion of or the entire transaction initiated through `capture`. |\n| [remittanceStatementNotification](/pay/carriers-v1/payment-integrator-carriers-api/remittanceStatementNotification) | `POST /carriers-v1/remittanceStatementNotification` Notifies the integrator of a new remittance statement. |\n| [reserveFunds](/pay/carriers-v1/payment-integrator-carriers-api/reserveFunds) | `POST /carriers-v1/reserveFunds` Reserve funds on a token. |\n| [simulateSms](/pay/carriers-v1/payment-integrator-carriers-api/simulateSms) | `POST /carriers-v1/simulateSms` Simulates the sending of an SMS message to the payment integrator. |"]]