Protocol

INRequestPaymentIntentHandling

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

Declaration

@protocol INRequestPaymentIntentHandling

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

Resolving the Intent Parameters

- resolvePayerForRequestPayment:completion:

Resolves the person to receive the payment request.

- resolveCurrencyAmountForRequestPayment:completion:

Resolves the amount of money requested.

- resolveNoteForRequestPayment:withCompletion:

Resolves the notes associated with the request.

- resolvePayerForRequestPayment:withCompletion:

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

Deprecated
- resolveCurrencyAmountForRequestPayment:withCompletion:

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

Deprecated

Confirming the Response

- confirmRequestPayment:completion:

Confirms the payment request and confirm the details.

Handling the Intent

- handleRequestPayment:completion:

Handles sending the payment request to the designated user.

Required.

Relationships

Inherits From

See Also

Request a Payment

INRequestPaymentIntent

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

INRequestPaymentIntentResponse

Your app’s response to a request 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