Class

INPaymentRecord

Detailed information about a financial transaction made between two users.

Declaration

@interface 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

Creating a Payment Record Object

- initWithPayee:payer:currencyAmount:paymentMethod:note:status:feeAmount:

Initializes a payment record with the specified payment details.

- initWithPayee:payer:currencyAmount:paymentMethod:note:status:

Initializes a payment record with the specified payment details.

Getting the Payment Status

status

The current status of the financial transaction.

Getting Payment Record Details

payee

The person receiving the funds.

payer

The person providing the funds.

currencyAmount

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

feeAmount

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

paymentMethod

The payment method used to supply the funds.

note

A description of the payment to send.

Relationships

Inherits From

See Also

Data Objects

INAccountType

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

INBillDetails

The detailed information associated with a bill.

INBillPayee

The entity that receives the proceeds from a bill payment.

INCurrencyAmount

An amount of money to transfer during a financial transaction.

INPaymentAccount

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

INPaymentAmount

The amount of money to apply to a bill payment.

INPaymentMethod

Information about a form of payment supported by your app.

INPaymentStatus

Constants indicating the state of the financial transaction.

INPerson

The information about a user involved in a SiriKit interaction.