Create money transfer

Action ID
actions.intent.CREATE_MONEY_TRANSFER
Description

Construct a new request to transfer money between people, accounts, and organizations. Populate the sender and recipient using the moneyTransfer.moneyTransferOrigin.name and moneyTransfer.moneyTransferDestination.name intent parameters. Also, populate the amount of money to transfer using the moneyTransfer.amount.value parameter and (if available) the currency of that amount using the moneyTransfer.amount.currency parameter.

When using the AddMoney transfer mode, the money transfer origin is the account from which money is deducted. The transfer destination is the account to which money is added.

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

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:

moneyTransfer.amount.value
moneyTransfer.moneyTransferDestination.name
moneyTransfer.moneyTransferOrigin.name
moneyTransfer.transferMode

Other supported fields

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

moneyTransfer.@type
moneyTransfer.amount.@type
moneyTransfer.amount.currency
moneyTransfer.moneyTransferDestination.@type
moneyTransfer.moneyTransferDestination.provider.@type
moneyTransfer.moneyTransferDestination.provider.name
moneyTransfer.moneyTransferOrigin.@type
moneyTransfer.moneyTransferOrigin.provider.@type
moneyTransfer.moneyTransferOrigin.provider.name

Supported text values by field








Inventory availability by field



Foreground app invocation

This built-in intent supports foreground app invocation.

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

The following example queries are specific to intent matching for foreground app invocation:

Sample XML files

For information about the actions.xml schema, see Create actions.xml. For information about the shortcuts.xml schema, see Create shorcuts.xml.

Handle BII parameters

shortcuts.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.CREATE_MONEY_TRANSFER">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. transferMode = "http://schema.googleapis.com/ReceiveMoney" -->
      <parameter
        android:name="moneyTransfer.transferMode"
        android:key="transferMode"/>
      <!-- Eg. value = "100" -->
      <parameter
        android:name="moneyTransfer.amount.value"
        android:key="value"/>
      <!-- Eg. currency = "USD" -->
      <parameter
        android:name="moneyTransfer.amount.currency"
        android:key="currency"/>
      <!-- Eg. moneyTransferOriginName = "Credit card" -->
      <parameter
        android:name="moneyTransfer.moneyTransferOrigin.name"
        android:key="moneyTransferOriginName"/>
      <!-- Eg. moneyTransferDestinationName = "Savings account" -->
      <parameter
        android:name="moneyTransfer.moneyTransferDestination.name"
        android:key="moneyTransferDestinationName"/>
      <!-- Eg. moneyTransferOriginProvidername = "Example Provider" -->
      <parameter
        android:name="moneyTransfer.moneyTransferOrigin.provider.name"
        android:key="moneyTransferOriginProvidername"/>
      <!-- Eg. moneyTransferDestinationProvidername = "Example Provider" -->
      <parameter
        android:name="moneyTransfer.moneyTransferDestination.provider.name"
        android:key="moneyTransferDestinationProvidername"/>
    </intent>
  </capability>
</shortcuts>

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.CREATE_MONEY_TRANSFER">
    <fulfillment urlTemplate="myapp://custom-deeplink{?transferMode,value,currency,moneyTransferOriginName,moneyTransferDestinationName,moneyTransferOriginProvidername,moneyTransferDestinationProvidername}">
      <!-- e.g. transferMode = "http://schema.googleapis.com/ReceiveMoney" -->
      <!-- (Optional) Require a field eg.transferMode for fulfillment with required="true" -->
      <parameter-mapping urlParameter="transferMode" intentParameter="moneyTransfer.transferMode" required="true" />
      <!-- e.g. value = "100" -->
      <parameter-mapping urlParameter="value" intentParameter="moneyTransfer.amount.value" />
      <!-- e.g. currency = "USD" -->
      <parameter-mapping urlParameter="currency" intentParameter="moneyTransfer.amount.currency" />
      <!-- e.g. moneyTransferOriginName = "Credit card" -->
      <parameter-mapping urlParameter="moneyTransferOriginName" intentParameter="moneyTransfer.moneyTransferOrigin.name" />
      <!-- e.g. moneyTransferDestinationName = "Savings account" -->
      <parameter-mapping urlParameter="moneyTransferDestinationName" intentParameter="moneyTransfer.moneyTransferDestination.name" />
      <!-- e.g. moneyTransferOriginProvidername = "Example Provider" -->
      <parameter-mapping urlParameter="moneyTransferOriginProvidername" intentParameter="moneyTransfer.moneyTransferOrigin.provider.name" />
      <!-- e.g. moneyTransferDestinationProvidername = "Example Provider" -->
      <parameter-mapping urlParameter="moneyTransferDestinationProvidername" intentParameter="moneyTransfer.moneyTransferDestination.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

shortcuts.xml

moneyTransfer.moneyTransferOrigin.name is an intent parameter that supports inline inventory. By defining a <shortcut> for moneyTransfer.moneyTransferOrigin.name, 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 moneyTransferOriginName_one shortcut, Assistant provides the associated shorcut identifier, ID_ONE, as the URL parameter moneyTransferOriginName to fulfillment.

If there is no inventory match, the text value received in the query for moneyTransfer.moneyTransferOrigin.name is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.CREATE_MONEY_TRANSFER">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="moneyTransfer.transferMode"
        android:key="transferMode"/>
      <parameter
        android:name="moneyTransfer.amount.value"
        android:key="value"/>
      <parameter
        android:name="moneyTransfer.amount.currency"
        android:key="currency"/>
      <parameter
        android:name="moneyTransfer.moneyTransferOrigin.name"
        android:key="moneyTransferOriginName"/>
      <parameter
        android:name="moneyTransfer.moneyTransferDestination.name"
        android:key="moneyTransferDestinationName"/>
      <parameter
        android:name="moneyTransfer.moneyTransferOrigin.provider.name"
        android:key="moneyTransferOriginProvidername"/>
      <parameter
        android:name="moneyTransfer.moneyTransferDestination.provider.name"
        android:key="moneyTransferDestinationProvidername"/>
    </intent>
    </capability>
    <!-- Short and long labels must be @string resource. -->
    <shortcut
      android:shortcutId="ID_ONE"
      android:shortcutShortLabel="@string/shortcut_short_label"
      android:shortcutLongLabel="@string/shortcut_long_label">
      <capability-binding android:key="actions.intent.CREATE_MONEY_TRANSFER">
        <parameter-binding
          android:value="moneyTransferOriginName"
          android:key="moneyTransfer.moneyTransferOrigin.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>

actions.xml

moneyTransfer.moneyTransferOrigin.name is an intent parameter that supports inline inventory. By defining an <entity-set> for moneyTransfer.moneyTransferOrigin.name, 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 moneyTransferOriginName_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter moneyTransferOriginName to fulfillment.

If there is no inventory match, the text value received in the query for moneyTransfer.moneyTransferOrigin.name is passed as-is.

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

    <!-- Define parameters with inventories here -->
    <parameter name="moneyTransfer.moneyTransferOrigin.name">
      <entity-set-reference entitySetId="moneyTransferOriginNameEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="moneyTransferOriginNameEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="moneyTransferOriginName_one" alternateName="@array/moneyTransferOriginName_one_synonyms"/>
    <entity identifier="ID_TWO" name="moneyTransferOriginName_two" alternateName="@array/moneyTransferOriginName_two_synonyms"/>
  </entity-set>
</actions>

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 moneyTransferOriginName_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.CREATE_MONEY_TRANSFER">
      <!-- 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="moneyTransfer.moneyTransferOrigin.name">
        <entity-set-reference entitySetId="moneyTransferOriginNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="moneyTransferOriginNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="moneyTransferOriginName_one" alternateName="@array/moneyTransferOriginName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="moneyTransferOriginName_two" alternateName="@array/moneyTransferOriginName_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": "MoneyTransfer",
  "amount": {
    "@type": "MonetaryAmount",
    "currency": "USD",
    "value": "100"
  },
  "moneyTransferDestination": {
    "@type": "Service",
    "name": "Savings account",
    "provider": {
      "@type": "Organization",
      "name": "Example Provider"
    }
  },
  "moneyTransferOrigin": {
    "@type": "Service",
    "name": "Credit card",
    "provider": {
      "@type": "Organization",
      "name": "Example Provider"
    }
  },
  "transferMode": "http://schema.googleapis.com/ReceiveMoney"
}