Protocol

INRequestPaymentIntentHandling

The handler interface for delivering a request for payment from another user of your app.

Overview

Use the methods of the INRequestPaymentIntentHandling protocol to resolve, confirm, and handle the requesting of money from another user of your app. Adopt this protocol in an object of your Intents extension that is capable of contacting the designated user and communicating the request for payment.

Siri delivers an INRequestPaymentIntent object to your handler when the user makes a request for payment using your app. The provided intent object contains the details of the payment request, including the recipient of the request, the amount of the payment, 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

Handling the Intent

func handle(intent: INRequestPaymentIntent, completion: (INRequestPaymentIntentResponse) -> Void)

Called when it is time for you to send the payment request to the designated user.

Required.

Confirming the Response

func confirm(intent: INRequestPaymentIntent, completion: (INRequestPaymentIntentResponse) -> Void)

Called when it is time for you to validate the payment request and confirm the details.

Resolving the Details of the Intent

func resolvePayer(for: INRequestPaymentIntent, with: (INRequestPaymentPayerResolutionResult) -> Void)

Called when you need to resolve the person who will receive the payment request.

func resolveNote(for: INRequestPaymentIntent, with: (INStringResolutionResult) -> Void)

Called when you need to resolve the notes associated with the request.

func resolvePayer(for: INRequestPaymentIntent, with: (INPersonResolutionResult) -> Void)

Called when you need to resolve the person who will receive the payment request.

Deprecated
func resolveCurrencyAmount(for: INRequestPaymentIntent, with: (INCurrencyAmountResolutionResult) -> Void)

Called when you need to resolve the amount of money being requested.

Deprecated

Relationships

Inherits From

See Also

Request a Payment

class INRequestPaymentIntent

An intent for requesting money from another user’s account.

class INRequestPaymentIntentResponse

Your app’s response to a request payment intent.