Class

INPaymentRecord

Detailed information about a financial transaction made between two users.

Declaration

class INPaymentRecord : NSObject

Overview

An INPaymentRecord object contains the details of a financial transaction that your app is facilitating. You create instances of this class when handling payment-related intents. The payment record contains the users involved in the transaction, the amount of money to transfer, and the current state of the transaction. Siri conveys this detailed information to the user at appropriate times.

When creating payment records, specify as many details as possible. Siri always asks the user to confirm payments before asking your Intents extension to process them. During confirmation, Siri displays the information from this object in the confirmation interface. Omitting important pieces of information, such as the recipient or currency amount, might cause the user to cancel the transaction.

Topics

Getting the Payment Status

var status: INPaymentStatus

The current status of the financial transaction.

Getting Payment Record Details

var payee: INPerson?

The person receiving the funds.

var payer: INPerson?

The person providing the funds.

var currencyAmount: INCurrencyAmount?

The type of currency to transfer and the amount to transfer.

var feeAmount: INCurrencyAmount?

The total amount of any fees added to the payment record.

var paymentMethod: INPaymentMethod?

The payment method used to supply the funds.

var note: String?

A description of the payment to send.

Relationships

Inherits From

See Also

Data Objects

enum INAccountType

Constants indicating the type of account involved in a financial transaction.

class INBillDetails

The detailed information associated with a bill.

class INBillPayee

The entity that receives the proceeds from a bill payment.

class INCurrencyAmount

An amount of money to transfer during a financial transaction.

class INPaymentAccount

A user account that provides the funds when making a payment.

class INPaymentAmount

The amount of money to apply to a bill payment.

class INPaymentMethod

Information about a form of payment supported by your app.

enum INPaymentStatus

Constants indicating the state of the financial transaction.

class INPerson

The information about a user involved in a SiriKit interaction.