velopayments 2.14.90.pre.1 → 2.17.8.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (394) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/Makefile +41 -9
  4. data/README.md +61 -23
  5. data/docs/AuthApi.md +8 -9
  6. data/docs/AuthResponse.md +3 -1
  7. data/docs/CompanyResponse.md +19 -0
  8. data/docs/{Company.md → CompanyV1.md} +2 -2
  9. data/docs/CreateIndividual.md +1 -1
  10. data/docs/CreateIndividual2.md +21 -0
  11. data/docs/CreatePayee.md +3 -3
  12. data/docs/CreatePayee2.md +37 -0
  13. data/docs/CreatePayeeAddress.md +1 -1
  14. data/docs/CreatePayeeAddress2.md +31 -0
  15. data/docs/CreatePayeesCSVRequest.md +1 -1
  16. data/docs/CreatePayeesCSVRequest2.md +73 -0
  17. data/docs/CreatePayeesCSVResponse2.md +19 -0
  18. data/docs/CreatePayeesRequest2.md +19 -0
  19. data/docs/CreatePaymentChannel2.md +29 -0
  20. data/docs/CreatePayoutRequest.md +6 -2
  21. data/docs/Error.md +23 -0
  22. data/docs/ErrorResponse.md +19 -0
  23. data/docs/FundingAudit.md +3 -1
  24. data/docs/FundingDelta.md +23 -0
  25. data/docs/FundingDeltaResponse.md +21 -0
  26. data/docs/FundingDeltaResponseLinks.md +19 -0
  27. data/docs/FundingEvent.md +3 -1
  28. data/docs/FundingManagerApi.md +33 -26
  29. data/docs/GetFundingsResponse.md +1 -1
  30. data/docs/GetFundingsResponseAllOf.md +1 -1
  31. data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
  32. data/docs/GetPaymentsForPayoutResponseV4Summary.md +16 -0
  33. data/docs/GetPayoutsResponseV4.md +3 -3
  34. data/docs/IndividualResponse.md +17 -0
  35. data/docs/{Individual.md → IndividualV1.md} +5 -5
  36. data/docs/{IndividualName.md → IndividualV1Name.md} +2 -2
  37. data/docs/PagedPayeeInvitationStatusResponse.md +2 -2
  38. data/docs/PagedPayeeResponse.md +23 -0
  39. data/docs/PagedPayeeResponse2.md +23 -0
  40. data/docs/PagedPayeeResponse2Summary.md +25 -0
  41. data/docs/{PayeeResponseLinks.md → PagedPayeeResponseLinks.md} +2 -2
  42. data/docs/{PayeeResponsePage.md → PagedPayeeResponsePage.md} +2 -2
  43. data/docs/{PayeeResponseSummary.md → PagedPayeeResponseSummary.md} +2 -2
  44. data/docs/Payee.md +9 -9
  45. data/docs/{Address.md → PayeeAddress.md} +2 -2
  46. data/docs/PayeeDelta.md +1 -1
  47. data/docs/PayeeInvitationApi.md +109 -3
  48. data/docs/{PaymentChannel.md → PayeePaymentChannel.md} +2 -2
  49. data/docs/{PayorRef.md → PayeePayorRef.md} +2 -2
  50. data/docs/PayeePayorRef2.md +21 -0
  51. data/docs/PayeeResponse.md +40 -8
  52. data/docs/PayeeResponse2.md +55 -0
  53. data/docs/PayeesApi.md +133 -4
  54. data/docs/PaymentAuditServiceApi.md +70 -7
  55. data/docs/PaymentDelta.md +31 -0
  56. data/docs/PaymentDeltaResponse.md +21 -0
  57. data/docs/PaymentResponseV4.md +4 -2
  58. data/docs/PaymentResponseV4Payout.md +19 -0
  59. data/docs/PaymentStatus.md +16 -0
  60. data/docs/PayorAddress.md +31 -0
  61. data/docs/PayorAddressV2.md +31 -0
  62. data/docs/PayorV1.md +9 -7
  63. data/docs/PayorV2.md +9 -7
  64. data/docs/PayorsApi.md +8 -6
  65. data/docs/PayoutPayorV4.md +25 -0
  66. data/docs/PayoutPrincipalV4.md +19 -0
  67. data/docs/PayoutSummaryAuditV4.md +5 -3
  68. data/docs/PayoutTypeV4.md +16 -0
  69. data/docs/QuoteFxSummary.md +2 -2
  70. data/docs/UpdateRemoteIdRequest.md +19 -0
  71. data/docs/WatchlistStatus.md +16 -0
  72. data/lib/velopayments.rb +41 -12
  73. data/lib/velopayments/api/auth_api.rb +9 -16
  74. data/lib/velopayments/api/countries_api.rb +2 -2
  75. data/lib/velopayments/api/currencies_api.rb +2 -2
  76. data/lib/velopayments/api/funding_manager_api.rb +63 -55
  77. data/lib/velopayments/api/get_payout_api.rb +3 -3
  78. data/lib/velopayments/api/instruct_payout_api.rb +3 -3
  79. data/lib/velopayments/api/payee_invitation_api.rb +134 -8
  80. data/lib/velopayments/api/payees_api.rb +177 -9
  81. data/lib/velopayments/api/payment_audit_service_api.rb +95 -12
  82. data/lib/velopayments/api/payor_applications_api.rb +4 -4
  83. data/lib/velopayments/api/payors_api.rb +18 -19
  84. data/lib/velopayments/api/payout_history_api.rb +4 -4
  85. data/lib/velopayments/api/quote_payout_api.rb +3 -3
  86. data/lib/velopayments/api/submit_payout_api.rb +2 -2
  87. data/lib/velopayments/api/withdraw_payout_api.rb +3 -3
  88. data/lib/velopayments/api_client.rb +30 -30
  89. data/lib/velopayments/api_error.rb +2 -2
  90. data/lib/velopayments/configuration.rb +9 -2
  91. data/lib/velopayments/models/auth_response.rb +28 -7
  92. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  93. data/lib/velopayments/models/challenge.rb +13 -3
  94. data/lib/velopayments/models/company_response.rb +273 -0
  95. data/lib/velopayments/models/{company.rb → company_v1.rb} +18 -6
  96. data/lib/velopayments/models/create_individual.rb +14 -4
  97. data/lib/velopayments/models/create_individual2.rb +259 -0
  98. data/lib/velopayments/models/create_payee.rb +17 -5
  99. data/lib/velopayments/models/{payor_funding_bank_details_update.rb → create_payee2.rb} +153 -93
  100. data/lib/velopayments/models/create_payee_address.rb +19 -3
  101. data/lib/velopayments/models/create_payee_address2.rb +510 -0
  102. data/lib/velopayments/models/create_payees_csv_request.rb +14 -3
  103. data/lib/velopayments/models/create_payees_csv_request2.rb +1142 -0
  104. data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
  105. data/lib/velopayments/models/create_payees_csv_response2.rb +217 -0
  106. data/lib/velopayments/models/create_payees_request.rb +13 -3
  107. data/lib/velopayments/models/create_payees_request2.rb +227 -0
  108. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  109. data/lib/velopayments/models/create_payment_channel2.rb +418 -0
  110. data/lib/velopayments/models/create_payout_request.rb +36 -9
  111. data/lib/velopayments/models/error.rb +271 -0
  112. data/lib/velopayments/models/error_response.rb +222 -0
  113. data/lib/velopayments/models/failed_submission.rb +13 -3
  114. data/lib/velopayments/models/funding_audit.rb +38 -7
  115. data/lib/velopayments/models/funding_delta.rb +298 -0
  116. data/lib/velopayments/models/funding_delta_response.rb +229 -0
  117. data/lib/velopayments/models/funding_delta_response_links.rb +215 -0
  118. data/lib/velopayments/models/funding_event.rb +26 -7
  119. data/lib/velopayments/models/funding_event_type.rb +2 -2
  120. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  121. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  122. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  123. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  124. data/lib/velopayments/models/get_fundings_response.rb +17 -5
  125. data/lib/velopayments/models/get_fundings_response_all_of.rb +17 -5
  126. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  127. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  128. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  129. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +15 -5
  130. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +87 -4
  131. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  132. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  133. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  134. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  135. data/lib/velopayments/models/get_payouts_response_v3_summary.rb +13 -3
  136. data/lib/velopayments/models/get_payouts_response_v4.rb +16 -6
  137. data/lib/velopayments/models/individual_response.rb +211 -0
  138. data/lib/velopayments/models/{individual.rb → individual_v1.rb} +17 -7
  139. data/lib/velopayments/models/{individual_name.rb → individual_v1_name.rb} +16 -6
  140. data/lib/velopayments/models/invitation_status.rb +2 -2
  141. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  142. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  143. data/lib/velopayments/models/language.rb +2 -2
  144. data/lib/velopayments/models/list_payments_response.rb +13 -3
  145. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  146. data/lib/velopayments/models/list_payments_response_summary.rb +13 -3
  147. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  148. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  149. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  150. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  151. data/lib/velopayments/models/list_source_account_response_v2_page.rb +13 -3
  152. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  153. data/lib/velopayments/models/notifications.rb +13 -3
  154. data/lib/velopayments/models/ofac_status.rb +2 -2
  155. data/lib/velopayments/models/onboarded_status.rb +2 -2
  156. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +15 -5
  157. data/lib/velopayments/models/paged_payee_response.rb +238 -0
  158. data/lib/velopayments/models/paged_payee_response2.rb +238 -0
  159. data/lib/velopayments/models/paged_payee_response2_summary.rb +242 -0
  160. data/lib/velopayments/models/{payee_response_links.rb → paged_payee_response_links.rb} +16 -6
  161. data/lib/velopayments/models/{payee_response_page.rb → paged_payee_response_page.rb} +16 -6
  162. data/lib/velopayments/models/{payee_response_summary.rb → paged_payee_response_summary.rb} +16 -6
  163. data/lib/velopayments/models/paged_response.rb +13 -3
  164. data/lib/velopayments/models/paged_response_page.rb +13 -3
  165. data/lib/velopayments/models/payee.rb +24 -8
  166. data/lib/velopayments/models/{address.rb → payee_address.rb} +21 -6
  167. data/lib/velopayments/models/payee_delta.rb +14 -3
  168. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  169. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  170. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  171. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  172. data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
  173. data/lib/velopayments/models/{payment_channel.rb → payee_payment_channel.rb} +16 -6
  174. data/lib/velopayments/models/{payor_ref.rb → payee_payor_ref.rb} +16 -6
  175. data/lib/velopayments/models/payee_payor_ref2.rb +224 -0
  176. data/lib/velopayments/models/payee_response.rb +192 -32
  177. data/lib/velopayments/models/payee_response2.rb +388 -0
  178. data/lib/velopayments/models/payee_type.rb +2 -2
  179. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  180. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  181. data/lib/velopayments/models/payment_channel_country.rb +13 -3
  182. data/lib/velopayments/models/payment_channel_rule.rb +13 -3
  183. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  184. data/lib/velopayments/models/payment_delta.rb +285 -0
  185. data/lib/velopayments/models/payment_delta_response.rb +229 -0
  186. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  187. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  188. data/lib/velopayments/models/payment_instruction.rb +13 -3
  189. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  190. data/lib/velopayments/models/payment_response_v4.rb +27 -7
  191. data/lib/velopayments/models/payment_response_v4_payout.rb +215 -0
  192. data/lib/velopayments/models/payment_status.rb +42 -0
  193. data/lib/velopayments/models/payor_address.rb +493 -0
  194. data/lib/velopayments/models/payor_address_v2.rb +493 -0
  195. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  196. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  197. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  198. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  199. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  200. data/lib/velopayments/models/payor_links_response.rb +13 -3
  201. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  202. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  203. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  204. data/lib/velopayments/models/payor_v1.rb +27 -8
  205. data/lib/velopayments/models/payor_v2.rb +27 -8
  206. data/lib/velopayments/models/payout_payor_v4.rb +273 -0
  207. data/lib/velopayments/models/payout_principal_v4.rb +228 -0
  208. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  209. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  210. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  211. data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -8
  212. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  213. data/lib/velopayments/models/payout_type_v4.rb +37 -0
  214. data/lib/velopayments/models/query_batch_response.rb +13 -3
  215. data/lib/velopayments/models/quote_fx_summary.rb +69 -3
  216. data/lib/velopayments/models/quote_response.rb +13 -3
  217. data/lib/velopayments/models/rejected_payment.rb +13 -3
  218. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  219. data/lib/velopayments/models/source_account.rb +13 -3
  220. data/lib/velopayments/models/source_account_response.rb +15 -3
  221. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  222. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  223. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  224. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  225. data/lib/velopayments/models/supported_country.rb +13 -3
  226. data/lib/velopayments/models/supported_currency.rb +13 -3
  227. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  228. data/lib/velopayments/models/update_remote_id_request.rb +253 -0
  229. data/lib/velopayments/models/watchlist_status.rb +39 -0
  230. data/lib/velopayments/version.rb +3 -3
  231. data/oa3-config.json +2 -2
  232. data/spec/api/auth_api_spec.rb +3 -4
  233. data/spec/api/countries_api_spec.rb +2 -2
  234. data/spec/api/currencies_api_spec.rb +2 -2
  235. data/spec/api/funding_manager_api_spec.rb +17 -15
  236. data/spec/api/get_payout_api_spec.rb +2 -2
  237. data/spec/api/instruct_payout_api_spec.rb +2 -2
  238. data/spec/api/payee_invitation_api_spec.rb +27 -3
  239. data/spec/api/payees_api_spec.rb +39 -4
  240. data/spec/api/payment_audit_service_api_spec.rb +21 -5
  241. data/spec/api/payor_applications_api_spec.rb +2 -2
  242. data/spec/api/payors_api_spec.rb +5 -4
  243. data/spec/api/payout_history_api_spec.rb +2 -2
  244. data/spec/api/quote_payout_api_spec.rb +2 -2
  245. data/spec/api/submit_payout_api_spec.rb +2 -2
  246. data/spec/api/withdraw_payout_api_spec.rb +2 -2
  247. data/spec/api_client_spec.rb +3 -3
  248. data/spec/configuration_spec.rb +2 -2
  249. data/spec/models/auth_response_spec.rb +8 -2
  250. data/spec/models/auto_top_up_config_spec.rb +2 -2
  251. data/spec/models/challenge_spec.rb +2 -2
  252. data/spec/models/company_response_spec.rb +47 -0
  253. data/spec/models/{company_spec.rb → company_v1_spec.rb} +8 -8
  254. data/spec/models/{payor_funding_bank_details_update_spec.rb → create_individual2_spec.rb} +11 -11
  255. data/spec/models/create_individual_spec.rb +2 -2
  256. data/spec/models/create_payee2_spec.rb +101 -0
  257. data/spec/models/create_payee_address2_spec.rb +87 -0
  258. data/spec/models/create_payee_address_spec.rb +2 -2
  259. data/spec/models/create_payee_spec.rb +2 -2
  260. data/spec/models/create_payees_csv_request2_spec.rb +225 -0
  261. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  262. data/spec/models/create_payees_csv_response2_spec.rb +47 -0
  263. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  264. data/spec/models/create_payees_request2_spec.rb +47 -0
  265. data/spec/models/create_payees_request_spec.rb +2 -2
  266. data/spec/models/create_payment_channel2_spec.rb +85 -0
  267. data/spec/models/create_payment_channel_spec.rb +2 -2
  268. data/spec/models/create_payout_request_spec.rb +14 -2
  269. data/spec/models/error_response_spec.rb +47 -0
  270. data/spec/models/error_spec.rb +63 -0
  271. data/spec/models/failed_submission_spec.rb +2 -2
  272. data/spec/models/funding_audit_spec.rb +12 -2
  273. data/spec/models/funding_delta_response_links_spec.rb +47 -0
  274. data/spec/models/funding_delta_response_spec.rb +53 -0
  275. data/spec/models/funding_delta_spec.rb +59 -0
  276. data/spec/models/funding_event_spec.rb +8 -2
  277. data/spec/models/funding_event_type_spec.rb +2 -2
  278. data/spec/models/funding_request_v1_spec.rb +2 -2
  279. data/spec/models/funding_request_v2_spec.rb +2 -2
  280. data/spec/models/fx_summary_v3_spec.rb +2 -2
  281. data/spec/models/fx_summary_v4_spec.rb +2 -2
  282. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  283. data/spec/models/get_fundings_response_spec.rb +2 -2
  284. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  285. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  286. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  287. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  288. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +50 -2
  289. data/spec/models/get_payout_statistics_spec.rb +2 -2
  290. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  291. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  292. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  293. data/spec/models/get_payouts_response_v3_summary_spec.rb +2 -2
  294. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  295. data/spec/models/individual_response_spec.rb +41 -0
  296. data/spec/models/{individual_name_spec.rb → individual_v1_name_spec.rb} +8 -8
  297. data/spec/models/{individual_spec.rb → individual_v1_spec.rb} +8 -8
  298. data/spec/models/invitation_status_response_spec.rb +2 -2
  299. data/spec/models/invitation_status_spec.rb +2 -2
  300. data/spec/models/invite_payee_request_spec.rb +2 -2
  301. data/spec/models/language_spec.rb +2 -2
  302. data/spec/models/list_payments_response_page_spec.rb +2 -2
  303. data/spec/models/list_payments_response_spec.rb +2 -2
  304. data/spec/models/list_payments_response_summary_spec.rb +2 -2
  305. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  306. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  307. data/spec/models/list_source_account_response_spec.rb +2 -2
  308. data/spec/models/list_source_account_response_v2_page_spec.rb +2 -2
  309. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  310. data/spec/models/marketing_opt_in_spec.rb +2 -2
  311. data/spec/models/notifications_spec.rb +2 -2
  312. data/spec/models/ofac_status_spec.rb +2 -2
  313. data/spec/models/onboarded_status_spec.rb +2 -2
  314. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  315. data/spec/models/paged_payee_response2_spec.rb +59 -0
  316. data/spec/models/paged_payee_response2_summary_spec.rb +65 -0
  317. data/spec/models/{payee_response_links_spec.rb → paged_payee_response_links_spec.rb} +8 -8
  318. data/spec/models/{payee_response_page_spec.rb → paged_payee_response_page_spec.rb} +8 -8
  319. data/spec/models/paged_payee_response_spec.rb +59 -0
  320. data/spec/models/{payee_response_summary_spec.rb → paged_payee_response_summary_spec.rb} +8 -8
  321. data/spec/models/paged_response_page_spec.rb +2 -2
  322. data/spec/models/paged_response_spec.rb +2 -2
  323. data/spec/models/{address_spec.rb → payee_address_spec.rb} +8 -8
  324. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  325. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  326. data/spec/models/payee_delta_response_spec.rb +2 -2
  327. data/spec/models/payee_delta_spec.rb +2 -2
  328. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  329. data/spec/models/payee_invitation_status_spec.rb +2 -2
  330. data/spec/models/{payment_channel_spec.rb → payee_payment_channel_spec.rb} +8 -8
  331. data/spec/models/payee_payor_ref2_spec.rb +53 -0
  332. data/spec/models/{payor_ref_spec.rb → payee_payor_ref_spec.rb} +8 -8
  333. data/spec/models/payee_response2_spec.rb +155 -0
  334. data/spec/models/payee_response_spec.rb +102 -6
  335. data/spec/models/payee_spec.rb +2 -2
  336. data/spec/models/payee_type_spec.rb +2 -2
  337. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  338. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  339. data/spec/models/payment_channel_country_spec.rb +2 -2
  340. data/spec/models/payment_channel_rule_spec.rb +2 -2
  341. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  342. data/spec/models/payment_delta_response_spec.rb +53 -0
  343. data/spec/models/payment_delta_spec.rb +83 -0
  344. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  345. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  346. data/spec/models/payment_instruction_spec.rb +2 -2
  347. data/spec/models/payment_response_v3_spec.rb +2 -2
  348. data/spec/models/payment_response_v4_payout_spec.rb +47 -0
  349. data/spec/models/payment_response_v4_spec.rb +8 -2
  350. data/spec/models/payment_status_spec.rb +35 -0
  351. data/spec/models/payor_address_spec.rb +83 -0
  352. data/spec/models/payor_address_v2_spec.rb +83 -0
  353. data/spec/models/payor_branding_response_spec.rb +2 -2
  354. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  355. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  356. data/spec/models/payor_create_application_request_spec.rb +2 -2
  357. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  358. data/spec/models/payor_links_response_links_spec.rb +2 -2
  359. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  360. data/spec/models/payor_links_response_spec.rb +2 -2
  361. data/spec/models/payor_logo_request_spec.rb +2 -2
  362. data/spec/models/payor_v1_spec.rb +8 -2
  363. data/spec/models/payor_v2_spec.rb +8 -2
  364. data/spec/models/payout_payor_v4_spec.rb +65 -0
  365. data/spec/models/payout_principal_v4_spec.rb +47 -0
  366. data/spec/models/payout_status_v3_spec.rb +2 -2
  367. data/spec/models/payout_status_v4_spec.rb +2 -2
  368. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  369. data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
  370. data/spec/models/payout_summary_response_spec.rb +2 -2
  371. data/spec/models/payout_type_v4_spec.rb +35 -0
  372. data/spec/models/query_batch_response_spec.rb +2 -2
  373. data/spec/models/quote_fx_summary_spec.rb +10 -2
  374. data/spec/models/quote_response_spec.rb +2 -2
  375. data/spec/models/rejected_payment_spec.rb +2 -2
  376. data/spec/models/set_notifications_request_spec.rb +2 -2
  377. data/spec/models/source_account_response_spec.rb +2 -2
  378. data/spec/models/source_account_response_v2_spec.rb +2 -2
  379. data/spec/models/source_account_spec.rb +2 -2
  380. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  381. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  382. data/spec/models/supported_countries_response_spec.rb +2 -2
  383. data/spec/models/supported_country_spec.rb +2 -2
  384. data/spec/models/supported_currency_response_spec.rb +2 -2
  385. data/spec/models/supported_currency_spec.rb +2 -2
  386. data/spec/models/update_remote_id_request_spec.rb +47 -0
  387. data/spec/models/watchlist_status_spec.rb +35 -0
  388. data/spec/spec_helper.rb +2 -2
  389. data/velopayments.gemspec +2 -8
  390. metadata +252 -259
  391. data/Gemfile.lock +0 -79
  392. data/docs/PayorFundingBankDetailsUpdate.md +0 -21
  393. data/velopayments-2.11.73.gem +0 -0
  394. data/velopayments-2.14.90.gem +0 -0
@@ -0,0 +1,19 @@
1
+ # VeloPayments::PayoutPrincipalV4
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **principal** | **String** | Email address if principal is a user or ID if application. |
8
+ **principal_id** | **String** | The id of the principal. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'VeloPayments'
14
+
15
+ instance = VeloPayments::PayoutPrincipalV4.new(principal: null,
16
+ principal_id: null)
17
+ ```
18
+
19
+
@@ -5,18 +5,19 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **payout_id** | **String** | |
8
- **payor_id** | **String** | | [optional]
8
+ **payor_id** | **String** | Deprecated in v2.16. Will be populated with submitting payor ID until removed in a later release. | [optional]
9
9
  **status** | [**PayoutStatusV4**](PayoutStatusV4.md) | |
10
10
  **date_time** | **DateTime** | | [optional]
11
11
  **submitted_date_time** | **String** | |
12
12
  **instructed_date_time** | **String** | | [optional]
13
- **withdrawn_date_time** | **String** | | [optional]
13
+ **withdrawn_date_time** | **DateTime** | | [optional]
14
14
  **total_payments** | **Integer** | | [optional]
15
15
  **total_incomplete_payments** | **Integer** | | [optional]
16
16
  **total_returned_payments** | **Integer** | | [optional]
17
17
  **source_account_summary** | [**Array<SourceAccountSummaryV4>**](SourceAccountSummaryV4.md) | | [optional]
18
18
  **fx_summaries** | [**Array<FxSummaryV4>**](FxSummaryV4.md) | | [optional]
19
19
  **payout_memo** | **String** | | [optional]
20
+ **payout_type** | [**PayoutTypeV4**](PayoutTypeV4.md) | |
20
21
 
21
22
  ## Code Sample
22
23
 
@@ -35,7 +36,8 @@ instance = VeloPayments::PayoutSummaryAuditV4.new(payout_id: null,
35
36
  total_returned_payments: null,
36
37
  source_account_summary: null,
37
38
  fx_summaries: null,
38
- payout_memo: null)
39
+ payout_memo: null,
40
+ payout_type: null)
39
41
  ```
40
42
 
41
43
 
@@ -0,0 +1,16 @@
1
+ # VeloPayments::PayoutTypeV4
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'VeloPayments'
12
+
13
+ instance = VeloPayments::PayoutTypeV4.new()
14
+ ```
15
+
16
+
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
13
13
  **total_payment_amount** | **Integer** | |
14
14
  **source_currency** | **String** | |
15
15
  **payment_currency** | **String** | |
16
- **funding_status** | **String** | | [optional]
17
- **status** | **String** | | [optional]
16
+ **funding_status** | **String** | |
17
+ **status** | **String** | |
18
18
 
19
19
  ## Code Sample
20
20
 
@@ -0,0 +1,19 @@
1
+ # VeloPayments::UpdateRemoteIdRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payor_id** | **String** | |
8
+ **remote_id** | **String** | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'VeloPayments'
14
+
15
+ instance = VeloPayments::UpdateRemoteIdRequest.new(payor_id: null,
16
+ remote_id: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,16 @@
1
+ # VeloPayments::WatchlistStatus
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'VeloPayments'
12
+
13
+ instance = VeloPayments::WatchlistStatus.new()
14
+ ```
15
+
16
+
data/lib/velopayments.rb CHANGED
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -17,21 +17,33 @@ require 'velopayments/version'
17
17
  require 'velopayments/configuration'
18
18
 
19
19
  # Models
20
- require 'velopayments/models/address'
21
20
  require 'velopayments/models/auth_response'
22
21
  require 'velopayments/models/auto_top_up_config'
23
22
  require 'velopayments/models/challenge'
24
- require 'velopayments/models/company'
23
+ require 'velopayments/models/company_response'
24
+ require 'velopayments/models/company_v1'
25
25
  require 'velopayments/models/create_individual'
26
+ require 'velopayments/models/create_individual2'
26
27
  require 'velopayments/models/create_payee'
28
+ require 'velopayments/models/create_payee2'
27
29
  require 'velopayments/models/create_payee_address'
30
+ require 'velopayments/models/create_payee_address2'
28
31
  require 'velopayments/models/create_payees_csv_request'
32
+ require 'velopayments/models/create_payees_csv_request2'
29
33
  require 'velopayments/models/create_payees_csv_response'
34
+ require 'velopayments/models/create_payees_csv_response2'
30
35
  require 'velopayments/models/create_payees_request'
36
+ require 'velopayments/models/create_payees_request2'
31
37
  require 'velopayments/models/create_payment_channel'
38
+ require 'velopayments/models/create_payment_channel2'
32
39
  require 'velopayments/models/create_payout_request'
40
+ require 'velopayments/models/error'
41
+ require 'velopayments/models/error_response'
33
42
  require 'velopayments/models/failed_submission'
34
43
  require 'velopayments/models/funding_audit'
44
+ require 'velopayments/models/funding_delta'
45
+ require 'velopayments/models/funding_delta_response'
46
+ require 'velopayments/models/funding_delta_response_links'
35
47
  require 'velopayments/models/funding_event'
36
48
  require 'velopayments/models/funding_event_type'
37
49
  require 'velopayments/models/funding_request_v1'
@@ -51,8 +63,9 @@ require 'velopayments/models/get_payouts_response_v3_links'
51
63
  require 'velopayments/models/get_payouts_response_v3_page'
52
64
  require 'velopayments/models/get_payouts_response_v3_summary'
53
65
  require 'velopayments/models/get_payouts_response_v4'
54
- require 'velopayments/models/individual'
55
- require 'velopayments/models/individual_name'
66
+ require 'velopayments/models/individual_response'
67
+ require 'velopayments/models/individual_v1'
68
+ require 'velopayments/models/individual_v1_name'
56
69
  require 'velopayments/models/invitation_status'
57
70
  require 'velopayments/models/invitation_status_response'
58
71
  require 'velopayments/models/invite_payee_request'
@@ -70,49 +83,63 @@ require 'velopayments/models/notifications'
70
83
  require 'velopayments/models/ofac_status'
71
84
  require 'velopayments/models/onboarded_status'
72
85
  require 'velopayments/models/paged_payee_invitation_status_response'
86
+ require 'velopayments/models/paged_payee_response'
87
+ require 'velopayments/models/paged_payee_response2'
88
+ require 'velopayments/models/paged_payee_response2_summary'
89
+ require 'velopayments/models/paged_payee_response_links'
90
+ require 'velopayments/models/paged_payee_response_page'
91
+ require 'velopayments/models/paged_payee_response_summary'
73
92
  require 'velopayments/models/paged_response'
74
93
  require 'velopayments/models/paged_response_page'
75
94
  require 'velopayments/models/payee'
95
+ require 'velopayments/models/payee_address'
76
96
  require 'velopayments/models/payee_delta'
77
97
  require 'velopayments/models/payee_delta_response'
78
98
  require 'velopayments/models/payee_delta_response_links'
79
99
  require 'velopayments/models/payee_delta_response_page'
80
100
  require 'velopayments/models/payee_invitation_status'
81
101
  require 'velopayments/models/payee_invitation_status_response'
102
+ require 'velopayments/models/payee_payment_channel'
103
+ require 'velopayments/models/payee_payor_ref'
104
+ require 'velopayments/models/payee_payor_ref2'
82
105
  require 'velopayments/models/payee_response'
83
- require 'velopayments/models/payee_response_links'
84
- require 'velopayments/models/payee_response_page'
85
- require 'velopayments/models/payee_response_summary'
106
+ require 'velopayments/models/payee_response2'
86
107
  require 'velopayments/models/payee_type'
87
108
  require 'velopayments/models/payment_audit_currency_v3'
88
109
  require 'velopayments/models/payment_audit_currency_v4'
89
- require 'velopayments/models/payment_channel'
90
110
  require 'velopayments/models/payment_channel_country'
91
111
  require 'velopayments/models/payment_channel_rule'
92
112
  require 'velopayments/models/payment_channel_rules_response'
113
+ require 'velopayments/models/payment_delta'
114
+ require 'velopayments/models/payment_delta_response'
93
115
  require 'velopayments/models/payment_event_response_v3'
94
116
  require 'velopayments/models/payment_event_response_v4'
95
117
  require 'velopayments/models/payment_instruction'
96
118
  require 'velopayments/models/payment_response_v3'
97
119
  require 'velopayments/models/payment_response_v4'
120
+ require 'velopayments/models/payment_response_v4_payout'
121
+ require 'velopayments/models/payment_status'
122
+ require 'velopayments/models/payor_address'
123
+ require 'velopayments/models/payor_address_v2'
98
124
  require 'velopayments/models/payor_branding_response'
99
125
  require 'velopayments/models/payor_create_api_key_request'
100
126
  require 'velopayments/models/payor_create_api_key_response'
101
127
  require 'velopayments/models/payor_create_application_request'
102
128
  require 'velopayments/models/payor_email_opt_out_request'
103
- require 'velopayments/models/payor_funding_bank_details_update'
104
129
  require 'velopayments/models/payor_links_response'
105
130
  require 'velopayments/models/payor_links_response_links'
106
131
  require 'velopayments/models/payor_links_response_payors'
107
132
  require 'velopayments/models/payor_logo_request'
108
- require 'velopayments/models/payor_ref'
109
133
  require 'velopayments/models/payor_v1'
110
134
  require 'velopayments/models/payor_v2'
135
+ require 'velopayments/models/payout_payor_v4'
136
+ require 'velopayments/models/payout_principal_v4'
111
137
  require 'velopayments/models/payout_status_v3'
112
138
  require 'velopayments/models/payout_status_v4'
113
139
  require 'velopayments/models/payout_summary_audit_v3'
114
140
  require 'velopayments/models/payout_summary_audit_v4'
115
141
  require 'velopayments/models/payout_summary_response'
142
+ require 'velopayments/models/payout_type_v4'
116
143
  require 'velopayments/models/query_batch_response'
117
144
  require 'velopayments/models/quote_fx_summary'
118
145
  require 'velopayments/models/quote_response'
@@ -127,6 +154,8 @@ require 'velopayments/models/supported_countries_response'
127
154
  require 'velopayments/models/supported_country'
128
155
  require 'velopayments/models/supported_currency'
129
156
  require 'velopayments/models/supported_currency_response'
157
+ require 'velopayments/models/update_remote_id_request'
158
+ require 'velopayments/models/watchlist_status'
130
159
 
131
160
  # APIs
132
161
  require 'velopayments/api/auth_api'
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -20,32 +20,26 @@ module VeloPayments
20
20
  @api_client = api_client
21
21
  end
22
22
  # Authentication endpoint
23
- # Use this endpoint to obtain an access token for calling Velo Payments APIs.
24
- # @param authorization [String] String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
23
+ # Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
25
24
  # @param [Hash] opts the optional parameters
26
25
  # @option opts [String] :grant_type OAuth grant type. Should use 'client_credentials' (default to 'client_credentials')
27
26
  # @return [AuthResponse]
28
- def velo_auth(authorization, opts = {})
29
- data, _status_code, _headers = velo_auth_with_http_info(authorization, opts)
27
+ def velo_auth(opts = {})
28
+ data, _status_code, _headers = velo_auth_with_http_info(opts)
30
29
  data
31
30
  end
32
31
 
33
32
  # Authentication endpoint
34
- # Use this endpoint to obtain an access token for calling Velo Payments APIs.
35
- # @param authorization [String] String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
33
+ # Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
36
34
  # @param [Hash] opts the optional parameters
37
35
  # @option opts [String] :grant_type OAuth grant type. Should use 'client_credentials'
38
36
  # @return [Array<(AuthResponse, Integer, Hash)>] AuthResponse data, response status code and response headers
39
- def velo_auth_with_http_info(authorization, opts = {})
37
+ def velo_auth_with_http_info(opts = {})
40
38
  if @api_client.config.debugging
41
39
  @api_client.config.logger.debug 'Calling API: AuthApi.velo_auth ...'
42
40
  end
43
- # verify the required parameter 'authorization' is set
44
- if @api_client.config.client_side_validation && authorization.nil?
45
- fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthApi.velo_auth"
46
- end
47
41
  # resource path
48
- local_var_path = '/v1/authenticate/'
42
+ local_var_path = '/v1/authenticate'
49
43
 
50
44
  # query parameters
51
45
  query_params = opts[:query_params] || {}
@@ -55,7 +49,6 @@ module VeloPayments
55
49
  header_params = opts[:header_params] || {}
56
50
  # HTTP header 'Accept' (if needed)
57
51
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
58
- header_params[:'Authorization'] = authorization
59
52
 
60
53
  # form parameters
61
54
  form_params = opts[:form_params] || {}
@@ -67,7 +60,7 @@ module VeloPayments
67
60
  return_type = opts[:return_type] || 'AuthResponse'
68
61
 
69
62
  # auth_names
70
- auth_names = opts[:auth_names] || ['OAuth2']
63
+ auth_names = opts[:auth_names] || ['basicAuth']
71
64
 
72
65
  new_options = opts.merge(
73
66
  :header_params => header_params,
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -49,7 +49,7 @@ module VeloPayments
49
49
  fail ArgumentError, "Missing the required parameter 'funding_request_v1' when calling FundingManagerApi.create_ach_funding_request"
50
50
  end
51
51
  # resource path
52
- local_var_path = '/v1/sourceAccounts/{sourceAccountId}/achFundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
52
+ local_var_path = '/v1/sourceAccounts/{sourceAccountId}/achFundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
53
53
 
54
54
  # query parameters
55
55
  query_params = opts[:query_params] || {}
@@ -117,7 +117,7 @@ module VeloPayments
117
117
  fail ArgumentError, "Missing the required parameter 'funding_request_v2' when calling FundingManagerApi.create_funding_request"
118
118
  end
119
119
  # resource path
120
- local_var_path = '/v2/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
120
+ local_var_path = '/v2/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
121
121
 
122
122
  # query parameters
123
123
  query_params = opts[:query_params] || {}
@@ -247,7 +247,7 @@ module VeloPayments
247
247
  fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.get_source_account"
248
248
  end
249
249
  # resource path
250
- local_var_path = '/v1/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
250
+ local_var_path = '/v1/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
251
251
 
252
252
  # query parameters
253
253
  query_params = opts[:query_params] || {}
@@ -309,7 +309,7 @@ module VeloPayments
309
309
  fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.get_source_account_v2"
310
310
  end
311
311
  # resource path
312
- local_var_path = '/v2/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
312
+ local_var_path = '/v2/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
313
313
 
314
314
  # query parameters
315
315
  query_params = opts[:query_params] || {}
@@ -489,54 +489,62 @@ module VeloPayments
489
489
  return data, status_code, headers
490
490
  end
491
491
 
492
- # Set notifications
493
- # Set notifications for a given source account
494
- # @param source_account_id [String] Source account id
495
- # @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
492
+ # List Funding changes
493
+ # Get a paginated response listing funding changes.
494
+ # @param payor_id [String] The Payor ID to find associated funding records
495
+ # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
496
496
  # @param [Hash] opts the optional parameters
497
- # @return [nil]
498
- def set_notifications_request(source_account_id, set_notifications_request, opts = {})
499
- set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts)
500
- nil
497
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
498
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
499
+ # @return [FundingDeltaResponse]
500
+ def list_funding_audit_deltas(payor_id, updated_since, opts = {})
501
+ data, _status_code, _headers = list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts)
502
+ data
501
503
  end
502
504
 
503
- # Set notifications
504
- # Set notifications for a given source account
505
- # @param source_account_id [String] Source account id
506
- # @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
505
+ # List Funding changes
506
+ # Get a paginated response listing funding changes.
507
+ # @param payor_id [String] The Payor ID to find associated funding records
508
+ # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
507
509
  # @param [Hash] opts the optional parameters
508
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
509
- def set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts = {})
510
+ # @option opts [Integer] :page Page number. Default is 1.
511
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
512
+ # @return [Array<(FundingDeltaResponse, Integer, Hash)>] FundingDeltaResponse data, response status code and response headers
513
+ def list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts = {})
510
514
  if @api_client.config.debugging
511
- @api_client.config.logger.debug 'Calling API: FundingManagerApi.set_notifications_request ...'
515
+ @api_client.config.logger.debug 'Calling API: FundingManagerApi.list_funding_audit_deltas ...'
512
516
  end
513
- # verify the required parameter 'source_account_id' is set
514
- if @api_client.config.client_side_validation && source_account_id.nil?
515
- fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.set_notifications_request"
517
+ # verify the required parameter 'payor_id' is set
518
+ if @api_client.config.client_side_validation && payor_id.nil?
519
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling FundingManagerApi.list_funding_audit_deltas"
516
520
  end
517
- # verify the required parameter 'set_notifications_request' is set
518
- if @api_client.config.client_side_validation && set_notifications_request.nil?
519
- fail ArgumentError, "Missing the required parameter 'set_notifications_request' when calling FundingManagerApi.set_notifications_request"
521
+ # verify the required parameter 'updated_since' is set
522
+ if @api_client.config.client_side_validation && updated_since.nil?
523
+ fail ArgumentError, "Missing the required parameter 'updated_since' when calling FundingManagerApi.list_funding_audit_deltas"
520
524
  end
521
525
  # resource path
522
- local_var_path = '/v1/sourceAccounts/{sourceAccountId}/notifications'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
526
+ local_var_path = '/v1/deltas/fundings'
523
527
 
524
528
  # query parameters
525
529
  query_params = opts[:query_params] || {}
530
+ query_params[:'payorId'] = payor_id
531
+ query_params[:'updatedSince'] = updated_since
532
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
533
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
526
534
 
527
535
  # header parameters
528
536
  header_params = opts[:header_params] || {}
529
- # HTTP header 'Content-Type'
530
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
537
+ # HTTP header 'Accept' (if needed)
538
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
531
539
 
532
540
  # form parameters
533
541
  form_params = opts[:form_params] || {}
534
542
 
535
543
  # http body (model)
536
- post_body = opts[:body] || @api_client.object_to_http_body(set_notifications_request)
544
+ post_body = opts[:body]
537
545
 
538
546
  # return_type
539
- return_type = opts[:return_type]
547
+ return_type = opts[:return_type] || 'FundingDeltaResponse'
540
548
 
541
549
  # auth_names
542
550
  auth_names = opts[:auth_names] || ['OAuth2']
@@ -550,44 +558,44 @@ module VeloPayments
550
558
  :return_type => return_type
551
559
  )
552
560
 
553
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
561
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
554
562
  if @api_client.config.debugging
555
- @api_client.config.logger.debug "API called: FundingManagerApi#set_notifications_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
563
+ @api_client.config.logger.debug "API called: FundingManagerApi#list_funding_audit_deltas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
556
564
  end
557
565
  return data, status_code, headers
558
566
  end
559
567
 
560
- # Set Funding Bank Details
561
- # This API allows you to set or update the funding details for the given Payor ID.
562
- # @param payor_id [String] The account owner Payor ID
563
- # @param payor_funding_bank_details_update [PayorFundingBankDetailsUpdate] Update Funding bank details of given Payor Id
568
+ # Set notifications
569
+ # Set notifications for a given source account
570
+ # @param source_account_id [String] Source account id
571
+ # @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
564
572
  # @param [Hash] opts the optional parameters
565
573
  # @return [nil]
566
- def set_payor_funding_bank_details(payor_id, payor_funding_bank_details_update, opts = {})
567
- set_payor_funding_bank_details_with_http_info(payor_id, payor_funding_bank_details_update, opts)
574
+ def set_notifications_request(source_account_id, set_notifications_request, opts = {})
575
+ set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts)
568
576
  nil
569
577
  end
570
578
 
571
- # Set Funding Bank Details
572
- # This API allows you to set or update the funding details for the given Payor ID.
573
- # @param payor_id [String] The account owner Payor ID
574
- # @param payor_funding_bank_details_update [PayorFundingBankDetailsUpdate] Update Funding bank details of given Payor Id
579
+ # Set notifications
580
+ # Set notifications for a given source account
581
+ # @param source_account_id [String] Source account id
582
+ # @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
575
583
  # @param [Hash] opts the optional parameters
576
584
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
577
- def set_payor_funding_bank_details_with_http_info(payor_id, payor_funding_bank_details_update, opts = {})
585
+ def set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts = {})
578
586
  if @api_client.config.debugging
579
- @api_client.config.logger.debug 'Calling API: FundingManagerApi.set_payor_funding_bank_details ...'
587
+ @api_client.config.logger.debug 'Calling API: FundingManagerApi.set_notifications_request ...'
580
588
  end
581
- # verify the required parameter 'payor_id' is set
582
- if @api_client.config.client_side_validation && payor_id.nil?
583
- fail ArgumentError, "Missing the required parameter 'payor_id' when calling FundingManagerApi.set_payor_funding_bank_details"
589
+ # verify the required parameter 'source_account_id' is set
590
+ if @api_client.config.client_side_validation && source_account_id.nil?
591
+ fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.set_notifications_request"
584
592
  end
585
- # verify the required parameter 'payor_funding_bank_details_update' is set
586
- if @api_client.config.client_side_validation && payor_funding_bank_details_update.nil?
587
- fail ArgumentError, "Missing the required parameter 'payor_funding_bank_details_update' when calling FundingManagerApi.set_payor_funding_bank_details"
593
+ # verify the required parameter 'set_notifications_request' is set
594
+ if @api_client.config.client_side_validation && set_notifications_request.nil?
595
+ fail ArgumentError, "Missing the required parameter 'set_notifications_request' when calling FundingManagerApi.set_notifications_request"
588
596
  end
589
597
  # resource path
590
- local_var_path = '/v1/payors/{payorId}/payorFundingBankDetailsUpdate'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
598
+ local_var_path = '/v1/sourceAccounts/{sourceAccountId}/notifications'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
591
599
 
592
600
  # query parameters
593
601
  query_params = opts[:query_params] || {}
@@ -601,7 +609,7 @@ module VeloPayments
601
609
  form_params = opts[:form_params] || {}
602
610
 
603
611
  # http body (model)
604
- post_body = opts[:body] || @api_client.object_to_http_body(payor_funding_bank_details_update)
612
+ post_body = opts[:body] || @api_client.object_to_http_body(set_notifications_request)
605
613
 
606
614
  # return_type
607
615
  return_type = opts[:return_type]
@@ -620,7 +628,7 @@ module VeloPayments
620
628
 
621
629
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
622
630
  if @api_client.config.debugging
623
- @api_client.config.logger.debug "API called: FundingManagerApi#set_payor_funding_bank_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
631
+ @api_client.config.logger.debug "API called: FundingManagerApi#set_notifications_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
624
632
  end
625
633
  return data, status_code, headers
626
634
  end