first_data_gateway 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (481) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +79 -0
  3. data/README.md +69 -39
  4. data/docs/AVSResponse.md +2 -2
  5. data/docs/AccessTokenResponse.md +2 -2
  6. data/docs/AccountUpdaterResponse.md +12 -0
  7. data/docs/AdditionalAmountRate.md +2 -2
  8. data/docs/AdditionalDetails.md +10 -0
  9. data/docs/AdditionalTransactionDetails.md +3 -3
  10. data/docs/Address.md +7 -7
  11. data/docs/Airline.md +12 -12
  12. data/docs/AirlineAncillaryServiceCategory.md +1 -1
  13. data/docs/AirlineTravelRoute.md +4 -4
  14. data/docs/AliPay.md +2 -2
  15. data/docs/{SecondaryTransactionAdditionalDetails.md → AliPayPaymentMethod.md} +2 -2
  16. data/docs/AliPaySaleTransaction.md +14 -0
  17. data/docs/Amount.md +2 -2
  18. data/docs/AmountComponents.md +6 -7
  19. data/docs/Authentication.md +8 -0
  20. data/docs/AuthenticationApi.md +12 -12
  21. data/docs/AuthenticationRedirect.md +10 -0
  22. data/docs/AuthenticationRedirectParams.md +10 -0
  23. data/docs/AuthenticationVerificationRequest.md +11 -0
  24. data/docs/BasicResponse.md +1 -1
  25. data/docs/Billing.md +3 -5
  26. data/docs/BillingAddress.md +4 -4
  27. data/docs/BillingAddressPhone.md +1 -1
  28. data/docs/CarRental.md +6 -6
  29. data/docs/CarRentalExtraCharges.md +1 -1
  30. data/docs/Card.md +6 -6
  31. data/docs/CardFunction.md +7 -0
  32. data/docs/CardInfo.md +2 -2
  33. data/docs/CardInfoLookupApi.md +14 -14
  34. data/docs/CardInfoLookupResponse.md +1 -1
  35. data/docs/CardVerificationApi.md +12 -12
  36. data/docs/CardVerificationRequest.md +1 -0
  37. data/docs/ChinaDomesticPaymentMethod.md +9 -0
  38. data/docs/ChinaPnRSaleTransaction.md +14 -0
  39. data/docs/ClientLocale.md +2 -2
  40. data/docs/Contact.md +4 -4
  41. data/docs/CreatePaymentToken.md +10 -0
  42. data/docs/CurrencyConversion.md +9 -0
  43. data/docs/CurrencyConversionApi.md +15 -15
  44. data/docs/Customer.md +6 -6
  45. data/docs/CustomerAddress.md +3 -3
  46. data/docs/CustomerAddressPhone.md +1 -1
  47. data/docs/DCCExchangeRateRequest.md +11 -0
  48. data/docs/Dcc.md +2 -1
  49. data/docs/Device.md +2 -2
  50. data/docs/DeviceNetworks.md +1 -1
  51. data/docs/Document.md +2 -2
  52. data/docs/DynamicPricing.md +11 -0
  53. data/docs/DynamicPricingExchangeRateRequest.md +11 -0
  54. data/docs/ErrorResponse.md +1 -1
  55. data/docs/ExchangeRateRequest.md +2 -4
  56. data/docs/ExchangeRateResponse.md +11 -11
  57. data/docs/Expiration.md +2 -2
  58. data/docs/FraudDetectApi.md +12 -12
  59. data/docs/FraudOrderItems.md +1 -1
  60. data/docs/FraudOrderShipToAddress.md +6 -6
  61. data/docs/Frequency.md +2 -2
  62. data/docs/InstallmentOptions.md +5 -3
  63. data/docs/Lodging.md +5 -5
  64. data/docs/MerchantLocationMerchantAddress.md +6 -6
  65. data/docs/Order.md +5 -0
  66. data/docs/OrderApi.md +36 -102
  67. data/docs/OrderErrorResponse.md +4 -5
  68. data/docs/OrderResponse.md +4 -5
  69. data/docs/PayPal.md +1 -1
  70. data/docs/PayPalPaymentMethod.md +8 -0
  71. data/docs/PaymentApi.md +67 -193
  72. data/docs/PaymentCard.md +8 -11
  73. data/docs/PaymentCardCreditTransaction.md +15 -0
  74. data/docs/PaymentCardForcedTicketTransaction.md +15 -0
  75. data/docs/PaymentCardPayerAuthTransaction.md +15 -0
  76. data/docs/PaymentCardPaymentMethod.md +9 -0
  77. data/docs/PaymentCardPaymentTokenizationRequest.md +13 -0
  78. data/docs/PaymentCardPreAuthTransaction.md +18 -0
  79. data/docs/PaymentCardSaleTransaction.md +18 -0
  80. data/docs/PaymentFacilitator.md +4 -4
  81. data/docs/PaymentMethod.md +0 -7
  82. data/docs/PaymentMethodDetails.md +9 -0
  83. data/docs/PaymentMethodPaymentSchedulesRequest.md +24 -0
  84. data/docs/PaymentMethodType.md +7 -0
  85. data/docs/PaymentPayMethod.md +1 -1
  86. data/docs/PaymentSchedulesApi.md +58 -58
  87. data/docs/PaymentSchedulesErrorResponse.md +1 -1
  88. data/docs/PaymentSchedulesRequest.md +5 -6
  89. data/docs/PaymentSchedulesResponse.md +1 -1
  90. data/docs/PaymentTokenApi.md +23 -23
  91. data/docs/PaymentTokenCreditTransaction.md +15 -0
  92. data/docs/PaymentTokenDetails.md +14 -0
  93. data/docs/PaymentTokenPaymentMethod.md +9 -0
  94. data/docs/PaymentTokenPreAuthTransaction.md +17 -0
  95. data/docs/PaymentTokenSaleTransaction.md +17 -0
  96. data/docs/PaymentTokenizationErrorResponse.md +8 -8
  97. data/docs/PaymentTokenizationRequest.md +4 -3
  98. data/docs/PaymentTokenizationResponse.md +8 -8
  99. data/docs/PaymentURLApi.md +12 -12
  100. data/docs/PaymentUrlErrorResponse.md +3 -3
  101. data/docs/PaymentUrlRequest.md +3 -3
  102. data/docs/PaymentUrlResponse.md +3 -3
  103. data/docs/PaymentVerification3ds.md +3 -3
  104. data/docs/PaymentVerificationAvs.md +3 -3
  105. data/docs/PaymentVerificationCvv.md +3 -3
  106. data/docs/PaypalCreditTransaction.md +14 -0
  107. data/docs/PostAuthTransaction.md +14 -0
  108. data/docs/PrimaryTransaction.md +3 -12
  109. data/docs/ProcessorData.md +8 -6
  110. data/docs/PurchaseCardsLevel2.md +3 -3
  111. data/docs/PurchaseCardsLevel3.md +1 -1
  112. data/docs/PurchaseCardsLevel3LineItems.md +8 -8
  113. data/docs/RecurringPaymentDetails.md +2 -2
  114. data/docs/RecurringPaymentDetailsResponse.md +4 -5
  115. data/docs/ReferencedOrderPaymentSchedulesRequest.md +24 -0
  116. data/docs/ReferencedOrderPaymentTokenizationRequest.md +13 -0
  117. data/docs/ResponseAmountComponents.md +14 -0
  118. data/docs/ReturnTransaction.md +13 -0
  119. data/docs/ScoreOnlyRequest.md +1 -1
  120. data/docs/ScoreOnlyResponse.md +3 -3
  121. data/docs/ScoreOnlyResponseFraudScore.md +1 -1
  122. data/docs/ScoreOnlyResponseFraudScoreExplanations.md +3 -3
  123. data/docs/SecondaryTransaction.md +3 -5
  124. data/docs/Secure3dAuthenticationRequest.md +8 -0
  125. data/docs/Secure3dAuthenticationResult.md +12 -0
  126. data/docs/Secure3dAuthenticationVerificationRequest.md +13 -0
  127. data/docs/Secure3dResponse.md +1 -1
  128. data/docs/Sepa.md +4 -4
  129. data/docs/SepaMandate.md +2 -2
  130. data/docs/SepaPaymentMethod.md +8 -0
  131. data/docs/SepaSaleTransaction.md +14 -0
  132. data/docs/Shipping.md +1 -1
  133. data/docs/SoftDescriptor.md +2 -2
  134. data/docs/SplitShipment.md +1 -1
  135. data/docs/StoredCredential.md +4 -4
  136. data/docs/SubMerchantData.md +4 -4
  137. data/docs/SubMerchantSplit.md +9 -0
  138. data/docs/Transaction.md +4 -4
  139. data/docs/TransactionErrorResponse.md +11 -10
  140. data/docs/TransactionResponse.md +11 -10
  141. data/docs/UnionPayAuthenticationRequest.md +9 -0
  142. data/docs/UnionPayAuthenticationVerificationRequest.md +12 -0
  143. data/docs/UsePaymentToken.md +10 -0
  144. data/docs/VoidTransaction.md +10 -0
  145. data/first_data_gateway.gemspec +3 -2
  146. data/lib/openapi_client/api/authentication_api.rb +18 -18
  147. data/lib/openapi_client/api/card_info_lookup_api.rb +15 -15
  148. data/lib/openapi_client/api/card_verification_api.rb +13 -13
  149. data/lib/openapi_client/api/currency_conversion_api.rb +17 -17
  150. data/lib/openapi_client/api/fraud_detect_api.rb +13 -17
  151. data/lib/openapi_client/api/order_api.rb +45 -153
  152. data/lib/openapi_client/api/payment_api.rb +88 -287
  153. data/lib/openapi_client/api/payment_schedules_api.rb +61 -63
  154. data/lib/openapi_client/api/payment_token_api.rb +24 -24
  155. data/lib/openapi_client/api/payment_url_api.rb +13 -13
  156. data/lib/openapi_client/api_client.rb +2 -2
  157. data/lib/openapi_client/api_error.rb +2 -2
  158. data/lib/openapi_client/configuration.rb +4 -4
  159. data/lib/openapi_client/models/access_token_response.rb +5 -5
  160. data/lib/openapi_client/models/account_updater_response.rb +225 -0
  161. data/lib/openapi_client/models/additional_amount_rate.rb +15 -4
  162. data/lib/openapi_client/models/{primary_transaction_additional_details.rb → additional_details.rb} +11 -113
  163. data/lib/openapi_client/models/additional_transaction_details.rb +6 -6
  164. data/lib/openapi_client/models/address.rb +9 -9
  165. data/lib/openapi_client/models/airline.rb +15 -15
  166. data/lib/openapi_client/models/airline_ancillary_service_category.rb +7 -2
  167. data/lib/openapi_client/models/airline_travel_route.rb +7 -6
  168. data/lib/openapi_client/models/ali_pay.rb +4 -4
  169. data/lib/openapi_client/models/{referenced_order.rb → ali_pay_payment_method.rb} +16 -20
  170. data/lib/openapi_client/models/ali_pay_sale_transaction.rb +286 -0
  171. data/lib/openapi_client/models/amount.rb +5 -5
  172. data/lib/openapi_client/models/amount_components.rb +13 -23
  173. data/lib/openapi_client/models/authentication.rb +190 -0
  174. data/lib/openapi_client/models/{authentication_request.rb → authentication_redirect.rb} +24 -20
  175. data/lib/openapi_client/models/authentication_redirect_params.rb +205 -0
  176. data/lib/openapi_client/models/authentication_verification_request.rb +234 -0
  177. data/lib/openapi_client/models/avs_response.rb +4 -2
  178. data/lib/openapi_client/models/basic_response.rb +2 -7
  179. data/lib/openapi_client/models/billing.rb +7 -76
  180. data/lib/openapi_client/models/billing_address.rb +7 -7
  181. data/lib/openapi_client/models/billing_address_phone.rb +4 -4
  182. data/lib/openapi_client/models/car_rental.rb +9 -9
  183. data/lib/openapi_client/models/car_rental_extra_charges.rb +3 -3
  184. data/lib/openapi_client/models/card.rb +9 -8
  185. data/lib/openapi_client/models/card_function.rb +33 -0
  186. data/lib/openapi_client/models/card_info.rb +4 -17
  187. data/lib/openapi_client/models/card_info_lookup_request.rb +3 -3
  188. data/lib/openapi_client/models/card_info_lookup_response.rb +2 -7
  189. data/lib/openapi_client/models/card_verification_request.rb +32 -7
  190. data/lib/openapi_client/models/china_domestic.rb +2 -2
  191. data/lib/openapi_client/models/{authentication_response_verification.rb → china_domestic_payment_method.rb} +33 -48
  192. data/lib/openapi_client/models/china_pn_r_sale_transaction.rb +286 -0
  193. data/lib/openapi_client/models/client_locale.rb +5 -5
  194. data/lib/openapi_client/models/contact.rb +7 -6
  195. data/lib/openapi_client/models/create_payment_token.rb +209 -0
  196. data/lib/openapi_client/models/{authentication_response_verification_request.rb → currency_conversion.rb} +29 -35
  197. data/lib/openapi_client/models/customer.rb +9 -9
  198. data/lib/openapi_client/models/customer_address.rb +6 -6
  199. data/lib/openapi_client/models/customer_address_phone.rb +4 -4
  200. data/lib/openapi_client/models/dcc.rb +24 -4
  201. data/lib/openapi_client/models/dcc_exchange_rate_request.rb +273 -0
  202. data/lib/openapi_client/models/device.rb +4 -3
  203. data/lib/openapi_client/models/device_networks.rb +4 -3
  204. data/lib/openapi_client/models/document.rb +4 -4
  205. data/lib/openapi_client/models/dynamic_pricing.rb +235 -0
  206. data/lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb +273 -0
  207. data/lib/openapi_client/models/error.rb +2 -2
  208. data/lib/openapi_client/models/error_details.rb +2 -2
  209. data/lib/openapi_client/models/error_response.rb +2 -7
  210. data/lib/openapi_client/models/exchange_rate_request.rb +26 -103
  211. data/lib/openapi_client/models/exchange_rate_response.rb +20 -25
  212. data/lib/openapi_client/models/expiration.rb +5 -5
  213. data/lib/openapi_client/models/fraud_order.rb +2 -2
  214. data/lib/openapi_client/models/fraud_order_items.rb +4 -2
  215. data/lib/openapi_client/models/fraud_order_ship_to_address.rb +8 -8
  216. data/lib/openapi_client/models/frequency.rb +5 -5
  217. data/lib/openapi_client/models/industry_specific_extensions.rb +3 -3
  218. data/lib/openapi_client/models/installment_options.rb +63 -9
  219. data/lib/openapi_client/models/lodging.rb +8 -8
  220. data/lib/openapi_client/models/lodging_extra_charges.rb +2 -2
  221. data/lib/openapi_client/models/loyalty.rb +2 -2
  222. data/lib/openapi_client/models/merchant.rb +2 -2
  223. data/lib/openapi_client/models/merchant_location.rb +2 -2
  224. data/lib/openapi_client/models/merchant_location_merchant_address.rb +9 -9
  225. data/lib/openapi_client/models/order.rb +52 -7
  226. data/lib/openapi_client/models/order_error_response.rb +6 -21
  227. data/lib/openapi_client/models/order_response.rb +7 -22
  228. data/lib/openapi_client/models/pay_pal.rb +3 -3
  229. data/lib/openapi_client/models/pay_pal_payment_method.rb +189 -0
  230. data/lib/openapi_client/models/payment.rb +2 -2
  231. data/lib/openapi_client/models/payment_card.rb +38 -58
  232. data/lib/openapi_client/models/payment_card_credit_transaction.rb +295 -0
  233. data/lib/openapi_client/models/payment_card_forced_ticket_transaction.rb +320 -0
  234. data/lib/openapi_client/models/payment_card_payer_auth_transaction.rb +295 -0
  235. data/lib/openapi_client/models/payment_card_payment_method.rb +198 -0
  236. data/lib/openapi_client/models/payment_card_payment_tokenization_request.rb +264 -0
  237. data/lib/openapi_client/models/payment_card_pre_auth_transaction.rb +325 -0
  238. data/lib/openapi_client/models/payment_card_sale_transaction.rb +325 -0
  239. data/lib/openapi_client/models/payment_facilitator.rb +7 -7
  240. data/lib/openapi_client/models/payment_issuer_response.rb +2 -2
  241. data/lib/openapi_client/models/payment_method.rb +5 -108
  242. data/lib/openapi_client/models/{basket_item.rb → payment_method_details.rb} +17 -38
  243. data/lib/openapi_client/models/payment_method_payment_schedules_request.rb +426 -0
  244. data/lib/openapi_client/models/payment_method_type.rb +47 -0
  245. data/lib/openapi_client/models/payment_pay_method.rb +4 -4
  246. data/lib/openapi_client/models/payment_schedules_error_response.rb +2 -7
  247. data/lib/openapi_client/models/payment_schedules_request.rb +41 -30
  248. data/lib/openapi_client/models/payment_schedules_response.rb +2 -7
  249. data/lib/openapi_client/models/payment_token_credit_transaction.rb +295 -0
  250. data/lib/openapi_client/models/{payment_tokenization.rb → payment_token_details.rb} +18 -96
  251. data/lib/openapi_client/models/payment_token_payment_method.rb +198 -0
  252. data/lib/openapi_client/models/payment_token_pre_auth_transaction.rb +316 -0
  253. data/lib/openapi_client/models/payment_token_sale_transaction.rb +316 -0
  254. data/lib/openapi_client/models/payment_tokenization_error_response.rb +10 -15
  255. data/lib/openapi_client/models/payment_tokenization_request.rb +60 -61
  256. data/lib/openapi_client/models/payment_tokenization_response.rb +10 -15
  257. data/lib/openapi_client/models/payment_url_error_response.rb +4 -9
  258. data/lib/openapi_client/models/payment_url_request.rb +11 -16
  259. data/lib/openapi_client/models/payment_url_response.rb +4 -9
  260. data/lib/openapi_client/models/payment_verification3ds.rb +5 -5
  261. data/lib/openapi_client/models/payment_verification_avs.rb +5 -5
  262. data/lib/openapi_client/models/payment_verification_cvv.rb +5 -5
  263. data/lib/openapi_client/models/paypal_credit_transaction.rb +286 -0
  264. data/lib/openapi_client/models/post_auth_transaction.rb +266 -0
  265. data/lib/openapi_client/models/primary_transaction.rb +30 -118
  266. data/lib/openapi_client/models/processor_data.rb +48 -7
  267. data/lib/openapi_client/models/purchase_cards.rb +3 -2
  268. data/lib/openapi_client/models/purchase_cards_level2.rb +6 -5
  269. data/lib/openapi_client/models/purchase_cards_level3.rb +9 -3
  270. data/lib/openapi_client/models/purchase_cards_level3_line_items.rb +16 -16
  271. data/lib/openapi_client/models/recurring_payment_details.rb +15 -15
  272. data/lib/openapi_client/models/recurring_payment_details_response.rb +6 -21
  273. data/lib/openapi_client/models/referenced_order_payment_schedules_request.rb +427 -0
  274. data/lib/openapi_client/models/referenced_order_payment_tokenization_request.rb +265 -0
  275. data/lib/openapi_client/models/response_amount_components.rb +245 -0
  276. data/lib/openapi_client/models/response_type.rb +2 -2
  277. data/lib/openapi_client/models/return_transaction.rb +257 -0
  278. data/lib/openapi_client/models/score_only_request.rb +4 -4
  279. data/lib/openapi_client/models/score_only_response.rb +6 -5
  280. data/lib/openapi_client/models/score_only_response_fraud_score.rb +4 -3
  281. data/lib/openapi_client/models/score_only_response_fraud_score_explanations.rb +5 -2
  282. data/lib/openapi_client/models/secondary_transaction.rb +45 -40
  283. data/lib/openapi_client/models/secure3d_authentication_request.rb +190 -0
  284. data/lib/openapi_client/models/{payment_card_authentication_result.rb → secure3d_authentication_result.rb} +34 -41
  285. data/lib/openapi_client/models/secure3d_authentication_verification_request.rb +264 -0
  286. data/lib/openapi_client/models/secure3d_response.rb +4 -3
  287. data/lib/openapi_client/models/sepa.rb +6 -6
  288. data/lib/openapi_client/models/sepa_mandate.rb +5 -5
  289. data/lib/openapi_client/models/{secondary_transaction_additional_details.rb → sepa_payment_method.rb} +16 -10
  290. data/lib/openapi_client/models/sepa_sale_transaction.rb +286 -0
  291. data/lib/openapi_client/models/shipping.rb +4 -3
  292. data/lib/openapi_client/models/soft_descriptor.rb +15 -15
  293. data/lib/openapi_client/models/split_shipment.rb +4 -4
  294. data/lib/openapi_client/models/stored_credential.rb +7 -7
  295. data/lib/openapi_client/models/sub_merchant_data.rb +7 -7
  296. data/lib/openapi_client/models/sub_merchant_split.rb +233 -0
  297. data/lib/openapi_client/models/transaction.rb +18 -18
  298. data/lib/openapi_client/models/transaction_error_response.rb +28 -24
  299. data/lib/openapi_client/models/transaction_origin.rb +2 -2
  300. data/lib/openapi_client/models/transaction_response.rb +32 -28
  301. data/lib/openapi_client/models/transaction_type.rb +2 -2
  302. data/lib/openapi_client/models/union_pay_authentication_request.rb +224 -0
  303. data/lib/openapi_client/models/union_pay_authentication_verification_request.rb +249 -0
  304. data/lib/openapi_client/models/use_payment_token.rb +233 -0
  305. data/lib/openapi_client/models/{card_verifications_transaction.rb → void_transaction.rb} +28 -17
  306. data/lib/openapi_client/version.rb +3 -3
  307. data/lib/openapi_client.rb +50 -12
  308. data/lib/simple/gateway.rb +8 -59
  309. data/lib/simple_client.rb +4 -4
  310. data/spec/api/authentication_api_spec.rb +7 -7
  311. data/spec/api/card_info_lookup_api_spec.rb +8 -8
  312. data/spec/api/card_verification_api_spec.rb +7 -7
  313. data/spec/api/currency_conversion_api_spec.rb +9 -9
  314. data/spec/api/fraud_detect_api_spec.rb +7 -7
  315. data/spec/api/order_api_spec.rb +19 -40
  316. data/spec/api/payment_api_spec.rb +33 -72
  317. data/spec/api/payment_schedules_api_spec.rb +29 -29
  318. data/spec/api/payment_token_api_spec.rb +12 -12
  319. data/spec/api/payment_url_api_spec.rb +7 -7
  320. data/spec/api_client_spec.rb +2 -2
  321. data/spec/configuration_spec.rb +5 -5
  322. data/spec/models/access_token_response_spec.rb +2 -2
  323. data/spec/models/account_updater_response_spec.rb +65 -0
  324. data/spec/models/additional_amount_rate_spec.rb +2 -2
  325. data/spec/models/additional_details_spec.rb +53 -0
  326. data/spec/models/additional_transaction_details_spec.rb +2 -2
  327. data/spec/models/address_spec.rb +2 -2
  328. data/spec/models/airline_ancillary_service_category_spec.rb +2 -2
  329. data/spec/models/airline_spec.rb +2 -2
  330. data/spec/models/airline_travel_route_spec.rb +2 -2
  331. data/spec/models/ali_pay_payment_method_spec.rb +41 -0
  332. data/spec/models/ali_pay_sale_transaction_spec.rb +77 -0
  333. data/spec/models/ali_pay_spec.rb +2 -2
  334. data/spec/models/amount_components_spec.rb +2 -8
  335. data/spec/models/amount_spec.rb +2 -2
  336. data/spec/models/authentication_redirect_params_spec.rb +53 -0
  337. data/spec/models/{authentication_response_verification_spec.rb → authentication_redirect_spec.rb} +11 -17
  338. data/spec/models/authentication_spec.rb +41 -0
  339. data/spec/models/{authentication_response_verification_request_spec.rb → authentication_verification_request_spec.rb} +11 -11
  340. data/spec/models/avs_response_spec.rb +2 -2
  341. data/spec/models/basic_response_spec.rb +2 -2
  342. data/spec/models/billing_address_phone_spec.rb +2 -2
  343. data/spec/models/billing_address_spec.rb +2 -2
  344. data/spec/models/billing_spec.rb +2 -18
  345. data/spec/models/car_rental_extra_charges_spec.rb +2 -2
  346. data/spec/models/car_rental_spec.rb +2 -2
  347. data/spec/models/card_function_spec.rb +35 -0
  348. data/spec/models/card_info_lookup_request_spec.rb +2 -2
  349. data/spec/models/card_info_lookup_response_spec.rb +2 -2
  350. data/spec/models/card_info_spec.rb +2 -6
  351. data/spec/models/card_spec.rb +2 -2
  352. data/spec/models/card_verification_request_spec.rb +8 -2
  353. data/spec/models/china_domestic_payment_method_spec.rb +51 -0
  354. data/spec/models/china_domestic_spec.rb +2 -2
  355. data/spec/models/china_pn_r_sale_transaction_spec.rb +77 -0
  356. data/spec/models/client_locale_spec.rb +2 -2
  357. data/spec/models/contact_spec.rb +2 -2
  358. data/spec/models/create_payment_token_spec.rb +53 -0
  359. data/spec/models/currency_conversion_spec.rb +47 -0
  360. data/spec/models/customer_address_phone_spec.rb +2 -2
  361. data/spec/models/customer_address_spec.rb +2 -2
  362. data/spec/models/customer_spec.rb +2 -2
  363. data/spec/models/dcc_exchange_rate_request_spec.rb +59 -0
  364. data/spec/models/dcc_spec.rb +8 -2
  365. data/spec/models/device_networks_spec.rb +2 -2
  366. data/spec/models/device_spec.rb +2 -2
  367. data/spec/models/document_spec.rb +2 -2
  368. data/spec/models/dynamic_pricing_exchange_rate_request_spec.rb +59 -0
  369. data/spec/models/{basket_item_spec.rb → dynamic_pricing_spec.rb} +12 -12
  370. data/spec/models/error_details_spec.rb +2 -2
  371. data/spec/models/error_response_spec.rb +2 -2
  372. data/spec/models/error_spec.rb +2 -2
  373. data/spec/models/exchange_rate_request_spec.rb +4 -20
  374. data/spec/models/exchange_rate_response_spec.rb +3 -3
  375. data/spec/models/expiration_spec.rb +2 -2
  376. data/spec/models/fraud_order_items_spec.rb +2 -2
  377. data/spec/models/fraud_order_ship_to_address_spec.rb +2 -2
  378. data/spec/models/fraud_order_spec.rb +2 -2
  379. data/spec/models/frequency_spec.rb +2 -2
  380. data/spec/models/industry_specific_extensions_spec.rb +2 -2
  381. data/spec/models/installment_options_spec.rb +18 -2
  382. data/spec/models/lodging_extra_charges_spec.rb +2 -2
  383. data/spec/models/lodging_spec.rb +2 -2
  384. data/spec/models/loyalty_spec.rb +2 -2
  385. data/spec/models/merchant_location_merchant_address_spec.rb +2 -2
  386. data/spec/models/merchant_location_spec.rb +2 -2
  387. data/spec/models/merchant_spec.rb +2 -2
  388. data/spec/models/order_error_response_spec.rb +2 -8
  389. data/spec/models/order_response_spec.rb +2 -8
  390. data/spec/models/order_spec.rb +32 -2
  391. data/spec/models/pay_pal_payment_method_spec.rb +41 -0
  392. data/spec/models/pay_pal_spec.rb +2 -2
  393. data/spec/models/payment_card_credit_transaction_spec.rb +83 -0
  394. data/spec/models/{primary_transaction_additional_details_spec.rb → payment_card_forced_ticket_transaction_spec.rb} +16 -22
  395. data/spec/models/payment_card_payer_auth_transaction_spec.rb +83 -0
  396. data/spec/models/payment_card_payment_method_spec.rb +47 -0
  397. data/spec/models/payment_card_payment_tokenization_request_spec.rb +71 -0
  398. data/spec/models/payment_card_pre_auth_transaction_spec.rb +101 -0
  399. data/spec/models/payment_card_sale_transaction_spec.rb +101 -0
  400. data/spec/models/payment_card_spec.rb +3 -21
  401. data/spec/models/payment_facilitator_spec.rb +2 -2
  402. data/spec/models/payment_issuer_response_spec.rb +2 -2
  403. data/spec/models/payment_method_details_spec.rb +47 -0
  404. data/spec/models/payment_method_payment_schedules_request_spec.rb +137 -0
  405. data/spec/models/payment_method_spec.rb +2 -48
  406. data/spec/models/payment_method_type_spec.rb +35 -0
  407. data/spec/models/payment_pay_method_spec.rb +2 -2
  408. data/spec/models/payment_schedules_error_response_spec.rb +2 -2
  409. data/spec/models/payment_schedules_request_spec.rb +5 -11
  410. data/spec/models/payment_schedules_response_spec.rb +2 -2
  411. data/spec/models/payment_spec.rb +2 -2
  412. data/spec/models/payment_token_credit_transaction_spec.rb +83 -0
  413. data/spec/models/{payment_tokenization_spec.rb → payment_token_details_spec.rb} +9 -25
  414. data/spec/models/payment_token_payment_method_spec.rb +47 -0
  415. data/spec/models/payment_token_pre_auth_transaction_spec.rb +95 -0
  416. data/spec/models/payment_token_sale_transaction_spec.rb +95 -0
  417. data/spec/models/payment_tokenization_error_response_spec.rb +2 -2
  418. data/spec/models/payment_tokenization_request_spec.rb +12 -10
  419. data/spec/models/payment_tokenization_response_spec.rb +2 -2
  420. data/spec/models/payment_url_error_response_spec.rb +2 -2
  421. data/spec/models/payment_url_request_spec.rb +3 -3
  422. data/spec/models/payment_url_response_spec.rb +2 -2
  423. data/spec/models/payment_verification3ds_spec.rb +2 -2
  424. data/spec/models/payment_verification_avs_spec.rb +2 -2
  425. data/spec/models/payment_verification_cvv_spec.rb +2 -2
  426. data/spec/models/paypal_credit_transaction_spec.rb +77 -0
  427. data/spec/models/post_auth_transaction_spec.rb +77 -0
  428. data/spec/models/primary_transaction_spec.rb +5 -59
  429. data/spec/models/processor_data_spec.rb +14 -2
  430. data/spec/models/purchase_cards_level2_spec.rb +2 -2
  431. data/spec/models/purchase_cards_level3_line_items_spec.rb +3 -3
  432. data/spec/models/purchase_cards_level3_spec.rb +2 -2
  433. data/spec/models/purchase_cards_spec.rb +2 -2
  434. data/spec/models/recurring_payment_details_response_spec.rb +2 -8
  435. data/spec/models/recurring_payment_details_spec.rb +4 -4
  436. data/spec/models/referenced_order_payment_schedules_request_spec.rb +137 -0
  437. data/spec/models/referenced_order_payment_tokenization_request_spec.rb +71 -0
  438. data/spec/models/response_amount_components_spec.rb +77 -0
  439. data/spec/models/response_type_spec.rb +2 -2
  440. data/spec/models/return_transaction_spec.rb +71 -0
  441. data/spec/models/score_only_request_spec.rb +2 -2
  442. data/spec/models/score_only_response_fraud_score_explanations_spec.rb +2 -2
  443. data/spec/models/score_only_response_fraud_score_spec.rb +2 -2
  444. data/spec/models/score_only_response_spec.rb +2 -2
  445. data/spec/models/secondary_transaction_spec.rb +5 -17
  446. data/spec/models/secure3d_authentication_request_spec.rb +41 -0
  447. data/spec/models/{payment_card_authentication_result_spec.rb → secure3d_authentication_result_spec.rb} +11 -15
  448. data/spec/models/secure3d_authentication_verification_request_spec.rb +71 -0
  449. data/spec/models/secure3d_response_spec.rb +2 -2
  450. data/spec/models/sepa_mandate_spec.rb +2 -2
  451. data/spec/models/sepa_payment_method_spec.rb +41 -0
  452. data/spec/models/sepa_sale_transaction_spec.rb +77 -0
  453. data/spec/models/sepa_spec.rb +2 -2
  454. data/spec/models/shipping_spec.rb +2 -2
  455. data/spec/models/soft_descriptor_spec.rb +3 -3
  456. data/spec/models/split_shipment_spec.rb +2 -2
  457. data/spec/models/stored_credential_spec.rb +2 -2
  458. data/spec/models/sub_merchant_data_spec.rb +2 -2
  459. data/spec/models/{card_verifications_transaction_spec.rb → sub_merchant_split_spec.rb} +10 -10
  460. data/spec/models/transaction_error_response_spec.rb +10 -4
  461. data/spec/models/transaction_origin_spec.rb +2 -2
  462. data/spec/models/transaction_response_spec.rb +10 -4
  463. data/spec/models/transaction_spec.rb +4 -4
  464. data/spec/models/transaction_type_spec.rb +2 -2
  465. data/spec/models/{authentication_request_spec.rb → union_pay_authentication_request_spec.rb} +9 -13
  466. data/spec/models/union_pay_authentication_verification_request_spec.rb +65 -0
  467. data/spec/models/use_payment_token_spec.rb +53 -0
  468. data/spec/models/void_transaction_spec.rb +53 -0
  469. data/spec/spec_helper.rb +2 -2
  470. metadata +195 -42
  471. data/docs/AuthenticationRequest.md +0 -9
  472. data/docs/AuthenticationResponseVerification.md +0 -11
  473. data/docs/AuthenticationResponseVerificationRequest.md +0 -11
  474. data/docs/BasketItem.md +0 -11
  475. data/docs/CardVerificationsTransaction.md +0 -9
  476. data/docs/PaymentCardAuthenticationResult.md +0 -12
  477. data/docs/PaymentTokenization.md +0 -16
  478. data/docs/PrimaryTransactionAdditionalDetails.md +0 -16
  479. data/docs/ReferencedOrder.md +0 -9
  480. data/spec/models/referenced_order_spec.rb +0 -47
  481. data/spec/models/secondary_transaction_additional_details_spec.rb +0 -41
@@ -5,12 +5,12 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional]
7
7
  **client_locale** | [**ClientLocale**](ClientLocale.md) | | [optional]
8
- **amount** | [**Amount**](Amount.md) | |
8
+ **transaction_amount** | [**Amount**](Amount.md) | | [optional]
9
9
  **transaction_type** | [**TransactionType**](TransactionType.md) | |
10
- **order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | [optional]
10
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
11
11
  **billing** | [**Billing**](Billing.md) | | [optional]
12
12
  **shipping** | [**Shipping**](Shipping.md) | | [optional]
13
- **transaction_notification_url** | **String** | URL for notifying merchant with payment result. | [optional]
13
+ **transaction_notification_url** | **String** | URL for notifying merchant of payment result. | [optional]
14
14
  **expiration** | **Integer** | Time until payment URL expires. | [optional]
15
15
  **authenticate_transaction** | **BOOLEAN** | If 3D secure should be applied. | [optional]
16
16
  **dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional]
@@ -5,10 +5,10 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
7
  **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
9
  **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional]
10
- **order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | [optional]
11
- **payment_url** | **String** | URL for embedded payment link | [optional]
10
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
11
+ **payment_url** | **String** | URL for embedded payment link. | [optional]
12
12
  **transaction_id** | **String** | ID code from the transaction. | [optional]
13
13
 
14
14
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **code** | **String** | 3DS Response Code. This field is required if the parent object is present. |
7
- **status** | **String** | Interpretation of the Response Code. | [optional]
8
- **scheme** | **String** | Identifier of the Scheme. This field is required if the parent object is present. |
6
+ **code** | **String** | 3DS response code. |
7
+ **status** | **String** | Interpretation of the response code. | [optional]
8
+ **scheme** | **String** | Identifier of the scheme. |
9
9
 
10
10
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **code** | **String** | AVS Response Code. This field is required if the parent object is present. |
7
- **status** | **String** | Interpretation of the Response Code. | [optional]
8
- **scheme** | **String** | Identifier of the Scheme. This field is required if the parent object is present. |
6
+ **code** | **String** | AVS response code. |
7
+ **status** | **String** | Interpretation of the response code. | [optional]
8
+ **scheme** | **String** | Identifier of the scheme. |
9
9
 
10
10
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **code** | **String** | CVV Response Code. This field is required if the parent object is present. |
7
- **status** | **String** | Interpretation of the Response Code. | [optional]
8
- **scheme** | **String** | Identifier of the Scheme. This field is required if the parent object is present. |
6
+ **code** | **String** | CVV response code. |
7
+ **status** | **String** | Interpretation of the response code. | [optional]
8
+ **scheme** | **String** | Identifier of the scheme. |
9
9
 
10
10
 
@@ -0,0 +1,14 @@
1
+ # OpenapiClient::PaypalCreditTransaction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of the primary transaction request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional]
8
+ **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional]
9
+ **transaction_amount** | [**Amount**](Amount.md) | |
10
+ **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
11
+ **order** | [**Order**](Order.md) | | [optional]
12
+ **payment_method** | [**PayPalPaymentMethod**](PayPalPaymentMethod.md) | |
13
+
14
+
@@ -0,0 +1,14 @@
1
+ # OpenapiClient::PostAuthTransaction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of the secondary transaction request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional]
8
+ **comments** | **String** | Comment for the secondary transaction. | [optional]
9
+ **transaction_amount** | [**Amount**](Amount.md) | |
10
+ **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
11
+ **split_shipment** | [**SplitShipment**](SplitShipment.md) | | [optional]
12
+ **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) | | [optional]
13
+
14
+
@@ -3,20 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **transaction_type** | [**TransactionType**](TransactionType.md) | |
6
+ **request_type** | **String** | Object name of the primary transaction request. |
7
7
  **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional]
8
- **merchant_transaction_id** | **String** | The unique merchant transaction ID from the Request header, if supplied. | [optional]
8
+ **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional]
9
+ **transaction_amount** | [**Amount**](Amount.md) | |
9
10
  **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
10
- **amount** | [**Amount**](Amount.md) | |
11
- **payment_method** | [**PaymentMethod**](PaymentMethod.md) | |
12
11
  **order** | [**Order**](Order.md) | | [optional]
13
- **basket_items** | [**Array<BasketItem>**](BasketItem.md) | Required for some payment methods (for example, Klarna) | [optional]
14
- **split_shipment** | [**SplitShipment**](SplitShipment.md) | | [optional]
15
- **additional_details** | [**PrimaryTransactionAdditionalDetails**](PrimaryTransactionAdditionalDetails.md) | | [optional]
16
- **industry_specific_extensions** | [**IndustrySpecificExtensions**](IndustrySpecificExtensions.md) | | [optional]
17
- **stored_credentials** | [**StoredCredential**](StoredCredential.md) | | [optional]
18
- **purchase_card** | [**PurchaseCards**](PurchaseCards.md) | | [optional]
19
- **payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) | | [optional]
20
- **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) | | [optional]
21
12
 
22
13
 
@@ -3,12 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **reference_number** | **String** | | [optional]
7
- **authorization_code** | **String** | | [optional]
8
- **response_code** | **String** | | [optional]
9
- **association_response_code** | **String** | | [optional]
10
- **response_message** | **String** | | [optional]
6
+ **reference_number** | **String** | Reference transaction ID. | [optional]
7
+ **authorization_code** | **String** | Code returned to confirm transaction. | [optional]
8
+ **response_code** | **String** | Response code from endpoints. | [optional]
9
+ **network** | **String** | Network used for transaction. | [optional]
10
+ **association_response_code** | **String** | Raw response code from issuer. | [optional]
11
+ **response_message** | **String** | Message returned from endpoints. | [optional]
11
12
  **avs_response** | [**AVSResponse**](AVSResponse.md) | | [optional]
12
- **security_code_response** | **String** | | [optional]
13
+ **security_code_response** | **String** | Code returned for CVV. | [optional]
14
+ **merchant_advice_code_indicator** | **String** | Code to map merchant advice code to ISO specification. | [optional]
13
15
 
14
16
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **customer_reference_id** | **String** | Customer Code/Customer Reference ID | [optional]
7
- **supplier_invoice_number** | **String** | Purchase Identifier/Merchant related data | [optional]
8
- **supplier_vat_registration_number** | **String** | Merchant VAT registration/Single Business Reference Number/Merchant Tax ID or Corporation VAT Number | [optional]
6
+ **customer_reference_id** | **String** | Customer code/customer reference ID. | [optional]
7
+ **supplier_invoice_number** | **String** | Purchase identifier/merchant-related data. | [optional]
8
+ **supplier_vat_registration_number** | **String** | Merchant VAT registration/single business reference number/merchant tax ID or corporation VAT number. | [optional]
9
9
  **total_discount_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) | | [optional]
10
10
  **vat_shipping_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) | | [optional]
11
11
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | line items | [optional]
6
+ **line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items. |
7
7
 
8
8
 
@@ -3,14 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **commodity_code** | **String** | The commodity code used to classify the item purchased, positive numeric | [optional]
7
- **product_code** | **String** | Merchant product identifier/The Universal Product Code (UPC) of the item purchased | [optional]
8
- **description** | **String** | The description | [optional]
9
- **quantity** | **Integer** | The quantity | [optional]
10
- **unit_measure** | **String** | The unit of measure | [optional]
11
- **unit_price** | **Float** | Rate amount in 3 decimal 12 bytes total digit | [optional]
12
- **vat_amont_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) | | [optional]
6
+ **commodity_code** | **String** | The commodity code used to classify the item purchased. | [optional]
7
+ **product_code** | **String** | Merchant product identifier/the Universal Product Code (UPC) of the item purchased. | [optional]
8
+ **description** | **String** | The description. | [optional]
9
+ **quantity** | **Integer** | The quantity. | [optional]
10
+ **unit_measure** | **String** | The unit of measure. | [optional]
11
+ **unit_price** | **Float** | Rate amount in 3 decimal 12 bytes total digit. | [optional]
12
+ **vat_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) | | [optional]
13
13
  **discount_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) | | [optional]
14
- **line_item_total** | **Float** | Rate amount in 3 decimal 12 bytes total digit | [optional]
14
+ **line_item_total** | **Float** | Rate amount in 3 decimal 12 bytes total digit. | [optional]
15
15
 
16
16
 
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
9
9
  **creation_date** | **String** | Date recurring payment was created. | [optional]
10
10
  **start_date** | **String** | Date of mandate signature. | [optional]
11
11
  **next_attempt_date** | **String** | Date of next transaction process attempt. | [optional]
12
- **amount** | [**Amount**](Amount.md) | | [optional]
13
- **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | [optional]
12
+ **transaction_amount** | [**Amount**](Amount.md) | | [optional]
13
+ **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) | | [optional]
14
14
  **frequency** | [**Frequency**](Frequency.md) | | [optional]
15
15
  **number_of_payments** | **Integer** | Number of times the recurring payment will process. | [optional]
16
16
  **run_count** | **Integer** | Times the recurring payment has already run. | [optional]
@@ -5,14 +5,13 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
7
  **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
9
- **ipg_transaction_id** | **String** | The response transaction ID | [optional]
10
- **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID | [optional]
11
- **transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
10
+ **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional]
12
11
  **billing** | [**Billing**](Billing.md) | | [optional]
13
12
  **shipping** | [**Shipping**](Shipping.md) | | [optional]
14
13
  **mandate** | [**SepaMandate**](SepaMandate.md) | | [optional]
15
- **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna) | [optional]
14
+ **transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna). | [optional]
16
15
  **processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
17
16
  **recurring_payment_details** | [**RecurringPaymentDetails**](RecurringPaymentDetails.md) | | [optional]
18
17
 
@@ -0,0 +1,24 @@
1
+ # OpenapiClient::ReferencedOrderPaymentSchedulesRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of the payment schedules request. |
7
+ **store_id** | **String** | Store ID number. | [optional]
8
+ **start_date** | **Date** | Date of mandate signature. |
9
+ **number_of_payments** | **Integer** | Number of times the recurring payment will process. | [optional]
10
+ **maximum_failures** | **Integer** | Number of failures that can be encountered before re-tries cease. | [optional]
11
+ **invoice_number** | **String** | Invoice number. | [optional]
12
+ **purchase_order_number** | **String** | Purchase order number. | [optional]
13
+ **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
14
+ **dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional]
15
+ **frequency** | [**Frequency**](Frequency.md) | |
16
+ **transaction_amount** | [**Amount**](Amount.md) | |
17
+ **client_locale** | [**ClientLocale**](ClientLocale.md) | | [optional]
18
+ **order_id** | **String** | Client order ID if supplied by client. | [optional]
19
+ **billing** | [**Billing**](Billing.md) | | [optional]
20
+ **shipping** | [**Shipping**](Shipping.md) | | [optional]
21
+ **comments** | **String** | User supplied comments. | [optional]
22
+ **referenced_order_id** | **String** | Order ID used to create recurring payment from existing transaction. |
23
+
24
+
@@ -0,0 +1,13 @@
1
+ # OpenapiClient::ReferencedOrderPaymentTokenizationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of tokenization request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional]
8
+ **billing_address** | [**Address**](Address.md) | | [optional]
9
+ **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) | |
10
+ **account_verification** | **BOOLEAN** | If the account should be verified prior to token creation. | [optional] [default to false]
11
+ **referenced_order_id** | **String** | Retrieves the payment instrument information from an existing order. |
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # OpenapiClient::ResponseAmountComponents
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **subtotal** | **Float** | Subtotal amount. | [optional]
7
+ **vat_amount** | **Float** | Value-added tax amount. | [optional]
8
+ **local_tax** | **Float** | Local tax amount. | [optional]
9
+ **shipping** | **Float** | Shipping amount. | [optional]
10
+ **cashback** | **Float** | Cashback amount. | [optional]
11
+ **tip** | **Float** | Tip amount. | [optional]
12
+ **convenience_fee** | **Float** | Amount added for proccessing or handling fees. | [optional]
13
+
14
+
@@ -0,0 +1,13 @@
1
+ # OpenapiClient::ReturnTransaction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of the secondary transaction request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional]
8
+ **comments** | **String** | Comment for the secondary transaction. | [optional]
9
+ **transaction_amount** | [**Amount**](Amount.md) | |
10
+ **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) | | [optional]
11
+ **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) | | [optional]
12
+
13
+
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **merchant_ref** | **String** | Merchant reference code. Used by FirstAPI and reflected in settlement records and Webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction. | [optional]
7
7
  **transaction_type** | **String** | Type of transaction merchant wants to process. |
8
8
  **original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. |
9
- **original_transaction_id** | **String** | The unique ID of this transaction. Must be unique for the entire system (not just within a specific merchant or industry). Subsequent requests related to the same transaction must have the same transactionId (e.g. transaction/deposit or transaction/authorization-reversal). This field is used formatching transactions with settlement and chargeback information. If there is no such ID available you may wish to compose one from fields available in both systems. Consider including backend, issuer, merchant id, date and time, amount, etc. as necessary. |
9
+ **original_transaction_id** | **String** | The unique ID of this transaction. Must be unique for the entire system (not just within a specific merchant or industry). Subsequent requests related to the same transaction must have the same transactionId (e.g. transaction/deposit or transaction/authorization-reversal). This field is used for matching transactions with settlement and chargeback information. If there is no such ID available you may wish to compose one from fields available in both systems. Consider including backend, issuer, merchant id, date and time, amount, etc. as necessary. |
10
10
  **amount** | **String** | The amount processed for the original transaction. |
11
11
  **currency_code** | **String** | The currency of the original transaction. |
12
12
  **customer** | [**Customer**](Customer.md) | | [optional]
@@ -3,11 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **api_trace_id** | **String** | Unique trace ID for issue triage | [optional]
6
+ **api_trace_id** | **String** | Unique trace ID for issue triage. | [optional]
7
7
  **transaction_status** | **String** | Please refer to \"Errors Section\" for more info. | [optional]
8
- **validation_status** | **String** | If status returned is \"failure\", input validation errors occurred. Please refer to the \"Errors Section\" for more info. | [optional]
8
+ **validation_status** | **String** | If status returned is \"failure\", input validation errors occurred. Please refer to the \"Errors Section\" for more info. Valid values are 'success' and 'failure'. | [optional]
9
9
  **transaction_type** | **String** | The transactionType provided in request. | [optional]
10
10
  **fraud_score** | [**ScoreOnlyResponseFraudScore**](ScoreOnlyResponseFraudScore.md) | | [optional]
11
- **recommended_decision** | **String** | | [optional]
11
+ **recommended_decision** | **String** | The action that should be taken for the request that was sent. | [optional]
12
12
 
13
13
 
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **score** | **String** | The score attributed to this request by our machine learning system, ranging from 0 (less likely to be fraud) to 1000 (more likely to be fraud). | [optional]
7
7
  **warnings** | **Array<String>** | A list of non-critical warnings raised while processing the request. Warnings included in this list will have integration and data-quality related messages. | [optional]
8
- **explanations** | [**Array<ScoreOnlyResponseFraudScoreExplanations>**](ScoreOnlyResponseFraudScoreExplanations.md) | Type of the explanation to the warning raised | [optional]
8
+ **explanations** | [**Array<ScoreOnlyResponseFraudScoreExplanations>**](ScoreOnlyResponseFraudScoreExplanations.md) | Explanation of the fraud score applied consisting of a description, type of the explanation, and rule (if applicable). | [optional]
9
9
 
10
10
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | | [optional]
7
- **rule** | **String** | | [optional]
8
- **type** | **String** | | [optional]
6
+ **description** | **String** | Description of the fraud score explanation. | [optional]
7
+ **rule** | **String** | ID of the rule being triggered. | [optional]
8
+ **type** | **String** | Type of the explanation (model or rule). | [optional]
9
9
 
10
10
 
@@ -3,10 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
7
- **amount** | [**Amount**](Amount.md) | | [optional]
8
- **split_shipment** | [**SplitShipment**](SplitShipment.md) | | [optional]
9
- **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) | | [optional]
10
- **additional_details** | [**SecondaryTransactionAdditionalDetails**](SecondaryTransactionAdditionalDetails.md) | | [optional]
6
+ **request_type** | **String** | Object name of the secondary transaction request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional]
8
+ **comments** | **String** | Comment for the secondary transaction. | [optional]
11
9
 
12
10
 
@@ -0,0 +1,8 @@
1
+ # OpenapiClient::Secure3dAuthenticationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Indicates what kind of authentication scheme the merchant wants to use on the card. |
7
+
8
+
@@ -0,0 +1,12 @@
1
+ # OpenapiClient::Secure3dAuthenticationResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Indicates what kind of authentication scheme the merchant wants to use on the card. |
7
+ **verification_response** | **String** | Card enrollment result from the Verification Response (VeRes). | [optional]
8
+ **authentication_attempt_result** | **String** | Result of authentication attempt from Payer Authentication Response (PaRes). | [optional]
9
+ **authentication_value** | **String** | The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase. | [optional]
10
+ **xid** | **String** | The transaction identifier (XID) is a unique tracking number set by the merchant. | [optional]
11
+
12
+
@@ -0,0 +1,13 @@
1
+ # OpenapiClient::Secure3dAuthenticationVerificationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional]
7
+ **request_type** | **String** | Object name of the authentication verification request. |
8
+ **security_code** | **String** | Card security code if required by merchant. | [optional]
9
+ **billing_address** | [**Address**](Address.md) | | [optional]
10
+ **payer_authentication_response** | **String** | A formatted message providing results of the issuer’s cardholder authentication. |
11
+ **merchant_data** | **String** | Formatted string encoding transaction time, order ID, and return URL data. |
12
+
13
+
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **response_code3d_secure** | **String** | Code received after successful payer-auth verification | [optional]
6
+ **response_code3d_secure** | **String** | Code received after successful payer-auth verification. | [optional]
7
7
 
8
8
 
data/docs/Sepa.md CHANGED
@@ -3,10 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **iban** | **String** | Bank account in IBAN format |
7
- **name** | **String** | The name of the payer |
8
- **country** | **String** | Country of residence of the payer using the ISO 3166 standard (http://en.wikipedia.org/wiki/ISO_3166) |
9
- **email** | **String** | The email address of the payer | [optional]
6
+ **iban** | **String** | Bank account in IBAN format. |
7
+ **name** | **String** | The name of the payer. |
8
+ **country** | **String** | Country of residence of the payer using the ISO 3166 standard. |
9
+ **email** | **String** | The email address of the payer. | [optional]
10
10
  **mandate** | [**SepaMandate**](SepaMandate.md) | |
11
11
 
12
12
 
data/docs/SepaMandate.md CHANGED
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **reference** | **String** | Existing mandate reference, managed by merchant. Must match [A-Za-z0-9:?/+(),. -]{1,35} and not start with two slashes (\"//\"). Also known as the Mandate ID |
7
- **url** | **String** | Valid URL pointing to the SEPA mandate (PDF / HTML format recommended) |
6
+ **reference** | **String** | Existing mandate reference, managed by merchant. Must match [A-Za-z0-9:?/+(),. -]{1,35} and not start with two slashes (\"//\"). Also known as the mandate ID. |
7
+ **url** | **String** | Valid URL pointing to the SEPA mandate (PDF / HTML format recommended). |
8
8
  **signature_date** | **Date** | Date of mandate signature. |
9
9
  **type** | **String** | Sequence type of the direct debit. This defaults to 'SINGLE' if not provided. | [default to 'SINGLE']
10
10
 
@@ -0,0 +1,8 @@
1
+ # OpenapiClient::SepaPaymentMethod
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sepa** | [**Sepa**](Sepa.md) | |
7
+
8
+
@@ -0,0 +1,14 @@
1
+ # OpenapiClient::SepaSaleTransaction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_type** | **String** | Object name of the primary transaction request. |
7
+ **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional]
8
+ **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional]
9
+ **transaction_amount** | [**Amount**](Amount.md) | |
10
+ **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
11
+ **order** | [**Order**](Order.md) | | [optional]
12
+ **payment_method** | [**SepaPaymentMethod**](SepaPaymentMethod.md) | |
13
+
14
+
data/docs/Shipping.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | | [optional]
6
+ **name** | **String** | Name of customer for shipping. | [optional]
7
7
  **contact** | [**Contact**](Contact.md) | | [optional]
8
8
  **address** | [**Address**](Address.md) | | [optional]
9
9
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **dba** | **String** | Store \"doing-business-as\" name |
7
- **mcc** | **String** | The 4-digit Merchant Category Code. The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction. | [optional]
6
+ **dynamic_merchant_name** | **String** | Store \"doing-business-as\" name. |
7
+ **mcc** | **String** | The 4-digit merchant category code (MCC). The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **total_count** | **Integer** | Total count of the shipment, can be set at preauth or the first postauth. | [optional]
7
- **final_shipment** | **BOOLEAN** | Indicates whether the transaction is the final shipment | [optional] [default to false]
7
+ **final_shipment** | **BOOLEAN** | Indicates whether the transaction is the final shipment. | [optional] [default to false]
8
8
 
9
9
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sequence** | **String** | Indicates if the transaction is first or subsequent. Valid values are 'FIRST' and 'SUBSEQUENT' |
7
- **scheduled** | **BOOLEAN** | Indicates if the transaction is scheduled or part of an installment |
8
- **referenced_scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction. Required if sequence is 'SUBSEQUENT' | [optional]
9
- **initiator** | **String** | Indicates whether it is a merchant-initiated or explicitly consented to by card holder. Valid values are 'MERCHANT' and 'CARDHOLDER' | [optional]
6
+ **sequence** | **String** | Indicates if the transaction is first or subsequent. Valid values are 'FIRST' and 'SUBSEQUENT'. |
7
+ **scheduled** | **BOOLEAN** | Indicates if the transaction is scheduled or part of an installment. |
8
+ **referenced_scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction. Required if sequence is 'SUBSEQUENT'. | [optional]
9
+ **initiator** | **String** | Indicates whether it is a merchant-initiated or explicitly consented to by card holder. Valid values are 'MERCHANT' and 'CARDHOLDER'. | [optional]
10
10
 
11
11
 
@@ -3,11 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **mcc** | **String** | Merchant Category Code |
7
- **legal_name** | **String** | Store legal name | [optional]
8
- **timezone** | **String** | Timezone e.g. 'Europe/London', 'Europe/Berlin', 'Brazil/West' | [optional]
6
+ **mcc** | **String** | Merchant category code. |
7
+ **legal_name** | **String** | Store legal name. | [optional]
8
+ **timezone** | **String** | Timezone. | [optional]
9
9
  **address** | [**Address**](Address.md) | | [optional]
10
10
  **document** | [**Document**](Document.md) | | [optional]
11
- **merchant_id** | **String** | Sub-merchant ID | [optional]
11
+ **merchant_id** | **String** | Sub-merchant ID. | [optional]
12
12
 
13
13
 
@@ -0,0 +1,9 @@
1
+ # OpenapiClient::SubMerchantSplit
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **merchant_id** | **String** | ID of merchant for tracking. |
7
+ **amount** | **Float** | The amount each sub-merchant receives. |
8
+
9
+
data/docs/Transaction.md CHANGED
@@ -4,14 +4,14 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **transaction_state** | **String** | The state of the transaction. | [optional]
7
- **ipg_transaction_id** | **String** | The transaction ID | [optional]
7
+ **ipg_transaction_id** | **String** | The transaction ID. | [optional]
8
8
  **order_id** | **String** | Client order ID if supplied by client. | [optional]
9
9
  **transaction_type** | [**TransactionType**](TransactionType.md) | | [optional]
10
- **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | [optional]
11
- **amount** | [**Amount**](Amount.md) | | [optional]
10
+ **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) | | [optional]
11
+ **transaction_amount** | [**Amount**](Amount.md) | | [optional]
12
12
  **submission_component** | **String** | The submission component. | [optional]
13
13
  **payer_security_level** | **String** | The payer security level. | [optional]
14
- **transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
14
+ **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional]
15
15
  **store_id** | **String** | Store ID number. | [optional]
16
16
  **user_id** | **String** | The user ID. | [optional]
17
17
  **processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
@@ -5,26 +5,27 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
7
7
  **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
8
- **response_type** | [**ResponseType**](ResponseType.md) | |
9
- **ipg_transaction_id** | **String** | The Response Transaction ID | [optional]
10
- **order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | | [optional]
9
+ **ipg_transaction_id** | **String** | The response transaction ID. | [optional]
10
+ **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional]
11
11
  **transaction_type** | [**TransactionType**](TransactionType.md) | | [optional]
12
- **payment_token** | [**PaymentTokenization**](PaymentTokenization.md) | | [optional]
12
+ **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) | | [optional]
13
13
  **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) | | [optional]
14
- **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | [optional]
15
- **country** | **String** | Country of the card issuer | [optional]
16
- **terminal_id** | **String** | The terminal that is processing the transaction | [optional]
17
- **merchant_transaction_id** | **String** | The unique merchant Transaction ID from the Request header, if supplied | [optional]
18
- **transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
14
+ **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) | | [optional]
15
+ **country** | **String** | Country of the card issuer. | [optional]
16
+ **terminal_id** | **String** | The terminal that is processing the transaction. | [optional]
17
+ **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional]
18
+ **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional]
19
19
  **approved_amount** | [**Amount**](Amount.md) | | [optional]
20
20
  **transaction_status** | **String** | The status of the transaction. APPROVED/WAITING are returned by the endpoints. VALIDATION_FAILED/DECLINED are errors. See ErrorResponse object for details. | [optional]
21
21
  **transaction_state** | **String** | The state of the transaction. | [optional]
22
22
  **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) | | [optional]
23
23
  **redirect_url** | **String** | The endpoint redirection URL. | [optional]
24
- **authentication_redirect** | **Object** | | [optional]
24
+ **authentication_redirect** | [**AuthenticationRedirect**](AuthenticationRedirect.md) | | [optional]
25
25
  **scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional]
26
26
  **processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
27
27
  **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) | | [optional]
28
+ **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) | | [optional]
28
29
  **error** | [**Error**](Error.md) | | [optional]
29
30
 
30
31