Class

INRequestPaymentIntent

Requests money from another user’s account.

Overview

Siri creates an INRequestPaymentIntent object when the current user requests a payment from another user. A request payment intent object includes the payment amount and the person receiving the request. This intent represents only a request for payment and should not cause the payment to be made.

To handle this intent, the handler object in your Intents extension must adopt the INRequestPaymentIntentHandling protocol. Your handler should confirm the request and create an INRequestPaymentIntentResponse object with the results of making the request.

For a list of other intents in the payments domain, see INPaymentsDomainHandling.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Request payment intent attributes

Attribute

Description

Supported by

Siri

Always requires unlocked device

Yes

When requesting a payment, Siri automatically asks the user to unlock the device if it is currently locked. You do not need to ask for the device to be unlocked explicitly. In addition, Siri always prompts the user to confirm the request before asking your Intents extension to handle it.

Example Phrases

There are many ways in which users can ask Siri to request a payment. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list is not exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the requesting of a payment

Locale

Example 1

Example 2

en

Charge Alex $30 for lunch using <appName>

Ask Nancy to pay me $25 on <appName>

zh_CN

<appName>向小白要30块钱人民币

siri可以从小白那边收50元吗

zh_HK

喺支付寶問Jeffrey攞錢

喺支付寶叫小明還錢

zh_TW

<appName>跟Jeffrey請款30歐元

<appName>跟Alex要20歐元

yue_CN

喺支付宝问Jeffrey攞钱

喺支付宝叫小明还钱

ar

اطلب ١٠ يورو من رنا عبر <appName>

اطلب ٢٥ يورو من رامي باستخدام <appName>

da

bed om $45 fra John

Hans 10 euro til mig

de

Fordere 10 Dollar von Alexander mit <appName>

Frage Alexander nach 10 Dollar über <appName>

es

Cobrarle 2500 pesos a Gustavo

Cobra 2500 pesos a Gustavo

fi

pyydä <appName>lla 30 € Niinalta illallisesta

Pyydä <appName>lla 25 € Aleksilta

fr

Demande à Thomas 40€ pour le repas sur <appName>

Demande à John qu'il me transfère 45 € utilisant <appName> pour la nourriture

he

העבירי לדויד 30 יורו באמצעות <appName>

בקשי מדויד 30 יורו באמצעות <appName>

it

Chiedi 30 € ad Alessandro per il pranzo usando <appName>

Chiedi a Federico di pagarmi 250 € su <appName>

ja

<appName>でランチ代3,000円を田中に請求して

ランチ代3,000円を<appName>で田中にリクエストして

ko

<appName>로 민호한테 점심값 3만원 청구해

<appName>로 미나한테 2만원 보내

ms

Minta wang untuk makan siang daripada Azim dengan menggunakan <appName>

Minta 50 ringgit daripada Johan pada <appName>

nb

Be om 120 kr med <appName> fra Alex for lunsjen

Spør Nina om 200 kr med <appName>

nl

Verzoek € 30 van Alexander voor de lunch via <appName>

Vraag Nele om me € 25 te betalen op <appName>

pt

Solicitar $20 do João usando <appName>

Solicite R$10 para Maria no <appName>

ru

Займи 10 долларов у Марии через <appName>

Запросила для меня 2000 рублей от Александра с помощью <appName>

sv

Be Börje om 100 kronor över <appName>

Begär du att få låna 100 kr från Gunilla med hjälp av <appName>

th

เรียกเก็บเงิน 100 บาทจากสมพงษ์โดยใช้ <appName>

เก็บเงินจากสมพงษ์ 10 บาทด้วย <appName>

tr

<appName> üzerinden 20 lira borç iste Onur'dan

Onur'dan 20 lira vermesini iste <appName> kullanarak

In the preceding examples, <appName> represents the name of the app whose Intents extension handles the request. If your app uses custom names for contacts, you can tell Siri about those names using the INVocabulary class.

Topics

Initializing the Intent Object

init(payer: INPerson?, currencyAmount: INCurrencyAmount?, note: String?)

Initializes the request payment intent object with the specified recipient and payment information.

Getting Details About the Payment

var payer: INPerson?

The recipient of the payment request.

var currencyAmount: INCurrencyAmount?

The amount of the payment.

var note: String?

A note associated with the request.

Relationships

Inherits From

Conforms To

See Also

Request a Payment

protocol INRequestPaymentIntentHandling

Handles the delivery of a request for payment from another user of your app.

class INRequestPaymentIntentResponse

Contains your app’s response to a request payment intent.