BTThreeDSecureAdditionalInformation.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. #import <Foundation/Foundation.h>
  2. @class BTThreeDSecurePostalAddress;
  3. NS_ASSUME_NONNULL_BEGIN
  4. /**
  5. Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.
  6. */
  7. @interface BTThreeDSecureAdditionalInformation : NSObject
  8. /**
  9. Optional. The shipping address used for verification
  10. @see BTThreeDSecurePostalAddress
  11. */
  12. @property (nonatomic, nullable, copy) BTThreeDSecurePostalAddress *shippingAddress;
  13. /**
  14. Optional. The 2-digit string indicating the shipping method chosen for the transaction
  15. Possible Values:
  16. 01 Ship to cardholder billing address
  17. 02 Ship to another verified address on file with merchant
  18. 03 Ship to address that is different than billing address
  19. 04 Ship to store (store address should be populated on request)
  20. 05 Digital goods
  21. 06 Travel and event tickets, not shipped
  22. 07 Other
  23. */
  24. @property (nonatomic, nullable, copy) NSString *shippingMethodIndicator;
  25. /**
  26. Optional. The 3-letter string representing the merchant product code
  27. Possible Values:
  28. AIR Airline
  29. GEN General Retail
  30. DIG Digital Goods
  31. SVC Services
  32. RES Restaurant
  33. TRA Travel
  34. DSP Cash Dispensing
  35. REN Car Rental
  36. GAS Fueld
  37. LUX Luxury Retail
  38. ACC Accommodation Retail
  39. TBD Other
  40. */
  41. @property (nonatomic, nullable, copy) NSString *productCode;
  42. /**
  43. Optional. The 2-digit number indicating the delivery timeframe
  44. Possible values:
  45. 01 Electronic delivery
  46. 02 Same day shipping
  47. 03 Overnight shipping
  48. 04 Two or more day shipping
  49. */
  50. @property (nonatomic, nullable, copy) NSString *deliveryTimeframe;
  51. /**
  52. Optional. For electronic delivery, email address to which the merchandise was delivered
  53. */
  54. @property (nonatomic, nullable, copy) NSString *deliveryEmail;
  55. /**
  56. Optional. The 2-digit number indicating whether the cardholder is reordering previously purchased merchandise
  57. Possible values:
  58. 01 First time ordered
  59. 02 Reordered
  60. */
  61. @property (nonatomic, nullable, copy) NSString *reorderIndicator;
  62. /**
  63. Optional. The 2-digit number indicating whether the cardholder is placing an order with a future availability or release date
  64. Possible values:
  65. 01 Merchandise available
  66. 02 Future availability
  67. */
  68. @property (nonatomic, nullable, copy) NSString *preorderIndicator;
  69. /**
  70. Optional. The 8-digit number (format: YYYYMMDD) indicating expected date that a pre-ordered purchase will be available
  71. */
  72. @property (nonatomic, nullable, copy) NSString *preorderDate;
  73. /**
  74. Optional. The purchase amount total for prepaid gift cards in major units
  75. */
  76. @property (nonatomic, nullable, copy) NSString *giftCardAmount;
  77. /**
  78. Optional. ISO 4217 currency code for the gift card purchased
  79. */
  80. @property (nonatomic, nullable, copy) NSString *giftCardCurrencyCode;
  81. /**
  82. Optional. Total count of individual prepaid gift cards purchased
  83. */
  84. @property (nonatomic, nullable, copy) NSString *giftCardCount;
  85. /**
  86. Optional. The 2-digit value representing the length of time cardholder has had account.
  87. Possible values:
  88. 01 No account
  89. 02 Created during transaction
  90. 03 Less than 30 days
  91. 04 30-60 days
  92. 05 More than 60 days
  93. */
  94. @property (nonatomic, nullable, copy) NSString *accountAgeIndicator;
  95. /**
  96. Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder opened the account.
  97. */
  98. @property (nonatomic, nullable, copy) NSString *accountCreateDate;
  99. /**
  100. Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.
  101. Possible values:
  102. 01 Changed during transaction
  103. 02 Less than 30 days
  104. 03 30-60 days
  105. 04 More than 60 days
  106. */
  107. @property (nonatomic, nullable, copy) NSString *accountChangeIndicator;
  108. /**
  109. Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.
  110. */
  111. @property (nonatomic, nullable, copy) NSString *accountChangeDate;
  112. /**
  113. Optional. The 2-digit value representing the length of time since the cardholder changed or reset the password on the account.
  114. Possible values:
  115. 01 No change
  116. 02 Changed during transaction
  117. 03 Less than 30 days
  118. 04 30-60 days
  119. 05 More than 60 days
  120. */
  121. @property (nonatomic, nullable, copy) NSString *accountPwdChangeIndicator;
  122. /**
  123. Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder last changed or reset password on account.
  124. */
  125. @property (nonatomic, nullable, copy) NSString *accountPwdChangeDate;
  126. /**
  127. Optional. The 2-digit value indicating when the shipping address used for transaction was first used.
  128. Possible values:
  129. 01 This transaction
  130. 02 Less than 30 days
  131. 03 30-60 days
  132. 04 More than 60 days
  133. */
  134. @property (nonatomic, nullable, copy) NSString *shippingAddressUsageIndicator;
  135. /**
  136. Optional. The 8-digit number (format: YYYYMMDD) indicating the date when the shipping address used for this transaction was first used.
  137. */
  138. @property (nonatomic, nullable, copy) NSString *shippingAddressUsageDate;
  139. /**
  140. Optional. Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.
  141. */
  142. @property (nonatomic, nullable, copy) NSString *transactionCountDay;
  143. /**
  144. Optional. Number of transactions (successful or abandoned) for this cardholder account within the last year.
  145. */
  146. @property (nonatomic, nullable, copy) NSString *transactionCountYear;
  147. /**
  148. Optional. Number of add card attempts in the last 24 hours.
  149. */
  150. @property (nonatomic, nullable, copy) NSString *addCardAttempts;
  151. /**
  152. Optional. Number of purchases with this cardholder account during the previous six months.
  153. */
  154. @property (nonatomic, nullable, copy) NSString *accountPurchases;
  155. /**
  156. Optional. The 2-digit value indicating whether the merchant experienced suspicious activity (including previous fraud) on the account.
  157. Possible values:
  158. 01 No suspicious activity
  159. 02 Suspicious activity observed
  160. */
  161. @property (nonatomic, nullable, copy) NSString *fraudActivity;
  162. /**
  163. Optional. The 2-digit value indicating if the cardholder name on the account is identical to the shipping name used for the transaction.
  164. Possible values:
  165. 01 Account name identical to shipping name
  166. 02 Account name different than shipping name
  167. */
  168. @property (nonatomic, nullable, copy) NSString *shippingNameIndicator;
  169. /**
  170. Optional. The 2-digit value indicating the length of time that the payment account was enrolled in the merchant account.
  171. Possible values:
  172. 01 No account (guest checkout)
  173. 02 During the transaction
  174. 03 Less than 30 days
  175. 04 30-60 days
  176. 05 More than 60 days
  177. */
  178. @property (nonatomic, nullable, copy) NSString *paymentAccountIndicator;
  179. /**
  180. Optional. The 8-digit number (format: YYYYMMDD) indicating the date the payment account was added to the cardholder account.
  181. */
  182. @property (nonatomic, nullable, copy) NSString *paymentAccountAge;
  183. /**
  184. Optional. The 1-character value (Y/N) indicating whether cardholder billing and shipping addresses match.
  185. */
  186. @property (nonatomic, nullable, copy) NSString *addressMatch;
  187. /**
  188. Optional. Additional cardholder account information.
  189. */
  190. @property (nonatomic, nullable, copy) NSString *accountId;
  191. /**
  192. Optional. The IP address of the consumer. IPv4 and IPv6 are supported.
  193. */
  194. @property (nonatomic, nullable, copy) NSString *ipAddress;
  195. /**
  196. Optional. Brief description of items purchased.
  197. */
  198. @property (nonatomic, nullable, copy) NSString *orderDescription;
  199. /**
  200. Optional. Unformatted tax amount without any decimalization (ie. $123.67 = 12367).
  201. */
  202. @property (nonatomic, nullable, copy) NSString *taxAmount;
  203. /**
  204. Optional. The exact content of the HTTP user agent header.
  205. */
  206. @property (nonatomic, nullable, copy) NSString *userAgent;
  207. /**
  208. Optional. The 2-digit number indicating the type of authentication request.
  209. Possible values:
  210. 02 Recurring transaction
  211. 03 Installment transaction
  212. */
  213. @property (nonatomic, nullable, copy) NSString *authenticationIndicator;
  214. /**
  215. Optional. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.
  216. */
  217. @property (nonatomic, nullable, copy) NSString *installment;
  218. /**
  219. Optional. The 14-digit number (format: YYYYMMDDHHMMSS) indicating the date in UTC of original purchase.
  220. */
  221. @property (nonatomic, nullable, copy) NSString *purchaseDate;
  222. /**
  223. Optional. The 8-digit number (format: YYYYMMDD) indicating the date after which no further recurring authorizations should be performed.
  224. */
  225. @property (nonatomic, nullable, copy) NSString *recurringEnd;
  226. /**
  227. Optional. Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months (ex. 6 months = 168).
  228. */
  229. @property (nonatomic, nullable, copy) NSString *recurringFrequency;
  230. /**
  231. Optional. The 2-digit number of minutes (minimum 05) to set the maximum amount of time for all 3DS 2.0 messages to be communicated between all components.
  232. */
  233. @property (nonatomic, nullable, copy) NSString *sdkMaxTimeout;
  234. /**
  235. Optional. The work phone number used for verification. Only numbers; remove dashes, parenthesis and other characters.
  236. */
  237. @property (nonatomic, nullable, copy) NSString *workPhoneNumber;
  238. @end
  239. NS_ASSUME_NONNULL_END