1. 1 : (function(root, factory) {
  2. 2 : if (typeof define === 'function' && define.amd) {
  3. 3 : // AMD. Register as an anonymous module.
  4. 4 : define(['ApiClient', 'models/AuditInfoVo', 'models/CustomerAccountResponse', 'models/FeeResponse', 'models/FundingAccountResponse', 'models/PaymentNetworkResponseVo', 'models/SimplePaymentCustomerResponse'], factory);
  5. 5 : } else if (typeof module === 'object' && module.exports) {
  6. 6 : // CommonJS-like environments that support module.exports, like Node.
  7. 7 : module.exports = factory(require('../ApiClient'), require('./AuditInfoVo'), require('./CustomerAccountResponse'), require('./FeeResponse'), require('./FundingAccountResponse'), require('./PaymentNetworkResponseVo'), require('./SimplePaymentCustomerResponse'));
  8. 8 : } else {
  9. 9 : // Browser globals (root is window)
  10. 10 : if (!root.OrbipayPaymentsapiClient) {
  11. 11 : root.OrbipayPaymentsapiClient = {};
  12. 12 : }
  13. 13 : root.OrbipayPaymentsapiClient.SimplePaymentResponseCgen = factory(root.OrbipayPaymentsapiClient.ApiClient, root.OrbipayPaymentsapiClient.AuditInfoVo, root.OrbipayPaymentsapiClient.CustomerAccountResponse, root.OrbipayPaymentsapiClient.FeeResponse, root.OrbipayPaymentsapiClient.FundingAccountResponse, root.OrbipayPaymentsapiClient.PaymentNetworkResponseVo, root.OrbipayPaymentsapiClient.SimplePaymentCustomerResponse);
  14. 14 : }
  15. 15 : }(this, function(ApiClient, AuditInfoVo, CustomerAccountResponse, FeeResponse, FundingAccountResponse, PaymentNetworkResponseVo, SimplePaymentCustomerResponse) {
  16. 16 : 'use strict';
  17. 17 :
  18. 18 :
  19. 19 :
  20. 20 :
  21. 21 : /**
  22. 22 : * The SimplePaymentResponseCgen model module.
  23. 23 : * @module models/SimplePaymentResponseCgen
  24. 24 : */
  25. 25 :
  26. 26 : /**
  27. 27 : * <h3 style="color:red"> This class subject to change without prior notice, Please dont use this class directly. </h3>
  28. 28 :
  29. 29 : * Constructs a new <code>SimplePaymentResponseCgen</code>.
  30. 30 : * @alias module:models/SimplePaymentResponseCgen
  31. 31 : * @class
  32. 32 : */
  33. 33 : var exports = function() {
  34. 34 : var _this = this;
  35. 35 :
  36. 36 :
  37. 37 :
  38. 38 :
  39. 39 :
  40. 40 :
  41. 41 :
  42. 42 :
  43. 43 :
  44. 44 :
  45. 45 :
  46. 46 :
  47. 47 :
  48. 48 :
  49. 49 :
  50. 50 :
  51. 51 :
  52. 52 :
  53. 53 :
  54. 54 :
  55. 55 :
  56. 56 :
  57. 57 :
  58. 58 :
  59. 59 :
  60. 60 :
  61. 61 :
  62. 62 :
  63. 63 :
  64. 64 : };
  65. 65 :
  66. 66 : /**
  67. 67 : * Constructs a <code>SimplePaymentResponseCgen</code> from a plain JavaScript object, optionally creating a new instance.
  68. 68 : * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
  69. 69 : * @param {Object} data The plain JavaScript object bearing properties of interest.
  70. 70 : * @param {module:models/SimplePaymentResponseCgen} obj Optional instance to populate.
  71. 71 : * @return {module:models/SimplePaymentResponseCgen} The populated <code>SimplePaymentResponseCgen</code> instance.
  72. 72 : */
  73. 73 : exports.constructFromObject = function(data, obj) {
  74. 74 : if (data) {
  75. 75 : obj = obj || new exports();
  76. 76 :
  77. 77 : if (data.hasOwnProperty('id')) {
  78. 78 : obj['id'] = ApiClient.convertToType(data['id'], 'String');
  79. 79 : }
  80. 80 : if (data.hasOwnProperty('url')) {
  81. 81 : obj['url'] = ApiClient.convertToType(data['url'], 'String');
  82. 82 : }
  83. 83 : if (data.hasOwnProperty('fee')) {
  84. 84 : obj['fee'] = FeeResponse.constructFromObject(data['fee']);
  85. 85 : }
  86. 86 : if (data.hasOwnProperty('status')) {
  87. 87 : obj['status'] = ApiClient.convertToType(data['status'], 'String');
  88. 88 : }
  89. 89 : if (data.hasOwnProperty('payment_method')) {
  90. 90 : obj['payment_method'] = ApiClient.convertToType(data['payment_method'], 'String');
  91. 91 : }
  92. 92 : if (data.hasOwnProperty('confirmation_number')) {
  93. 93 : obj['confirmation_number'] = ApiClient.convertToType(data['confirmation_number'], 'String');
  94. 94 : }
  95. 95 : if (data.hasOwnProperty('custom_fields')) {
  96. 96 : obj['custom_fields'] = ApiClient.convertToType(data['custom_fields'], {'String': 'String'});
  97. 97 : }
  98. 98 : if (data.hasOwnProperty('currency_code3d')) {
  99. 99 : obj['currency_code3d'] = ApiClient.convertToType(data['currency_code3d'], 'String');
  100. 100 : }
  101. 101 : if (data.hasOwnProperty('amount')) {
  102. 102 : obj['amount'] = ApiClient.convertToType(data['amount'], 'String');
  103. 103 : }
  104. 104 : if (data.hasOwnProperty('card_cvv_number')) {
  105. 105 : obj['card_cvv_number'] = ApiClient.convertToType(data['card_cvv_number'], 'String');
  106. 106 : }
  107. 107 : if (data.hasOwnProperty('payment_date')) {
  108. 108 : obj['payment_date'] = ApiClient.convertToType(data['payment_date'], 'String');
  109. 109 : }
  110. 110 : if (data.hasOwnProperty('payment_schedule_type')) {
  111. 111 : obj['payment_schedule_type'] = ApiClient.convertToType(data['payment_schedule_type'], 'String');
  112. 112 : }
  113. 113 : if (data.hasOwnProperty('payment_request_date')) {
  114. 114 : obj['payment_request_date'] = ApiClient.convertToType(data['payment_request_date'], 'String');
  115. 115 : }
  116. 116 : if (data.hasOwnProperty('payment_amount_type')) {
  117. 117 : obj['payment_amount_type'] = ApiClient.convertToType(data['payment_amount_type'], 'String');
  118. 118 : }
  119. 119 : if (data.hasOwnProperty('payment_reference')) {
  120. 120 : obj['payment_reference'] = ApiClient.convertToType(data['payment_reference'], 'String');
  121. 121 : }
  122. 122 : if (data.hasOwnProperty('expected_payment_settlement_date')) {
  123. 123 : obj['expected_payment_settlement_date'] = ApiClient.convertToType(data['expected_payment_settlement_date'], 'String');
  124. 124 : }
  125. 125 : if (data.hasOwnProperty('payment_entry_date')) {
  126. 126 : obj['payment_entry_date'] = ApiClient.convertToType(data['payment_entry_date'], 'String');
  127. 127 : }
  128. 128 : if (data.hasOwnProperty('payment_return_date')) {
  129. 129 : obj['payment_return_date'] = ApiClient.convertToType(data['payment_return_date'], 'String');
  130. 130 : }
  131. 131 : if (data.hasOwnProperty('return_code')) {
  132. 132 : obj['return_code'] = ApiClient.convertToType(data['return_code'], 'String');
  133. 133 : }
  134. 134 : if (data.hasOwnProperty('payment_notification_email')) {
  135. 135 : obj['payment_notification_email'] = ApiClient.convertToType(data['payment_notification_email'], 'String');
  136. 136 : }
  137. 137 : if (data.hasOwnProperty('cryptogram')) {
  138. 138 : obj['cryptogram'] = ApiClient.convertToType(data['cryptogram'], 'String');
  139. 139 : }
  140. 140 : if (data.hasOwnProperty('eci')) {
  141. 141 : obj['eci'] = ApiClient.convertToType(data['eci'], 'String');
  142. 142 : }
  143. 143 : if (data.hasOwnProperty('comments')) {
  144. 144 : obj['comments'] = ApiClient.convertToType(data['comments'], 'String');
  145. 145 : }
  146. 146 : if (data.hasOwnProperty('customer')) {
  147. 147 : obj['customer'] = SimplePaymentCustomerResponse.constructFromObject(data['customer']);
  148. 148 : }
  149. 149 : if (data.hasOwnProperty('funding_account')) {
  150. 150 : obj['funding_account'] = FundingAccountResponse.constructFromObject(data['funding_account']);
  151. 151 : }
  152. 152 : if (data.hasOwnProperty('customer_account')) {
  153. 153 : obj['customer_account'] = CustomerAccountResponse.constructFromObject(data['customer_account']);
  154. 154 : }
  155. 155 : if (data.hasOwnProperty('payment_network_response')) {
  156. 156 : obj['payment_network_response'] = PaymentNetworkResponseVo.constructFromObject(data['payment_network_response']);
  157. 157 : }
  158. 158 : if (data.hasOwnProperty('audit_info')) {
  159. 159 : obj['audit_info'] = AuditInfoVo.constructFromObject(data['audit_info']);
  160. 160 : }
  161. 161 : }
  162. 162 : return obj;
  163. 163 : };
  164. 164 :
  165. 165 : /**
  166. 166 : * The unique identifier assigned by EBPP to the payment.
  167. 167 : * @member {String} id
  168. 168 : */
  169. 169 : exports.prototype['id'] = undefined;
  170. 170 : /**
  171. 171 : * This URL fetches the details of payment.
  172. 172 : * @member {String} url
  173. 173 : */
  174. 174 : exports.prototype['url'] = undefined;
  175. 175 : /**
  176. 176 : * @member {module:models/FeeResponse} fee
  177. 177 : */
  178. 178 : exports.prototype['fee'] = undefined;
  179. 179 : /**
  180. 180 : * The status of the payment.
  181. 181 : * @member {module:models/SimplePaymentResponseCgen.StatusEnum} status
  182. 182 : */
  183. 183 : exports.prototype['status'] = undefined;
  184. 184 : /**
  185. 185 : * The fulfillment method for the payment.
  186. 186 : * @member {module:models/SimplePaymentResponseCgen.PaymentMethodEnum} payment_method
  187. 187 : */
  188. 188 : exports.prototype['payment_method'] = undefined;
  189. 189 : /**
  190. 190 : * The confirmation number or reference provided to the customer for the payment.
  191. 191 : * @member {String} confirmation_number
  192. 192 : */
  193. 193 : exports.prototype['confirmation_number'] = undefined;
  194. 194 : /**
  195. 195 : * The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = \"mailto: support@billerpayments.com\">support@billerpayments.com</a> for more information on configuring and using custom fields.
  196. 196 : * @member {Object.<String, String>} custom_fields
  197. 197 : */
  198. 198 : exports.prototype['custom_fields'] = undefined;
  199. 199 : /**
  200. 200 : * The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.
  201. 201 : * @member {String} currency_code3d
  202. 202 : */
  203. 203 : exports.prototype['currency_code3d'] = undefined;
  204. 204 : /**
  205. 205 : * The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.
  206. 206 : * @member {String} amount
  207. 207 : */
  208. 208 : exports.prototype['amount'] = undefined;
  209. 209 : /**
  210. 210 : * This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.
  211. 211 : * @member {String} card_cvv_number
  212. 212 : */
  213. 213 : exports.prototype['card_cvv_number'] = undefined;
  214. 214 : /**
  215. 215 : * The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
  216. 216 : * @member {String} payment_date
  217. 217 : */
  218. 218 : exports.prototype['payment_date'] = undefined;
  219. 219 : /**
  220. 220 : * The schedule type for the payment. This defaults to one_time_payment.
  221. 221 : * @member {module:models/SimplePaymentResponseCgen.PaymentScheduleTypeEnum} payment_schedule_type
  222. 222 : */
  223. 223 : exports.prototype['payment_schedule_type'] = undefined;
  224. 224 : /**
  225. 225 : * The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.
  226. 226 : * @member {String} payment_request_date
  227. 227 : */
  228. 228 : exports.prototype['payment_request_date'] = undefined;
  229. 229 : /**
  230. 230 : * The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
  231. 231 : * @member {module:models/SimplePaymentResponseCgen.PaymentAmountTypeEnum} payment_amount_type
  232. 232 : */
  233. 233 : exports.prototype['payment_amount_type'] = undefined;
  234. 234 : /**
  235. 235 : * The unique identifier in the client system for the payment.
  236. 236 : * @member {String} payment_reference
  237. 237 : */
  238. 238 : exports.prototype['payment_reference'] = undefined;
  239. 239 : /**
  240. 240 : * The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
  241. 241 : * @member {String} expected_payment_settlement_date
  242. 242 : */
  243. 243 : exports.prototype['expected_payment_settlement_date'] = undefined;
  244. 244 : /**
  245. 245 : * The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
  246. 246 : * @member {String} payment_entry_date
  247. 247 : */
  248. 248 : exports.prototype['payment_entry_date'] = undefined;
  249. 249 : /**
  250. 250 : * The date on which the ACH returns is received by EBPP.
  251. 251 : * @member {String} payment_return_date
  252. 252 : */
  253. 253 : exports.prototype['payment_return_date'] = undefined;
  254. 254 : /**
  255. 255 : * The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
  256. 256 : * @member {String} return_code
  257. 257 : */
  258. 258 : exports.prototype['return_code'] = undefined;
  259. 259 : /**
  260. 260 : * The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
  261. 261 : * @member {String} payment_notification_email
  262. 262 : */
  263. 263 : exports.prototype['payment_notification_email'] = undefined;
  264. 264 : /**
  265. 265 : * This is applicable only for Apple Pay transactions. Online Payment Cryptogram, as defined by 3-D secure.
  266. 266 : * @member {String} cryptogram
  267. 267 : */
  268. 268 : exports.prototype['cryptogram'] = undefined;
  269. 269 : /**
  270. 270 : * This is applicable only for Apple Pay transactions. ECI Indicator, as defined by 3-D secure. The card network may add an ECI indicator to the card data. This indicator is then included in the payment token. if you receive an ECI indicator, you must pass it on to your payment processor, otherwise, the transaction fails.
  271. 271 : * @member {String} eci
  272. 272 : */
  273. 273 : exports.prototype['eci'] = undefined;
  274. 274 : /**
  275. 275 : * Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
  276. 276 : * @member {String} comments
  277. 277 : */
  278. 278 : exports.prototype['comments'] = undefined;
  279. 279 : /**
  280. 280 : * @member {module:models/SimplePaymentCustomerResponse} customer
  281. 281 : */
  282. 282 : exports.prototype['customer'] = undefined;
  283. 283 : /**
  284. 284 : * @member {module:models/FundingAccountResponse} funding_account
  285. 285 : */
  286. 286 : exports.prototype['funding_account'] = undefined;
  287. 287 : /**
  288. 288 : * @member {module:models/CustomerAccountResponse} customer_account
  289. 289 : */
  290. 290 : exports.prototype['customer_account'] = undefined;
  291. 291 : /**
  292. 292 : * @member {module:models/PaymentNetworkResponseVo} payment_network_response
  293. 293 : */
  294. 294 : exports.prototype['payment_network_response'] = undefined;
  295. 295 : /**
  296. 296 : * @member {module:models/AuditInfoVo} audit_info
  297. 297 : */
  298. 298 : exports.prototype['audit_info'] = undefined;
  299. 299 :
  300. 300 :
  301. 301 : /**
  302. 302 : * Allowed values for the <code>status</code> property.
  303. 303 : * @enum {String}
  304. 304 : * @readonly
  305. 305 : */
  306. 306 : exports.StatusEnum = {
  307. 307 : /**
  308. 308 : * value: "scheduled"
  309. 309 : * @const
  310. 310 : */
  311. 311 : "scheduled": "scheduled",
  312. 312 : /**
  313. 313 : * value: "cancelled"
  314. 314 : * @const
  315. 315 : */
  316. 316 : "cancelled": "cancelled",
  317. 317 : /**
  318. 318 : * value: "processing"
  319. 319 : * @const
  320. 320 : */
  321. 321 : "processing": "processing",
  322. 322 : /**
  323. 323 : * value: "processed"
  324. 324 : * @const
  325. 325 : */
  326. 326 : "processed": "processed",
  327. 327 : /**
  328. 328 : * value: "returned"
  329. 329 : * @const
  330. 330 : */
  331. 331 : "returned": "returned",
  332. 332 : /**
  333. 333 : * value: "declined"
  334. 334 : * @const
  335. 335 : */
  336. 336 : "declined": "declined",
  337. 337 : /**
  338. 338 : * value: "disputed"
  339. 339 : * @const
  340. 340 : */
  341. 341 : "disputed": "disputed",
  342. 342 : /**
  343. 343 : * value: "error"
  344. 344 : * @const
  345. 345 : */
  346. 346 : "error": "error" };
  347. 347 :
  348. 348 : /**
  349. 349 : * Allowed values for the <code>payment_method</code> property.
  350. 350 : * @enum {String}
  351. 351 : * @readonly
  352. 352 : */
  353. 353 : exports.PaymentMethodEnum = {
  354. 354 : /**
  355. 355 : * value: "ach"
  356. 356 : * @const
  357. 357 : */
  358. 358 : "ach": "ach",
  359. 359 : /**
  360. 360 : * value: "check"
  361. 361 : * @const
  362. 362 : */
  363. 363 : "check": "check",
  364. 364 : /**
  365. 365 : * value: "visa_debit"
  366. 366 : * @const
  367. 367 : */
  368. 368 : "visa_debit": "visa_debit",
  369. 369 : /**
  370. 370 : * value: "pinless_debit"
  371. 371 : * @const
  372. 372 : */
  373. 373 : "pinless_debit": "pinless_debit",
  374. 374 : /**
  375. 375 : * value: "master_debit"
  376. 376 : * @const
  377. 377 : */
  378. 378 : "master_debit": "master_debit",
  379. 379 : /**
  380. 380 : * value: "amex_credit"
  381. 381 : * @const
  382. 382 : */
  383. 383 : "amex_credit": "amex_credit",
  384. 384 : /**
  385. 385 : * value: "discover_credit"
  386. 386 : * @const
  387. 387 : */
  388. 388 : "discover_credit": "discover_credit",
  389. 389 : /**
  390. 390 : * value: "visa_credit"
  391. 391 : * @const
  392. 392 : */
  393. 393 : "visa_credit": "visa_credit",
  394. 394 : /**
  395. 395 : * value: "master_credit"
  396. 396 : * @const
  397. 397 : */
  398. 398 : "master_credit": "master_credit",
  399. 399 : /**
  400. 400 : * value: "cash"
  401. 401 : * @const
  402. 402 : */
  403. 403 : "cash": "cash",
  404. 404 : /**
  405. 405 : * value: "discover_debit"
  406. 406 : * @const
  407. 407 : */
  408. 408 : "discover_debit": "discover_debit",
  409. 409 : /**
  410. 410 : * value: "apple_pay"
  411. 411 : * @const
  412. 412 : */
  413. 413 : "apple_pay": "apple_pay" };
  414. 414 :
  415. 415 : /**
  416. 416 : * Allowed values for the <code>payment_schedule_type</code> property.
  417. 417 : * @enum {String}
  418. 418 : * @readonly
  419. 419 : */
  420. 420 : exports.PaymentScheduleTypeEnum = {
  421. 421 : /**
  422. 422 : * value: "one_time_payment"
  423. 423 : * @const
  424. 424 : */
  425. 425 : "one_time_payment": "one_time_payment",
  426. 426 : /**
  427. 427 : * value: "autopay_generated_payment"
  428. 428 : * @const
  429. 429 : */
  430. 430 : "autopay_generated_payment": "autopay_generated_payment",
  431. 431 : /**
  432. 432 : * value: "variable_recurring_generated_payment"
  433. 433 : * @const
  434. 434 : */
  435. 435 : "variable_recurring_generated_payment": "variable_recurring_generated_payment",
  436. 436 : /**
  437. 437 : * value: "payment_plan_generated"
  438. 438 : * @const
  439. 439 : */
  440. 440 : "payment_plan_generated": "payment_plan_generated" };
  441. 441 :
  442. 442 : /**
  443. 443 : * Allowed values for the <code>payment_amount_type</code> property.
  444. 444 : * @enum {String}
  445. 445 : * @readonly
  446. 446 : */
  447. 447 : exports.PaymentAmountTypeEnum = {
  448. 448 : /**
  449. 449 : * value: "current_balance"
  450. 450 : * @const
  451. 451 : */
  452. 452 : "current_balance": "current_balance",
  453. 453 : /**
  454. 454 : * value: "minimum_payment_due"
  455. 455 : * @const
  456. 456 : */
  457. 457 : "minimum_payment_due": "minimum_payment_due",
  458. 458 : /**
  459. 459 : * value: "past_payment_due"
  460. 460 : * @const
  461. 461 : */
  462. 462 : "past_payment_due": "past_payment_due",
  463. 463 : /**
  464. 464 : * value: "statement_balance"
  465. 465 : * @const
  466. 466 : */
  467. 467 : "statement_balance": "statement_balance",
  468. 468 : /**
  469. 469 : * value: "discounted_amount"
  470. 470 : * @const
  471. 471 : */
  472. 472 : "discounted_amount": "discounted_amount",
  473. 473 : /**
  474. 474 : * value: "penalty_amount"
  475. 475 : * @const
  476. 476 : */
  477. 477 : "penalty_amount": "penalty_amount",
  478. 478 : /**
  479. 479 : * value: "other"
  480. 480 : * @const
  481. 481 : */
  482. 482 : "other": "other" };
  483. 483 :
  484. 484 :
  485. 485 : return exports;
  486. 486 : }));
  487. 487 :
  488. 488 :