iOS SDK - Payment Account Objects
Account Domain Objects
Objects within the Account
domain define data that relates to payment accounts registered as valid tender for a WLW mobile wallet.
PDAccountBalance
Defines the current balance for a particular payment account using the following properties:
Property | Description |
---|---|
availableBalance |
String For debit or gift card type payment accounts, the amount of money currently available. |
availableCredit |
String For credit card payment accounts, the amount of credit currently available for charging. |
accountBalanceAsOfDate |
NSDate The date on which the currently displayed account balance was retrieved. |
messagesDescriptions |
String The plain language message associated with the response status ( Success or Failure ). |
additionalData |
Array Set of PDAdditionalBalanceData instances that define custom metadata properties to provide relevant data about the account balance, such as the currency. |
PDAccountIdentifier
Identifies a particular payment account registered to a wallet.
Property | Description |
---|---|
accountUri |
String The unique account ID assigned by WLW to a registered payment account. |
paymentAccountTypeUri |
String The unique identifier representing the type of payment account, such as credit, debit, or gift. |
cardNumber |
String The payment account’s card identification. This attribute is further characterized by the PDMetaData values:key =CARD_NUMBER value = Must not be null/empty if required.name = Card Number dataType = NSString required = YES minLength = 1 maxLength = 12 pciEncryptionRequired = YES updatesAllowed = NO maskingRequired = YES dataGroup = CARD_INFORMATION |
PDAdditionalBalanceData
A dictionary key/value pair that defines a custom metadata property that expands the definition of an account balance instance.
Property | Description |
---|---|
additionalBalanceDataKey |
String The name of the property defined by this instance, for example, balanceCurrency . |
additionalBalanceDataValue |
String The value of the property, for example, CAD . |
PDAdditionalEnrollmentData
Defines a supplemental property that the network auth service has requested in order to continue processing a variable-step account enrollment.
Property | Description |
---|---|
additionalEnrollmentDataKey |
String The name of the metadata property that this object represents, for example, creditScore . |
additionalEnrollmentDataValue |
String The value of the property, as provided by the user, for example, 860 . |
payload |
NSData A container for the raw data that is returned from or sent to an external processor. The app developer must generate this object and WLW will transmit it between the processor and the device as is, without performing any processing. |
additionalData |
Array The set of PDAdditionalEnrollmentDataAdditionalData instances representing properties that augment the requested enrollment data property, for example, creditBureau or scoreDate . |
PDAdditionalEnrollmentDataAdditionalData
A custom metadata property that further defines a requested additionalEnrollmentData
property, such as by specifying a required length
or dataType
.
Property | Description |
---|---|
additionalDataKey |
String The name of the property defined by this instance, for example, creditAgency . |
additionalDataValue |
String The value of the property, for example, Experian . |
PDExtendedPaymentInstrument
A set of custom key/value properties that provides needful information specific to a payment account during payment processing.
Note: When specifying payment tenders in
updateTransaction
, populate only theextendedPaymentInstruments
ORpaymentAccounts
attribute. If both are included,extendedPaymentInstruments
data is ignored.
Property | Description |
---|---|
paymentAccountUri |
String WLW’s unique identifier for the registered payment account in the wallet that is extended by the custom metadata defined in this object. |
extendedPaymentTenderData |
Array The set of PDExtendedPaymentTenderData instances that each define a custom metadata property relevant for the specified payment instrument. |
amount |
NSNumber The dollar amount of the relevant payment using this tender. |
currencyCode |
String The code that identifies the monetary unit of the amount, as recognized by the ISO 4217 standard, for example, USD = United States Dollar. |
PDExtendedPaymentTenderData
A metadata property that specifies a data property’s use related to the payment tender it defines.
Property | Description |
---|---|
extendedPaymentTenderDataKey |
String The name of the property defined by this instance, for example, required . |
extendedPaymentTenderDataValue |
String The value of the property in the relevant context, for example, TRUE . |
PDIssuingPartner
Identifies the entity within the WLW platform by which the mobile wallet app is proffered.
Property | Description |
---|---|
issuingPartnerUri |
String WLW’s unique identifier for a wallet issuer for which a specific load configuration is defined. |
issuingPartnerName |
String The name of the wallet issuer for which the load configuration properties are relevant. |
partnerUri |
String WLW’s unique identifier of the partner through which the wallet issuer is registered. |
PDLoadExistingAccount
Defines an existing payment account within the mobile wallet to which a payment is being made to increase the available balance.
Property | Description |
---|---|
loadingAccountUri |
String Uniquely identifies the payment account onto which a balance increase is being loaded. |
PDLoadNewAccount
Defines a newly provisioned payment account onto which a starting balance is being loaded from an existing payment account in the mobile wallet.
Property | Description |
---|---|
loadNewAccountType |
PDLoadNewAccountType A data object that uniquely identifies the nature of the payment account, such as a credit card, debit card, or gift card, that is being loaded. This object instance populates the property loadNewAccountTypeUri . |
loadNewAccountNetworkType |
PDLoadNewAccountNetworkType A data object that uniquely identifies the network processor (for example, Visa, Mastercard, etc.) that provides the authorization services for the payment account. This object instance populates the property loadNewAccountNetworkTypeUri . |
additionalData |
Array A set of PDLoadNewAccountAdditionalData dictionary objects, each of which represents a key/value property definition providing information relevant to the account to be loaded that is not otherwise captured. For example, loadNewAccountAdditionalDataKey = autoReload loadNewAccountAdditionalDataValue = TRUE . |
PDLoadNewAccountAdditionalData
A custom property that is relevant for a payment account transfer.
Property | Description |
---|---|
loadNewAccountAdditionalDataKey |
String The name of the metadata property that this object represents, for example, autoReload . |
loadNewAccountAdditionalDataValue |
String The value ascribed to this property for the particular provisioned account, for example, TRUE . |
PDPaymentAccount
Defines a particular payment account registered to a mobile wallet.
Note: When specifying payment tenders in
updateTransaction
, populate only theextendedPaymentInstruments
ORpaymentAccounts
attribute. If both are included, theextendedPaymentInstruments
data is ignored.
Property | Description |
---|---|
accountIdentifier |
PDAccountIdentifier A complex property imported with the account identifier object. |
accountImage |
UIImage The image file corresponding to the payment account. |
accountImageUri |
String The unique identifier of the image associated with the payment account. |
accountStatusDescription |
String The plain language description of the payment account status (for example, active). |
additionalData |
Array The set of metadata objects that defines the payment account, each of which contains the attributes that define a particular property of information about the payment account. Information might include whether the property is required or its minimum and maximum field lengths, as defined by the property’s PDMetaData configuration. |
paymentAccountAvailableBalance |
NSNumber For debit or gift card type payment accounts, the amount of money currently available. |
paymentAccountAvailableCredit |
NSNumber For credit card payment accounts, the amount of credit currently available for charging. |
accountBalanceAsOfDate |
NSDate An instance of NSDate timestamp representing the date on which the currently displayed account balance was retrieved. |
balanceUpdateStatusMessage |
String The text that appears in the Account List in the app regarding the status of the balance update action. |
balanceUpdateStatusCode |
Integer The numerical representation of the status of the balance refresh action. |
isBalanceUpdated |
Boolean Specifies whether the values for the balance related attributes are current at the time this object is returned. Since balance refresh calls are not automatically executed each time this object is returned (due to possible fees levied for such activity) this attribute allows the app developer to determine whether the balance requires updating, depending on the originating call that returns this object. |
billingAddress |
PDAddressInformation A complex property imported with the billing address information object. |
currencyUri |
String The type of currency defined for the payment account. The default PDMetaData values for this property are:@Key = CURRENCY_CODE @Value = Must not be null/empty if required.@Name = Currency Code @Type = NSString @Is Required = NO @Minimum Length = 0br @Maximum Length= 10@Can be used to create = NO @Can be used while updating = NO |
accountVerificationStatus |
PDAccountStatus EnumThe current status of the payment account. |
cvv |
String The payment account security code. The default PDMetaData values for this property are:@Key = SECURITY_CODE @Value = Must not be null/empty if required@Name = Security Code @Type = NSString @Is Required = NO @Minimum Length = 0 @Maximum Length = 4 @Can be used to create = YES @Can be used while updating = YES Note: For security reasons, this attribute is not populated in retrieval methods. |
paymentAccountDiscountedPrice |
NSNumber The total amount due after subtracting the preferred payment account discount. |
displayName |
String The payment account name as it appears in the app Account list. |
displayWarning |
Boolean Specifies whether the app displays a notification message when this account is nearing its expiration date. |
accountExpirationDate |
NSDate An instance of NSDate timestamp representing the date on which the relevant payment account will no longer be valid for use. |
financialInstitutionUri |
String The issuer of the payment account. |
holderName |
String The full name of the owner of the payment account. Default PDMetaData values for this property are:@Key = HOLDER_NAME @Value = Must not be null/empty if required @Name = Holder Name @Type = NSString @Is Required = NO @Minimum Length = 0 @Maximum Length = 50 @Can be used to create = YES @Can be used while updating = YES |
maskedAccountNumber |
String The payment account card number as it appears when hidden (for example, XXX XXXX 563 ). |
nickname |
String The personal nickname given to the payment account by the user. The default PDMetaData values for this property are:@Key = NICK_NAME @Value = Must not be null/empty if required @Name = Nickname @Type = NSString @Is Required = NO @Minimum Length = 1 @Maximum Length = 12 @Can be used to create = YES @Can be used while updating = YES |
paydiantTransactionRefId |
String WLW’s unique identifier for the transaction. |
paymentAccountExpirationStatus |
PDPaymentAccountExpirationStatus EnumThe current expiration status of the payment account. |
paymentAccountsSortBy |
PDPaymentAccountsSortBy The payment account attribute by which the payment accounts should be sorted in the wallet. |
paymentAccountType |
PDPaymentAccountType The object that defines the type of card associated with the payment account. |
paymentAccountNetworkType |
PDPaymentAccountNetworkType Defines the network processor associated with the payment account. |
PDPaymentAccountConfigurations
Specifies how data is supported related to certain payment account property values.
Property | Description |
---|---|
years |
Dictionary An iOS dictionary containing the set of years where the key is the year and the value is the display name (for example, 2012 = Year 2012 ). |
locations |
PDLocation The WLW dictionary containing the list of location objects for use by the billing address object of a payment account. |
months |
Dictionary An iOS dictionary containing the set of month names where the key is the month and the value is the display name; for example, January = Jan. |
imageSelectionEnabled |
Boolean Specifies if the user is permitted to select a personalized image for a specific payment account. |
PDPaymentAccountEnrollment
Identifies a specific instance of a variable-step payment account enrollment process.
Property | Description |
---|---|
enrollmentState |
PDEnrollmentState EnumThe current state of the enrollment process. |
paydiantCorrelationId |
String WLW’s unique identifier of the enrollment process. This ID must be passed with each step in order to ensure all data is correctly associated. |
externalCorrelationId |
String The processors unique identifier for the enrollment process. This ID must be passed in each step of the process. |
additionalEnrollmentData |
Array The set of PDAdditionalEnrollmentData that indicates the properties specified by the processor as required for the enrollment. |
PDPaymentAccountImage
Defines an image artifact associated with a payment account.
Property | Description |
---|---|
accountIdentifier |
PDAccountIdentifier Set of properties that identifies the payment account assocaited with this image. |
imageId |
String WLW’s unique identifier for the image. |
imageLabel |
String The text that identifies the image. |
imagePath |
String The relative path of the image location within the images directory. |
imageUrl |
String The complete server location of the image, including the filename. |
imageLocation |
String The relative path of the image location within the images directory, including the image filename. |
imageFileName |
String The complete file name, including extension, of the image. |
PDPaymentAccountNetworkType
Identifies a supported payment account processing network within the WLW platform.
Property | Description |
---|---|
paymentAccountNetworkTypeName |
String The plain language descriptor of the payment processor, such as VISA or Mastercard. |
paymentAccountNetworkTypeUri |
String The unique identifier for the payment processor. |
PDPaymentAccountType
Identifies a supported payment account type within the WLW platform.
Property | Description |
---|---|
paymentAccountTypeName |
String The plain language descriptor of the payment account type, such as GIFT or CREDIT . |
paymentAccountTypeUri |
String The unique identifier for the payment account type. |
PDPaymentAccountsConstants
The set of payment accounts registered to a particular mobile wallet.
Property | Description |
---|---|
paymentAccountList |
Array The collection of payment accounts registered to a mobile wallet, listed by unique account identifier. |
PDProvisionAccount
Defines a payment account for which WLW is not the system of record that is being provisioned for use in a mobile wallet.
Property | Description |
---|---|
paymentAccountType |
PDPaymentAccountType Defines the account payment type, for example, credit, or debit. |
paymentAccountNetworkType |
PDPaymentAccountNetworkType The object that defines the network processor associated with the payment account (for example, Visa, Mastercard, PayPal, NYCE, etc.). |
paymentAccountUri |
String The unique account ID assigned by WLW to a registered payment account. |
provisionAccountAdditionalData |
Array A set of PDProvisionAccountAdditionalData objects defining key/value properties for information relevant to the provisioned account that is not otherwise captured. For example; rewardLevel = silver . |
PDProvisionAccountAdditionalData
A custom property that captures data required to provision a payment account for a mobile wallet.
Property | Description |
---|---|
provisionAccountAdditionalDataKey |
String The name of the metadata property that this object represents, for example, rewardLevel . |
provisionAccountAdditionalDataValue |
String The value ascribed to this property for the particular provisioned account, for example, Platinum . |
PDProvisionAccountNetworkType
A specific network processor supported in the WLW platform.
Property | Description |
---|---|
paymentAccountNetworkTypeUri |
String The code identifier of the payment network types available for this loyalty program, for example, Paydiant.LoyaltyAccNetwork . |
PDProvisionAccountType
A specific payment account type supported in the WLW platform.
Property | Description |
---|---|
paymentAccountTypeUri |
String The code identifier of the payment account tender type; for example, credit or debit . |
PDTenderLoadSpecification
The supported configurations for transferring a balance to a payment account of a specific tender type.
Property | Description |
---|---|
paymentAccountType |
PDPaymentAccountType The object that defines the type of card associated with the payment account, for example, credit, debit, gift. |
paymentAccountNetworkType |
PDPaymentAccountNetworkType Defines the network processor associated with the payment account. |
issuingPartner |
PDIssuingPartner Defines the issuer of the mobile wallet to which this specification applies. |
currencyCode |
String The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar. |
eligibleValues |
Array A comma-delimited list of double values representing the dollar amounts that are supported denominations for loading a payment account (for example, 25.00,50.00,75.00,100.00 ). |
supportedPaymentTenders |
Array The set of PDPaymentTender objects for the types of tender that can be used as the payment source for the loading transaction. |
provisioningSupported |
Boolean Specifies if the balance loading transaction is allowed to occur in conjunction with the generation of a new payment account. |
Account Message Objects
PDAddPaymentAccountRequest
The required information to register a payment account as a supported tender in the mobile wallet where WLW is the system of record for the account.
Property | Description |
---|---|
paymentAccountTypeUri |
String The unique identifier representing the type of payment account, such as credit , debit , or gift . |
paymentAccountNetworkTypeUri |
String The code identifier of the payment account processor, for example, Visa , Mastercard , etc. |
metaData |
Array The set of PDAccountMetaData instances that define each property required by the issuer to authorize the payment account in the wallet. |
PDAddPaymentAccountResponse
The information returned by the WLW platform in the success response to the add payment account operation.
Property | Description |
---|---|
paymentAccountTypeUri |
String The unique identifier representing the type of payment account, such as credit , debit , or gift . |
paymentAccountNetworkTypeUri |
String The code identifier of the payment account processor (for example, Visa , Mastercard , etc.). |
paymentAccountUri |
String The unique identifier created for the current session to represent that payment account in the WLW-managed service. |
message |
String A text message from the server communicating the status of the request completion. |
additionalData |
Array A set of dictionary key/value pairs that provides additional information about the payment account creation, as defined by the app developer. |
PDUpdatePaymentAccountRequest
The required information to update editable properties of an existing payment account.
Property | Description |
---|---|
paymentAccountUri |
String The unique identifier of the account to be modified during the current session. |
metaData |
Array The set of PDAccountMetaData instances that defines each property to update and their new values. |
PDUpdatePaymentAccountResponse
The information returned by the WLW platform in the success response to the update payment account operation.
Property | Description |
---|---|
paymentAccountUri |
String The unique identifier created for the current session to represent that payment account in the WLW-managed service. |
message |
String A text message from the server communicating the status of the request completion. |
additionalData |
Array A set of dictionary key/value pairs that provides additional information about the payment account creation, as defined by the app developer. |
PDRetrieveSpecificPaymentAccountRequest
The required information to request data related to an existing payment account in the WLW system.
Property | Description |
---|---|
paymentAccountUri |
String WLW’s unique identifier for the payment account record. A loyaltyProgramUri is also a valid value for this property. |
includeMetaData |
Boolean Specifies whether the returned account data should include each property’s metadata. The default value is FALSE . |
PDRetrieveSpecificPaymentAccountResponse
The information returned by the WLW platform in the success response to the retrieve payment account operation.
Property | Description |
---|---|
paymentAccountTypeUri |
String The unique identifier representing the type of payment account, such as credit , debit , or gift . |
paymentAccountNetworkTypeUri |
String The code identifier of the paymentaccount processor, for example, Visa , Mastercard , etc. |
paymentAccountUri |
String WLW’s unique identifier for the payment account. |
accountBalance |
PDAccountBalance The object containing the attributes that define the current account balance and the timestamp. |
paymentAccountState |
String The current status of the payment account, for example, ACTIVE ). |
accountVerificationStatus |
String Specifies at what stage of verification the payment account is, for example, IN PROCESS . |
balanceUpdates |
Boolean Specifies if the payment account can receive balance updates. |
displayWarning |
Boolean Specifies if the app should indicate when the payment account is due to expire. |
additionalData |
Array A set of PDAccountMetaData instances representing custom properties related to the retrieved account. |
PDRetrieveAllPaymentAccountsRequest
The required information to request data related to all existing payment accounts in the WLW system for the calling mobile wallet account.
Property | Description |
---|---|
includeMetaData |
Boolean Specifies whether the returned account data should include each property’s metadata. The default value is FALSE . |
PDRetrieveAllPaymentAccountsResponse
The information returned by the WLW platform in the success response to the retrieve payment accounts operation.
Property | Description |
---|---|
paymentAccounts |
Array The set of PDPaymentAccount objects representing each registered payment account for the wallet. |
PDProvisionAccountRequest
The provision account request object specifies the account type and account network type for the new card, as well as any PDAccountMetaData
properties (inherited from PDRequest
) required to generate a new account in the wallet user’s name based on the requirements for the specified account type.
Property | Description |
---|---|
provisionAccountType |
PDProvisionAccountType Uniquely identifies the type of payment account being provisioned, such as credit , debit , loyalty , or gift . |
provisionAccountNetworkType |
PDProvisionAccountNetworkType Uniquely identifies the payment processor for the account being provisioned, such as Visa , Amex , etc.). |
PDProvisionAccountResponse
The provision account response object returns the result of the provision account request from the server.
Property | Description |
---|---|
provisionedAccount |
PDProvisionAccount Defines the metadata for the provisioned account. |
externalStatusCode |
String The unique identifier of the status, as communicated by a relevant external entity, such as the network processor. |
externalStatusDescription |
String The plain language description of the code represented in the corresponding externalStatusCode attribute. |
PDLoadNewAccountRequest
Provides the details relevant to the initial balance set for a newly provisioned payment account.
Property | Description |
---|---|
fundingPaymentAccountUri |
String WLW’s unique identifier for the payment account from which the money will be withdrawn to fund the new account. |
fundingExtendedPaymentInstrument |
PDExtendedPaymentInstrument Defines additional relevant payment data for the funding payment account. |
loadingAccount |
PDLoadNewAccount Uniquely identifies the payment account that will receive the "payment" to set its initial balance. |
currencyCode |
String The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar. |
loadAmount |
Decimal The amount of money to be added to the new payment account. |
PDLoadNewAccountResponse
Communicates the result of the PDLoadNewAccountRequest
from the server.
Property | Description |
---|---|
externalPaymentStatusCode |
String The numeric code returned in the payment processor response indicating the result of their processing of the payment authorization request. Possible values include: 200 - Approved Payment201 - Declined Payment202 - Settlement Failed203 - Insufficient Funds |
externalPaymentStatusDescription |
String Statement describing the processing result indicated by the externalStatusCode . |
balanceAmount |
NSNumber The starting balance with which the new account is to be provisioned. |
provisionedAccount |
PDProvisionAccount Uniquely identifies the new account that has been created and specifies its relevant details. |
PDLoadExistingAccountRequest
Provides the details relevant to a payment intended to add funds to the available balance of any existing payment account.
Property | Description |
---|---|
fundingPaymentAccountUri |
String WLW’s unique identifier for the payment account from which the money will be withdrawn to fund the loading transaction. |
fundingExtendedPaymentInstrument |
PDExtendedPaymentInstrument An instance of the object that defines additional relevant payment data for the funding payment account. |
loadingAccount |
PDLoadExistingAccount Uniquely identifies the payment account that will receive the "payment" to increase its available balance. |
currencyCode |
String The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar. |
loadAmount |
Decimal The amount of money to be added to the payment account. |
PDLoadExistingAccountResponse
Communicates the result of the PDLoadExistingAccountRequest
from the server.
Property | Description |
---|---|
externalPaymentStatusCode |
String The numerical code returned in the payment processor response indicating the result of their processing of the payment authorization request. |
externalPaymentStatusDescription |
String Statement describing the processing result indicated by the externalStatusCode . |
balanceAmount |
NSNumber The starting balance with which the new account is to be provisioned. |
PDRetrieveLoadConfigurationRequest
The load configuration request object provides the information that allows the developer to obtain the requirements relevant to loading a payment account of the specified type and network.
Property | Description |
---|---|
loadConfigurationAccountType |
PDLoadConfigurationAccountType A container for the loadNewAccountTypeUri value that identifies the registered account type (credit , gift , loyalty , etc.) for which the load configuration settings are requested. |
loadConfigurationAccountNetworkType |
PDLoadConfigurationAccountNetworkType A container for the paymentAccountNetworkTypeUri value that identifies the registered network (NYCE , VISA , AMEX , etc.) for which the load configuration settings are requested. |
PDRetrieveLoadConfigurationResponse
Returns the result of the retrieve load configuration request from the server.
Property | Description |
---|---|
loadSpecifications |
Array The set of PDTenderLoadSpecification objects for each individual configuration that is supported for the account loading event. |
PDStartPaymentAccountEnrollmentRequest
Initiates a variable-step process in which a payment instrument is added to the wallet as a valid tender for mobile payments.
Property | Description |
---|---|
enrollmentType |
PDEnrollmentType EnumSpecifies if the payment account to be enrolled is an existing account in the user’s name or a new provisioning request. |
paymentAccountTypeUri |
String WLW’s unique identifier of the payment account tender type. |
paymentAccountNetworkTypeUri |
String The unique identifier of the external processor that will authorize settlement on this account, for example, Visa or Mastercard. |
additionalData |
Array The set of PDStartPaymentAccountEnrollmentAdditionalData instances for custom properties relevant to starting the particular enrollment process. |
PDStartPaymentAccountEnrollmentResponse
Returns the result of the enrollment request, which may include a request for more information, thus mitigating another step, or may conclude the enrollment.
Property | Description |
---|---|
paymentAccountEnrollment |
PDPaymentAccountEnrollment Tracks the progress of the enrollment through its completion. |
PDStartPaymentAccountEnrollmentAdditionalData
Passes custom data about the particular enrollment process.
Property | Description |
---|---|
additionalDataKey |
String The name of the property defined by this instance, for example, gender . |
additionalDataValue |
String The value of the property, for example, female . |
PDRetrieveIncompletePaymentAccountEnrollmentsResponse
Returns the list of payment account enrollment instances which were started, but not completed.
Property | Description |
---|---|
paymentAccountEnrollments |
Array The set of PDPaymentAccountEnrollment instances of enrollments that were initiated but never completed. |
PDContinuePaymentAccountEnrollmentRequest
Initiates a variable-step process in which a payment instrument is added to the wallet as a valid tender for mobile payments.
Property | Description |
---|---|
paydiantCorrelationId |
String WLW’s unique identifier for the enrollment process. This ID must be passed with each step in order to ensure all data is correctly associated. |
externalCorrelationId |
String The processor's unique identifier for the enrollment process. This ID must be passed in each step of the process. |
additionalEnrollmentData |
Array The set of PDAdditionalEnrollmentData instances of the information required by the processor to continue the enrollment. Obtain these properties from the PDPaymentAccountEnrollment instances returned in the previous step of the enrollment and populate the values with data supplied by the user. |
PDContinuePaymentAccountEnrollmentResponse
Returns the result of the continuation request, which may conclude the enrollment or may specific additional information requirements, thus mitigating another step.
Property | Description |
---|---|
paymentAccountEnrollment |
PDPaymentAccountEnrollment Updated to convey the progress of the enrollment as of this step. |
PDCancelPaymentAccountEnrollmentRequest
Sets the enrollmentState
of the specified enrollment event to UserCancelled
per the wallet user’s request.
Property | Description |
---|---|
paydiantCorrelationId |
String WLW's unique identifier for the enrollment process. |
Account Enums
PDAccountStatus
Enum |
---|
kAccountVerified |
kAccountVerificationInitiated |
kAccountDeleted |
kAccountPendingVerification |
kAccountStatusUnknown (default) |
PDEnrollmentType
Enum |
---|
kPDEnrollmentTypeUnknown (default) |
kPDEnrollmentTypeLink |
kPDEnrollmentTypeProvision |
PDPaymentAccountExpirationStatus
Enum |
---|
kPaymentAccountExpirationStatusActive |
kPaymentAccountExpirationStatusAboutToExpire |
kPaymentAccountExpirationStatusExpired |
kPaymentAccountExpirationStatusUnknown (default) |
PDPaymentAccountsSortBy
Enum |
---|
kSortByNickName |
kSortByMaskedAccountNumber |
kSortByAvailableCredit |
kSortByAvailableBalance |
kSortByDiscountedAmount |
kDoNotSort (default) |
PDEnrollmentState
Enum |
---|
kPDEnrollmentStateUnknown (default) |
kPDEnrollmentStateStart |
kPDEnrollmentStateMoreInfo |
kPDEnrollmentStateEnd |
kPDEnrollmentStateExpired |
kPDEnrollmentStateUserCancelled |