PassKit · IOS API REFERENCE

PKDisbursementRequest

class · iOS 17.0+ · SDK 27.1

class PKDisbursementRequest

Members (27)

static · iOS 17.0+

disbursementCardUnsupportedError

TypeScript

static disbursementCardUnsupportedError(): NativeError

Swift declaration

class func disbursementCardUnsupportedError() -> any Error

static · iOS 17.0+

disbursementContactInvalidError

TypeScript

static disbursementContactInvalidError(field: PKContactField, localizedDescription?: (string) | null): NativeError

Swift declaration

class func disbursementContactInvalidError(withContactField field: PKContactField, localizedDescription: String?) -> any Error

get · iOS 17.0+

applicationData

TypeScript

get applicationData(): (ArrayBuffer) | null

Swift declaration

var applicationData: Data? { get set }

set · iOS 17.0+

applicationData

TypeScript

set applicationData(value: (ArrayBuffer) | null)

Swift declaration

var applicationData: Data? { 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 17.0+

merchantCapabilities

TypeScript

get merchantCapabilities(): PKMerchantCapability

Swift declaration

var merchantCapabilities: PKMerchantCapability { get set }

set · iOS 17.0+

merchantCapabilities

TypeScript

set merchantCapabilities(value: PKMerchantCapability)

Swift declaration

var merchantCapabilities: PKMerchantCapability { get set }

get · iOS 17.0+

merchantIdentifier

TypeScript

get merchantIdentifier(): string

Swift declaration

var merchantIdentifier: String { get set }

set · iOS 17.0+

merchantIdentifier

TypeScript

set merchantIdentifier(value: string)

Swift declaration

var merchantIdentifier: String { get set }

get · iOS 17.0+

recipientContact

TypeScript

get recipientContact(): (PKContact) | null

Swift declaration

var recipientContact: PKContact? { get set }

set · iOS 17.0+

recipientContact

TypeScript

set recipientContact(value: (PKContact) | null)

Swift declaration

var recipientContact: PKContact? { get set }

get · iOS 17.0+

requiredRecipientContactFields

TypeScript

get requiredRecipientContactFields(): Array<PKContactField>

Swift declaration

var requiredRecipientContactFields: [PKContactField] { get set }

set · iOS 17.0+

requiredRecipientContactFields

TypeScript

set requiredRecipientContactFields(value: Array<PKContactField>)

Swift declaration

var requiredRecipientContactFields: [PKContactField] { get set }

get · iOS 17.0+

summaryItems

TypeScript

get summaryItems(): Array<PKPaymentSummaryItem>

Swift declaration

var summaryItems: [PKPaymentSummaryItem] { get set }

set · iOS 17.0+

summaryItems

TypeScript

set summaryItems(value: Array<PKPaymentSummaryItem>)

Swift declaration

var summaryItems: [PKPaymentSummaryItem] { get set }

get · iOS 17.0+

supportedNetworks

TypeScript

get supportedNetworks(): Array<PKPaymentNetwork>

Swift declaration

var supportedNetworks: [PKPaymentNetwork] { get set }

set · iOS 17.0+

supportedNetworks

TypeScript

set supportedNetworks(value: Array<PKPaymentNetwork>)

Swift declaration

var supportedNetworks: [PKPaymentNetwork] { 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 17.0+

supportedRegions

TypeScript

get supportedRegions(): (Array<_Foundation_Locale_Region>) | null

Swift declaration

var supportedRegions: [Locale.Region]? { get set }

When provided, filters the selectable payment passes to those issued in the supported regions. The order of the elements is ignored.

set · iOS 17.0+

supportedRegions

TypeScript

set supportedRegions(value: (Array<_Foundation_Locale_Region>) | null)

Swift declaration

var supportedRegions: [Locale.Region]? { get set }

When provided, filters the selectable payment passes to those issued in the supported regions. The order of the elements is ignored.

init · iOS 17.0+

init

TypeScript

static init(merchantIdentifier: string, currency: _Foundation_Locale_Currency, region: _Foundation_Locale_Region, supportedNetworks: Array<PKPaymentNetwork>, merchantCapabilities: PKMerchantCapability, summaryItems: Array<PKPaymentSummaryItem>): PKDisbursementRequest

Swift declaration

convenience init(merchantIdentifier: String, currency: Locale.Currency, region: Locale.Region, supportedNetworks: [PKPaymentNetwork], merchantCapabilities: PKMerchantCapability, summaryItems: [PKPaymentSummaryItem])

get · iOS 17.0+

region

TypeScript

get region(): _Foundation_Locale_Region

Swift declaration

var region: Locale.Region { get set }

The region the merchant operates in.

set · iOS 17.0+

region

TypeScript

set region(value: _Foundation_Locale_Region)

Swift declaration

var region: Locale.Region { get set }

The region the merchant operates in.

get · iOS 17.0+

currency

TypeScript

get currency(): _Foundation_Locale_Currency

Swift declaration

var currency: Locale.Currency { get set }

The currency in which the disbursement will be conducted.

set · iOS 17.0+

currency

TypeScript

set currency(value: _Foundation_Locale_Currency)

Swift declaration

var currency: Locale.Currency { get set }

The currency in which the disbursement will be conducted.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

PKDisbursementRequest.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All PassKit types →