One Logo Pool Ball
X
Github
Discord

System

PassKit · IOS API REFERENCE

PKPaymentRequest

class · iOS 8.0+ · SDK 27.1

class PKPaymentRequest

Members (68)

static · iOS 10.0+

availableNetworks

TypeScript
static availableNetworks(): Array<PKPaymentNetwork>
Swift declaration
class func availableNetworks() -> [PKPaymentNetwork]
static · iOS 11.0+

paymentBillingAddressInvalidError

TypeScript
static paymentBillingAddressInvalidError(postalAddressKey: string, localizedDescription?: (string) | null): NativeError
Swift declaration
class func paymentBillingAddressInvalidError(withKey postalAddressKey: String, localizedDescription: String?) -> any Error
static · iOS 11.0+

paymentContactInvalidError

TypeScript
static paymentContactInvalidError(field: PKContactField, localizedDescription?: (string) | null): NativeError
Swift declaration
class func paymentContactInvalidError(withContactField field: PKContactField, localizedDescription: String?) -> any Error
static · iOS 11.0+

paymentShippingAddressInvalidError

TypeScript
static paymentShippingAddressInvalidError(postalAddressKey: string, localizedDescription?: (string) | null): NativeError
Swift declaration
class func paymentShippingAddressInvalidError(withKey postalAddressKey: String, localizedDescription: String?) -> any Error
static · iOS 11.0+

paymentShippingAddressUnserviceableError

TypeScript
static paymentShippingAddressUnserviceableError(localizedDescription?: (string) | null): NativeError
Swift declaration
class func paymentShippingAddressUnserviceableError(withLocalizedDescription localizedDescription: String?) -> any Error
init

init

TypeScript
static init(): PKPaymentRequest
Swift declaration
init()
get · iOS 8.0+

applicationData

TypeScript
get applicationData(): (ArrayBuffer) | null
Swift declaration
var applicationData: Data? { get set }
set · iOS 8.0+

applicationData

TypeScript
set applicationData(value: (ArrayBuffer) | null)
Swift declaration
var applicationData: Data? { get set }
get · iOS 26.0+

attributionIdentifier

TypeScript
get attributionIdentifier(): (string) | null
Swift declaration
var attributionIdentifier: String? { get set }
set · iOS 26.0+

attributionIdentifier

TypeScript
set attributionIdentifier(value: (string) | null)
Swift declaration
var attributionIdentifier: String? { get set }
get · iOS 16.0+

automaticReloadPaymentRequest

TypeScript
get automaticReloadPaymentRequest(): (PKAutomaticReloadPaymentRequest) | null
Swift declaration
var automaticReloadPaymentRequest: PKAutomaticReloadPaymentRequest? { get set }
set · iOS 16.0+

automaticReloadPaymentRequest

TypeScript
set automaticReloadPaymentRequest(value: (PKAutomaticReloadPaymentRequest) | null)
Swift declaration
var automaticReloadPaymentRequest: PKAutomaticReloadPaymentRequest? { get set }
get · iOS 8.0+ · Deprecated in iOS 9.0

billingAddress

TypeScript
get billingAddress(): (unknown) | null
Swift declaration
unowned(unsafe) var billingAddress: ABRecord? { get set }
set · iOS 8.0+ · Deprecated in iOS 9.0

billingAddress

TypeScript
set billingAddress(value: (unknown) | null)
Swift declaration
unowned(unsafe) var billingAddress: ABRecord? { get set }
get · iOS 9.0+

billingContact

TypeScript
get billingContact(): (PKContact) | null
Swift declaration
var billingContact: PKContact? { get set }
set · iOS 9.0+

billingContact

TypeScript
set billingContact(value: (PKContact) | null)
Swift declaration
var billingContact: PKContact? { get set }
get · iOS 8.0+

countryCode

TypeScript
get countryCode(): string
Swift declaration
var countryCode: String { get set }
set · iOS 8.0+

countryCode

TypeScript
set countryCode(value: string)
Swift declaration
var countryCode: String { get set }
get · iOS 15.0+

couponCode

TypeScript
get couponCode(): (string) | null
Swift declaration
var couponCode: String? { get set }
set · iOS 15.0+

couponCode

TypeScript
set couponCode(value: (string) | null)
Swift declaration
var couponCode: String? { get set }
get · iOS 8.0+

currencyCode

TypeScript
get currencyCode(): string
Swift declaration
var currencyCode: String { get set }
set · iOS 8.0+

currencyCode

TypeScript
set currencyCode(value: string)
Swift declaration
var currencyCode: String { get set }
get · iOS 16.4+

deferredPaymentRequest

TypeScript
get deferredPaymentRequest(): (PKDeferredPaymentRequest) | null
Swift declaration
var deferredPaymentRequest: PKDeferredPaymentRequest? { get set }
set · iOS 16.4+

deferredPaymentRequest

TypeScript
set deferredPaymentRequest(value: (PKDeferredPaymentRequest) | null)
Swift declaration
var deferredPaymentRequest: PKDeferredPaymentRequest? { get set }
get · iOS 26.4+

isDelegatedRequest

TypeScript
get isDelegatedRequest(): boolean
Swift declaration
var isDelegatedRequest: Bool { get set }
set · iOS 26.4+

isDelegatedRequest

TypeScript
set isDelegatedRequest(value: boolean)
Swift declaration
var isDelegatedRequest: Bool { get set }
get · iOS 8.0+

merchantCapabilities

TypeScript
get merchantCapabilities(): PKMerchantCapability
Swift declaration
var merchantCapabilities: PKMerchantCapability { get set }
set · iOS 8.0+

merchantCapabilities

TypeScript
set merchantCapabilities(value: PKMerchantCapability)
Swift declaration
var merchantCapabilities: PKMerchantCapability { get set }
get · iOS 8.0+

merchantIdentifier

TypeScript
get merchantIdentifier(): string
Swift declaration
var merchantIdentifier: String { get set }
set · iOS 8.0+

merchantIdentifier

TypeScript
set merchantIdentifier(value: string)
Swift declaration
var merchantIdentifier: String { get set }
get · iOS 16.0+

multiTokenContexts

TypeScript
get multiTokenContexts(): Array<PKPaymentTokenContext>
Swift declaration
var multiTokenContexts: [PKPaymentTokenContext] { get set }
set · iOS 16.0+

multiTokenContexts

TypeScript
set multiTokenContexts(value: Array<PKPaymentTokenContext>)
Swift declaration
var multiTokenContexts: [PKPaymentTokenContext] { get set }
get · iOS 8.0+

paymentSummaryItems

TypeScript
get paymentSummaryItems(): Array<PKPaymentSummaryItem>
Swift declaration
var paymentSummaryItems: [PKPaymentSummaryItem] { get set }
set · iOS 8.0+

paymentSummaryItems

TypeScript
set paymentSummaryItems(value: Array<PKPaymentSummaryItem>)
Swift declaration
var paymentSummaryItems: [PKPaymentSummaryItem] { get set }
get · iOS 16.0+

recurringPaymentRequest

TypeScript
get recurringPaymentRequest(): (PKRecurringPaymentRequest) | null
Swift declaration
var recurringPaymentRequest: PKRecurringPaymentRequest? { get set }
set · iOS 16.0+

recurringPaymentRequest

TypeScript
set recurringPaymentRequest(value: (PKRecurringPaymentRequest) | null)
Swift declaration
var recurringPaymentRequest: PKRecurringPaymentRequest? { get set }
get · iOS 8.0+ · Deprecated in iOS 11.0

requiredBillingAddressFields

TypeScript
get requiredBillingAddressFields(): PKAddressField
Swift declaration
var requiredBillingAddressFields: PKAddressField { get set }
set · iOS 8.0+ · Deprecated in iOS 11.0

requiredBillingAddressFields

TypeScript
set requiredBillingAddressFields(value: PKAddressField)
Swift declaration
var requiredBillingAddressFields: PKAddressField { get set }
get · iOS 11.0+

requiredBillingContactFields

TypeScript
get requiredBillingContactFields(): Array<PKContactField>
Swift declaration
var requiredBillingContactFields: Set<PKContactField> { get set }
set · iOS 11.0+

requiredBillingContactFields

TypeScript
set requiredBillingContactFields(value: Array<PKContactField>)
Swift declaration
var requiredBillingContactFields: Set<PKContactField> { get set }
get · iOS 8.0+ · Deprecated in iOS 11.0

requiredShippingAddressFields

TypeScript
get requiredShippingAddressFields(): PKAddressField
Swift declaration
var requiredShippingAddressFields: PKAddressField { get set }
set · iOS 8.0+ · Deprecated in iOS 11.0

requiredShippingAddressFields

TypeScript
set requiredShippingAddressFields(value: PKAddressField)
Swift declaration
var requiredShippingAddressFields: PKAddressField { get set }
get · iOS 11.0+

requiredShippingContactFields

TypeScript
get requiredShippingContactFields(): Array<PKContactField>
Swift declaration
var requiredShippingContactFields: Set<PKContactField> { get set }
set · iOS 11.0+

requiredShippingContactFields

TypeScript
set requiredShippingContactFields(value: Array<PKContactField>)
Swift declaration
var requiredShippingContactFields: Set<PKContactField> { get set }
get · iOS 8.0+ · Deprecated in iOS 9.0

shippingAddress

TypeScript
get shippingAddress(): (unknown) | null
Swift declaration
unowned(unsafe) var shippingAddress: ABRecord? { get set }
set · iOS 8.0+ · Deprecated in iOS 9.0

shippingAddress

TypeScript
set shippingAddress(value: (unknown) | null)
Swift declaration
unowned(unsafe) var shippingAddress: ABRecord? { get set }
get · iOS 9.0+

shippingContact

TypeScript
get shippingContact(): (PKContact) | null
Swift declaration
var shippingContact: PKContact? { get set }
set · iOS 9.0+

shippingContact

TypeScript
set shippingContact(value: (PKContact) | null)
Swift declaration
var shippingContact: PKContact? { get set }
get · iOS 15.0+

shippingContactEditingMode

TypeScript
get shippingContactEditingMode(): PKShippingContactEditingMode
Swift declaration
var shippingContactEditingMode: PKShippingContactEditingMode { get set }
set · iOS 15.0+

shippingContactEditingMode

TypeScript
set shippingContactEditingMode(value: PKShippingContactEditingMode)
Swift declaration
var shippingContactEditingMode: PKShippingContactEditingMode { get set }
get · iOS 8.0+

shippingMethods

TypeScript
get shippingMethods(): (Array<PKShippingMethod>) | null
Swift declaration
var shippingMethods: [PKShippingMethod]? { get set }
set · iOS 8.0+

shippingMethods

TypeScript
set shippingMethods(value: (Array<PKShippingMethod>) | null)
Swift declaration
var shippingMethods: [PKShippingMethod]? { get set }
get · iOS 8.3+

shippingType

TypeScript
get shippingType(): PKShippingType
Swift declaration
var shippingType: PKShippingType { get set }
set · iOS 8.3+

shippingType

TypeScript
set shippingType(value: PKShippingType)
Swift declaration
var shippingType: PKShippingType { get set }
get · iOS 11.0+

supportedCountries

TypeScript
get supportedCountries(): (Array<string>) | null
Swift declaration
var supportedCountries: Set<String>? { get set }
set · iOS 11.0+

supportedCountries

TypeScript
set supportedCountries(value: (Array<string>) | null)
Swift declaration
var supportedCountries: Set<String>? { get set }
get · iOS 8.0+

supportedNetworks

TypeScript
get supportedNetworks(): Array<PKPaymentNetwork>
Swift declaration
var supportedNetworks: [PKPaymentNetwork] { get set }
set · iOS 8.0+

supportedNetworks

TypeScript
set supportedNetworks(value: Array<PKPaymentNetwork>)
Swift declaration
var supportedNetworks: [PKPaymentNetwork] { get set }
get · iOS 15.0+

supportsCouponCode

TypeScript
get supportsCouponCode(): boolean
Swift declaration
var supportsCouponCode: Bool { get set }
set · iOS 15.0+

supportsCouponCode

TypeScript
set supportsCouponCode(value: boolean)
Swift declaration
var supportsCouponCode: Bool { get set }
get · iOS 27.0+

unsupportedPrimaryAccountIdentifiers

TypeScript
get unsupportedPrimaryAccountIdentifiers(): Array<string>
Swift declaration
var unsupportedPrimaryAccountIdentifiers: [String] { get set }
set · iOS 27.0+

unsupportedPrimaryAccountIdentifiers

TypeScript
set unsupportedPrimaryAccountIdentifiers(value: Array<string>)
Swift declaration
var unsupportedPrimaryAccountIdentifiers: [String] { get set }
get · iOS 18.0+

merchantCategoryCode

TypeScript
get merchantCategoryCode(): (PKPaymentRequest_MerchantCategoryCode) | null
Swift declaration
var merchantCategoryCode: PKPaymentRequest.MerchantCategoryCode? { get set }
set · iOS 18.0+

merchantCategoryCode

TypeScript
set merchantCategoryCode(value: (PKPaymentRequest_MerchantCategoryCode) | null)
Swift declaration
var merchantCategoryCode: PKPaymentRequest.MerchantCategoryCode? { get set }
get · iOS 17.0+

applePayLaterAvailability

TypeScript
get applePayLaterAvailability(): PKPaymentRequest_ApplePayLaterAvailability
Swift declaration
var applePayLaterAvailability: PKPaymentRequest.ApplePayLaterAvailability { get set }
set · iOS 17.0+

applePayLaterAvailability

TypeScript
set applePayLaterAvailability(value: PKPaymentRequest_ApplePayLaterAvailability)
Swift declaration
var applePayLaterAvailability: PKPaymentRequest.ApplePayLaterAvailability { get set }
static · iOS 15.0+

paymentCouponCodeExpiredError

TypeScript
static paymentCouponCodeExpiredError(localizedDescription?: (string) | null): NativeError
Swift declaration
static func paymentCouponCodeExpiredError(localizedDescription: String? = nil) -> any Error
static · iOS 15.0+

paymentCouponCodeInvalidError

TypeScript
static paymentCouponCodeInvalidError(localizedDescription?: (string) | null): NativeError
Swift declaration
static func paymentCouponCodeInvalidError(localizedDescription: String? = nil) -> any Error

Skipped declarations

No declarations were skipped in this snapshot.

All PassKit types →