Protocol

INSendPaymentIntentHandling

The handler interface for transferring money from the current user’s account to a different user’s account.

Declaration

@protocol INSendPaymentIntentHandling

Overview

Use the methods of the INSendPaymentIntentHandling protocol to resolve, confirm, and handle requests to send money to another user of your app. Adopt this protocol in an object of your Intents extension that is capable of performing the financial transaction.

Siri delivers an INSendPaymentIntent object to your handler when the user asks to send a payment using your app. The provided intent object contains the details of the payment, including the recipient, the amount to transfer, and any memos associated with the payment. Use the methods of this protocol to resolve the payment parameters and to validate that the payment is possible.

Topics

Resolving the Intent Parameters

- resolvePayeeForSendPayment:completion:

Resolves the recipient for a payment.

- resolveCurrencyAmountForSendPayment:completion:

Resolves the amount of currency to transfer.

- resolveNoteForSendPayment:withCompletion:

Resolves the notes associated with the transaction.

- resolvePayeeForSendPayment:withCompletion:

Called when you need to resolve the recipient of the funds.

Deprecated
- resolveCurrencyAmountForSendPayment:withCompletion:

Called when you need to resolve the currency amount to be transferred.

Deprecated

Confirming the Response

- confirmSendPayment:completion:

Confirms the transaction and details.

Handling the Intent

- handleSendPayment:completion:

Handles transferring the money between accounts.

Required.

Relationships

Inherits From

See Also

Send a Payment

INSendPaymentIntent

A request to transfer money from the current user’s account to a different user’s account.

INSendPaymentIntentResponse

Your app’s response to a send payment intent.

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