Class

INPayBillIntent

A request to transfer of money to facilitate payment of a bill.

Declaration

class INPayBillIntent : INIntent

Overview

Siri creates an INPayBillIntent object when the user asks to pay a bill for a designated payee. A pay bill intent object includes the payment amount, the payment date, and the recipient of the payment. Use that information to validate the transaction and to schedule the payment.

To handle this intent, the handler object in your Intents extension must adopt the INPayBillIntentHandling protocol. Your handler should confirm the request and create an INPayBillIntentResponse object with the results of scheduling the bill payment.

This intent object represents a financial transaction between the user and an entity (such as a utility company or credit card bill) defined in your app. You are responsible for configuring and managing the entities that accept the payment of bills.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Pay bill intent attributes

Attribute

Description

Supported by

Siri Intents, Siri Suggestions, Shortcuts app.

Always requires unlocked device

Yes

When performing a search, Siri automatically asks the user to unlock a currently locked device. You don’t need to explicitly ask to unlock the device. In addition, Siri always prompts the user to confirm the request before asking your Intents extension to handle it.

Example Phrases

Users can ask Siri to initiate the payment of a bill in a variety of ways. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list isn’t exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the payment of a bill

Locale

Example 1

Example 2

en

Pay my water bill

Pay my gas bill on November 21st

zh_CN

付我的水费账单

在十一月二十一日付我的煤气账单

zh_HK

幫我俾保險賬單

喺十月九號俾水費賬單

zh_TW

我想要支付水費帳單

付水費帳單於2月21日

yue_CN

帮我俾保险账单

喺十月九号俾水费账单

ar

ادفع فاتورة الكهرباء

ادفع فاتورة الغاز في 21 نوفمبر

da

Betal min vandregning

Betal min gasregning på den 21 november

de

Zahle meine Wasser Rechnung

Zahle meine Gas Rechnung am 21. November

es

Pagar mi factura del agua

Pagar mi factura del gas el 21 de Noviembre

fi

Maksa vesimaksu

Maksa sähkölasku marraskuun 21. päivä

fr

Payer ma facture d'eau

Payer ma facture de gaz le 21 novembre

he

תשלמי את חשבון המים שלי

תשלמי את חשבון הגז שלי ב-21 לנובמבר

it

paga il conto dell'acqua

paga il conto del gas il 21 di Novembre

ja

PG&Eの請求書を払って

11月21日にガスの請求書を払って

ko

수도세 내줘

가스비 11월 21일에 내줘

ms

Bayar bil air saya

Bayar bil gas saya pada 21 November

nb

Betal vannregningen min

Betal strømregningen 21. November

nl

Betaal mijn water factuur

Betaal mijn gasrekening op 21 November

pt

Pagar minha conta de água

Pagar minha conta de luz dia 21 de novembro

ru

Оплати мой счёт за воду

Заплатить за газ 21-го ноября

sv

Betala min elräkning

Betala min gasräkning på 21 november

th

จ่ายบิลค่าน้ำ

วันที่ 21 พฤศจิกายน จ่ายค่าน้ำ

tr

Su faturasını öde Elektrik faturasını öde

21 Kasım tarihinde doğalgaz faturasını öde

In Table 2, <appName> represents the name of the app whose Intents extension initiates the transaction. If your app uses custom names for contacts, you can tell Siri about those names using the INVocabulary class.

Topics

Getting the Bill Information

var billPayee: INBillPayee?

The recipient of the payment.

var billType: INBillType

The type of the bill.

var dueDate: INDateComponentsRange?

The due date of the payment.

Getting the Transaction Details

var fromAccount: INPaymentAccount?

The user account containing the funds for the payment.

var transactionAmount: INPaymentAmount?

The amount to transfer from the user to the payee.

var transactionNote: String?

A note to associate with the payment transaction.

var transactionScheduledDate: INDateComponentsRange?

The scheduled date for the payment, as requested by the user.

Relationships

Inherits From

Conforms To

See Also

Pay a Bill

protocol INPayBillIntentHandling

The handler interface for paying a bill using money from the user’s account.

class INPayBillIntentResponse

Your app’s response to a request to pay a bill.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software