Pay invoice

Action ID
actions.intent.PAY_INVOICE
Description

Initiate payment of a user's bill or invoice. Determine what invoice the user wants to pay, if applicable. We recommend that you specify entities for invoice.forService.name.

Your app must confirm with the user before submitting a payment.

Locale support

Functionality Locales
Preview creation using App Actions test tool en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR
User invocation from Google Assistant en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR

Example queries

The following fields represent essential information that users often provide in queries that trigger this built-in intent:

invoice.forService.name

Other supported fields

The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:

amount.@type
amount.currency
amount.value
invoice.@type
invoice.forService.@type
invoice.forService.provider.@type
invoice.forService.provider.name
invoice.paymentMethodId

Supported text values by field





Inventory availability by field




Sample actions.xml

For information about the actions schema, read Create actions.xml.

Handle intent parameters as URL parameters

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.PAY_INVOICE">
    <fulfillment urlTemplate="myapp://custom-deeplink{?value,currency,paymentMethodId,forServiceName,providerName}">
      <!-- Eg. value = "20" -->
      <!-- (Optional) Require a field eg.value for fulfillment with required="true" -->
      <parameter-mapping urlParameter="value" intentParameter="amount.value" required="true" />
      <!-- Eg. currency = "USD" -->
      <parameter-mapping urlParameter="currency" intentParameter="amount.currency" />
      <!-- Eg. paymentMethodId = "Credit Card" -->
      <parameter-mapping urlParameter="paymentMethodId" intentParameter="invoice.paymentMethodId" />
      <!-- Eg. forServiceName = "Utility" -->
      <parameter-mapping urlParameter="forServiceName" intentParameter="invoice.forService.name" />
      <!-- Eg. providerName = "Example Provider" -->
      <parameter-mapping urlParameter="providerName" intentParameter="invoice.forService.provider.name" />
    </fulfillment>

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />
  </action>
</actions>

Use inline inventory to guide query matching

invoice.paymentMethodId is a field that supports inline inventory. By defining an <entity-set> for invoice.paymentMethodId, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the paymentMethodId_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter paymentMethodId to fulfillment.

If there is no inventory match, the text value received in the query for invoice.paymentMethodId is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.PAY_INVOICE">
    <fulfillment urlTemplate="myapp://deeplink{?paymentMethodId}" >
      <!-- paymentMethodId = "ID_ONE" or "ID_TWO"  -->
      <!-- If no inventory match, paymentMethodId is a text value, such as "Credit Card" -->
      <!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
      <parameter-mapping urlParameter="paymentMethodId" intentParameter="invoice.paymentMethodId" />
    </fulfillment>

    <!-- Define parameters with inventories here -->
    <parameter name="invoice.paymentMethodId">
      <entity-set-reference entitySetId="paymentMethodIdEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="paymentMethodIdEntitySet">
    <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="paymentMethodId_one" alternateName="@array/paymentMethodId_one_synonyms"/>
    <entity identifier="ID_TWO" name="paymentMethodId_two" alternateName="@array/paymentMethodId_two_synonyms"/>
  </entity-set>
</actions>

Derive fulfillment URL using inline inventory

The url attribute associated with the entity can be used to determine the fulfillment URL if there is an inventory match. In the following example, when the user query matches the paymentMethodId_one entity, Assistant provides myapp://deeplink/one as the fulfillment URL.

  <?xml version="1.0" encoding="utf-8"?>
  <!-- This is a sample actions.xml -->
  <actions>
    <action intentName="actions.intent.PAY_INVOICE">
      <!-- Use url from inventory match for deep link fulfillment -->
      <fulfillment urlTemplate="{@url}" />

      <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
      <fulfillment urlTemplate="myapp://deeplink" />

      <!-- Define parameters with inventories here -->
      <parameter name="invoice.paymentMethodId">
        <entity-set-reference entitySetId="paymentMethodIdEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="paymentMethodIdEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="paymentMethodId_one" alternateName="@array/paymentMethodId_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="paymentMethodId_two" alternateName="@array/paymentMethodId_two_synonyms"/>
    </entity-set>
  </actions>
  

JSON-LD sample

The following JSON-LD sample provides some example values that you can use in the App Actions test tool:

{
  "@context": "http://schema.googleapis.com",
  "@type": "Invoice",
  "forService": {
    "@type": "Service",
    "name": "Utility",
    "provider": {
      "@type": "Organization",
      "name": "Example Provider"
    }
  },
  "paymentMethodId": "Credit Card"
}
{
  "@context": "http://schema.org",
  "@type": "MonetaryAmount",
  "currency": "USD",
  "value": "20"
}