velopayments 2.19.116 → 2.20.29.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 (492) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +7 -0
  3. data/Gemfile +1 -1
  4. data/Makefile +3 -11
  5. data/README.md +7 -5
  6. data/docs/InlineResponse409.md +19 -0
  7. data/docs/InlineResponse409Errors.md +23 -0
  8. data/lib/velopayments.rb +4 -2
  9. data/lib/velopayments/api/countries_api.rb +2 -2
  10. data/lib/velopayments/api/currencies_api.rb +2 -2
  11. data/lib/velopayments/api/funding_manager_api.rb +2 -2
  12. data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
  13. data/lib/velopayments/api/get_payout_api.rb +2 -2
  14. data/lib/velopayments/api/instruct_payout_api.rb +2 -2
  15. data/lib/velopayments/api/login_api.rb +2 -2
  16. data/lib/velopayments/api/payee_invitation_api.rb +2 -2
  17. data/lib/velopayments/api/payees_api.rb +2 -2
  18. data/lib/velopayments/api/payment_audit_service_api.rb +2 -2
  19. data/lib/velopayments/api/payors_api.rb +2 -2
  20. data/lib/velopayments/api/payors_private_api.rb +2 -2
  21. data/lib/velopayments/api/payout_history_api.rb +2 -2
  22. data/lib/velopayments/api/quote_payout_api.rb +2 -2
  23. data/lib/velopayments/api/submit_payout_api.rb +2 -2
  24. data/lib/velopayments/api/tokens_api.rb +2 -2
  25. data/lib/velopayments/api/users_api.rb +2 -2
  26. data/lib/velopayments/api/withdraw_payout_api.rb +2 -2
  27. data/lib/velopayments/api_client.rb +2 -2
  28. data/lib/velopayments/api_error.rb +2 -2
  29. data/lib/velopayments/configuration.rb +2 -2
  30. data/lib/velopayments/models/accepted_payment.rb +13 -3
  31. data/lib/velopayments/models/access_token_response.rb +13 -3
  32. data/lib/velopayments/models/access_token_validation_request.rb +13 -3
  33. data/lib/velopayments/models/auth_response.rb +13 -3
  34. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  35. data/lib/velopayments/models/challenge.rb +13 -3
  36. data/lib/velopayments/models/company.rb +15 -3
  37. data/lib/velopayments/models/company2.rb +15 -3
  38. data/lib/velopayments/models/company_response.rb +14 -3
  39. data/lib/velopayments/models/company_v1.rb +15 -3
  40. data/lib/velopayments/models/create_funding_account_request.rb +13 -3
  41. data/lib/velopayments/models/create_individual.rb +13 -3
  42. data/lib/velopayments/models/create_individual2.rb +13 -3
  43. data/lib/velopayments/models/create_individual2_name.rb +13 -3
  44. data/lib/velopayments/models/create_payee.rb +15 -3
  45. data/lib/velopayments/models/create_payee2.rb +15 -3
  46. data/lib/velopayments/models/create_payee_address.rb +18 -3
  47. data/lib/velopayments/models/create_payee_address2.rb +18 -3
  48. data/lib/velopayments/models/create_payees_csv_request.rb +13 -3
  49. data/lib/velopayments/models/create_payees_csv_request2.rb +13 -3
  50. data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
  51. data/lib/velopayments/models/create_payees_csv_response2.rb +13 -3
  52. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +13 -3
  53. data/lib/velopayments/models/create_payees_request.rb +13 -3
  54. data/lib/velopayments/models/create_payees_request2.rb +13 -3
  55. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  56. data/lib/velopayments/models/create_payment_channel2.rb +13 -3
  57. data/lib/velopayments/models/create_payor_link_request.rb +13 -3
  58. data/lib/velopayments/models/create_payout_request.rb +13 -3
  59. data/lib/velopayments/models/currency_type.rb +13 -3
  60. data/lib/velopayments/models/error.rb +13 -3
  61. data/lib/velopayments/models/error_response.rb +15 -3
  62. data/lib/velopayments/models/failed_submission.rb +13 -3
  63. data/lib/velopayments/models/failed_submission2.rb +13 -3
  64. data/lib/velopayments/models/funding_account_response.rb +13 -3
  65. data/lib/velopayments/models/funding_audit.rb +13 -3
  66. data/lib/velopayments/models/funding_event.rb +13 -3
  67. data/lib/velopayments/models/funding_event_type.rb +2 -2
  68. data/lib/velopayments/models/funding_payor_status_audit_response.rb +13 -3
  69. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  70. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  71. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  72. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  73. data/lib/velopayments/models/get_fundings_response.rb +13 -3
  74. data/lib/velopayments/models/get_fundings_response_all_of.rb +13 -3
  75. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  76. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  77. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  78. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +13 -3
  79. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +13 -3
  80. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  81. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  82. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  83. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  84. data/lib/velopayments/models/get_payouts_response_v4.rb +13 -3
  85. data/lib/velopayments/models/individual.rb +13 -3
  86. data/lib/velopayments/models/individual2.rb +13 -3
  87. data/lib/velopayments/models/individual_response.rb +13 -3
  88. data/lib/velopayments/models/individual_v1.rb +13 -3
  89. data/lib/velopayments/models/individual_v1_name.rb +13 -3
  90. data/lib/velopayments/models/inline_response400.rb +15 -3
  91. data/lib/velopayments/models/inline_response400_errors.rb +13 -3
  92. data/lib/velopayments/models/inline_response401.rb +15 -3
  93. data/lib/velopayments/models/inline_response401_errors.rb +13 -3
  94. data/lib/velopayments/models/inline_response403.rb +15 -3
  95. data/lib/velopayments/models/inline_response403_errors.rb +13 -3
  96. data/lib/velopayments/models/inline_response409.rb +221 -0
  97. data/lib/velopayments/models/inline_response409_errors.rb +236 -0
  98. data/lib/velopayments/models/invitation_status.rb +2 -2
  99. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  100. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  101. data/lib/velopayments/models/invite_payee_request2.rb +13 -3
  102. data/lib/velopayments/models/invite_user_request.rb +16 -3
  103. data/lib/velopayments/models/kyc_state.rb +2 -2
  104. data/lib/velopayments/models/language.rb +2 -2
  105. data/lib/velopayments/models/language2.rb +2 -2
  106. data/lib/velopayments/models/link_for_response.rb +13 -3
  107. data/lib/velopayments/models/list_funding_accounts_response.rb +13 -3
  108. data/lib/velopayments/models/list_payments_response.rb +13 -3
  109. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  110. data/lib/velopayments/models/list_payments_response_v4.rb +13 -3
  111. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  112. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  113. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  114. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  115. data/lib/velopayments/models/location_type.rb +2 -2
  116. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  117. data/lib/velopayments/models/mfa_details.rb +14 -3
  118. data/lib/velopayments/models/mfa_type.rb +2 -2
  119. data/lib/velopayments/models/notifications.rb +13 -3
  120. data/lib/velopayments/models/ofac_status.rb +2 -2
  121. data/lib/velopayments/models/ofac_status2.rb +2 -2
  122. data/lib/velopayments/models/onboarded_status.rb +2 -2
  123. data/lib/velopayments/models/onboarded_status2.rb +2 -2
  124. data/lib/velopayments/models/page_for_response.rb +13 -3
  125. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +13 -3
  126. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +13 -3
  127. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +13 -3
  128. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +13 -3
  129. data/lib/velopayments/models/paged_payee_response.rb +13 -3
  130. data/lib/velopayments/models/paged_payee_response2.rb +13 -3
  131. data/lib/velopayments/models/paged_payee_response2_summary.rb +13 -3
  132. data/lib/velopayments/models/paged_payee_response_links.rb +13 -3
  133. data/lib/velopayments/models/paged_payee_response_page.rb +13 -3
  134. data/lib/velopayments/models/paged_payee_response_summary.rb +13 -3
  135. data/lib/velopayments/models/paged_response.rb +13 -3
  136. data/lib/velopayments/models/paged_response_page.rb +13 -3
  137. data/lib/velopayments/models/paged_user_response.rb +13 -3
  138. data/lib/velopayments/models/paged_user_response_links.rb +13 -3
  139. data/lib/velopayments/models/paged_user_response_page.rb +13 -3
  140. data/lib/velopayments/models/password_request.rb +13 -3
  141. data/lib/velopayments/models/payee.rb +19 -3
  142. data/lib/velopayments/models/payee2.rb +19 -3
  143. data/lib/velopayments/models/payee_address.rb +18 -3
  144. data/lib/velopayments/models/payee_address2.rb +18 -3
  145. data/lib/velopayments/models/payee_delta.rb +14 -3
  146. data/lib/velopayments/models/payee_delta2.rb +14 -3
  147. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  148. data/lib/velopayments/models/payee_delta_response2.rb +13 -3
  149. data/lib/velopayments/models/payee_delta_response2_links.rb +13 -3
  150. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  151. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  152. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  153. data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
  154. data/lib/velopayments/models/payee_invitation_status_response2.rb +13 -3
  155. data/lib/velopayments/models/payee_payment_channel.rb +13 -3
  156. data/lib/velopayments/models/payee_payment_channel2.rb +13 -3
  157. data/lib/velopayments/models/payee_payor_ref.rb +13 -3
  158. data/lib/velopayments/models/payee_payor_ref_v2.rb +14 -3
  159. data/lib/velopayments/models/payee_payor_ref_v3.rb +14 -3
  160. data/lib/velopayments/models/payee_response.rb +19 -3
  161. data/lib/velopayments/models/payee_response2.rb +19 -3
  162. data/lib/velopayments/models/payee_response_v2.rb +23 -3
  163. data/lib/velopayments/models/payee_response_v3.rb +23 -3
  164. data/lib/velopayments/models/payee_type.rb +2 -2
  165. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  166. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  167. data/lib/velopayments/models/payment_channel_country.rb +13 -3
  168. data/lib/velopayments/models/payment_channel_rule.rb +13 -3
  169. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  170. data/lib/velopayments/models/payment_delta.rb +19 -3
  171. data/lib/velopayments/models/payment_delta_response.rb +13 -3
  172. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  173. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  174. data/lib/velopayments/models/payment_instruction.rb +13 -3
  175. data/lib/velopayments/models/payment_rails.rb +2 -2
  176. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  177. data/lib/velopayments/models/payment_response_v4.rb +13 -3
  178. data/lib/velopayments/models/payment_response_v4_payout.rb +13 -3
  179. data/lib/velopayments/models/payor_address.rb +18 -3
  180. data/lib/velopayments/models/payor_address_v2.rb +18 -3
  181. data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -3
  182. data/lib/velopayments/models/payor_aml_transaction_v4.rb +13 -3
  183. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  184. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  185. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  186. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  187. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  188. data/lib/velopayments/models/payor_links_response.rb +13 -3
  189. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  190. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  191. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  192. data/lib/velopayments/models/payor_v1.rb +13 -3
  193. data/lib/velopayments/models/payor_v2.rb +13 -3
  194. data/lib/velopayments/models/payout_payor_v4.rb +13 -3
  195. data/lib/velopayments/models/payout_principal_v4.rb +13 -3
  196. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  197. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  198. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  199. data/lib/velopayments/models/payout_summary_audit_v4.rb +13 -3
  200. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  201. data/lib/velopayments/models/payout_type_v4.rb +2 -2
  202. data/lib/velopayments/models/query_batch_response.rb +13 -3
  203. data/lib/velopayments/models/query_batch_response2.rb +13 -3
  204. data/lib/velopayments/models/quote_fx_summary.rb +13 -3
  205. data/lib/velopayments/models/quote_response.rb +13 -3
  206. data/lib/velopayments/models/region.rb +13 -3
  207. data/lib/velopayments/models/register_sms_request.rb +13 -3
  208. data/lib/velopayments/models/rejected_payment.rb +13 -3
  209. data/lib/velopayments/models/resend_token_request.rb +14 -3
  210. data/lib/velopayments/models/reset_password_request.rb +13 -3
  211. data/lib/velopayments/models/role.rb +13 -3
  212. data/lib/velopayments/models/role_update_request.rb +14 -3
  213. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +13 -3
  214. data/lib/velopayments/models/self_update_password_request.rb +13 -3
  215. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  216. data/lib/velopayments/models/source_account.rb +13 -3
  217. data/lib/velopayments/models/source_account_response.rb +15 -3
  218. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  219. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  220. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  221. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  222. data/lib/velopayments/models/supported_countries_response2.rb +13 -3
  223. data/lib/velopayments/models/supported_country.rb +13 -3
  224. data/lib/velopayments/models/supported_country2.rb +13 -3
  225. data/lib/velopayments/models/supported_currency.rb +13 -3
  226. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  227. data/lib/velopayments/models/transfer_request.rb +13 -3
  228. data/lib/velopayments/models/unregister_mfa_request.rb +14 -3
  229. data/lib/velopayments/models/update_remote_id_request.rb +13 -3
  230. data/lib/velopayments/models/user_details_update_request.rb +21 -3
  231. data/lib/velopayments/models/user_info.rb +13 -3
  232. data/lib/velopayments/models/user_response.rb +14 -3
  233. data/lib/velopayments/models/user_response2.rb +14 -3
  234. data/lib/velopayments/models/user_response2_roles.rb +13 -3
  235. data/lib/velopayments/models/user_status.rb +2 -2
  236. data/lib/velopayments/models/user_type.rb +2 -2
  237. data/lib/velopayments/models/user_type2.rb +2 -2
  238. data/lib/velopayments/models/validate_password_response.rb +13 -3
  239. data/lib/velopayments/models/watchlist_status.rb +2 -2
  240. data/lib/velopayments/version.rb +3 -3
  241. data/oa3-config.json +1 -1
  242. data/spec/api/countries_api_spec.rb +2 -2
  243. data/spec/api/currencies_api_spec.rb +2 -2
  244. data/spec/api/funding_manager_api_spec.rb +2 -2
  245. data/spec/api/funding_manager_private_api_spec.rb +2 -2
  246. data/spec/api/get_payout_api_spec.rb +2 -2
  247. data/spec/api/instruct_payout_api_spec.rb +2 -2
  248. data/spec/api/login_api_spec.rb +2 -2
  249. data/spec/api/payee_invitation_api_spec.rb +2 -2
  250. data/spec/api/payees_api_spec.rb +2 -2
  251. data/spec/api/payment_audit_service_api_spec.rb +2 -2
  252. data/spec/api/payors_api_spec.rb +2 -2
  253. data/spec/api/payors_private_api_spec.rb +2 -2
  254. data/spec/api/payout_history_api_spec.rb +2 -2
  255. data/spec/api/quote_payout_api_spec.rb +2 -2
  256. data/spec/api/submit_payout_api_spec.rb +2 -2
  257. data/spec/api/tokens_api_spec.rb +2 -2
  258. data/spec/api/users_api_spec.rb +2 -2
  259. data/spec/api/withdraw_payout_api_spec.rb +2 -2
  260. data/spec/api_client_spec.rb +3 -3
  261. data/spec/configuration_spec.rb +2 -2
  262. data/spec/models/accepted_payment_spec.rb +2 -2
  263. data/spec/models/access_token_response_spec.rb +2 -2
  264. data/spec/models/access_token_validation_request_spec.rb +2 -2
  265. data/spec/models/auth_response_spec.rb +2 -2
  266. data/spec/models/auto_top_up_config_spec.rb +2 -2
  267. data/spec/models/challenge_spec.rb +2 -2
  268. data/spec/models/company2_spec.rb +2 -2
  269. data/spec/models/company_response_spec.rb +2 -2
  270. data/spec/models/company_spec.rb +2 -2
  271. data/spec/models/company_v1_spec.rb +2 -2
  272. data/spec/models/create_funding_account_request_spec.rb +2 -2
  273. data/spec/models/create_individual2_name_spec.rb +2 -2
  274. data/spec/models/create_individual2_spec.rb +2 -2
  275. data/spec/models/create_individual_spec.rb +2 -2
  276. data/spec/models/create_payee2_spec.rb +2 -2
  277. data/spec/models/create_payee_address2_spec.rb +2 -2
  278. data/spec/models/create_payee_address_spec.rb +2 -2
  279. data/spec/models/create_payee_spec.rb +2 -2
  280. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  281. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  282. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  283. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
  284. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  285. data/spec/models/create_payees_request2_spec.rb +2 -2
  286. data/spec/models/create_payees_request_spec.rb +2 -2
  287. data/spec/models/create_payment_channel2_spec.rb +2 -2
  288. data/spec/models/create_payment_channel_spec.rb +2 -2
  289. data/spec/models/create_payor_link_request_spec.rb +2 -2
  290. data/spec/models/create_payout_request_spec.rb +2 -2
  291. data/spec/models/currency_type_spec.rb +2 -2
  292. data/spec/models/error_response_spec.rb +2 -2
  293. data/spec/models/error_spec.rb +2 -2
  294. data/spec/models/failed_submission2_spec.rb +2 -2
  295. data/spec/models/failed_submission_spec.rb +2 -2
  296. data/spec/models/funding_account_response_spec.rb +2 -2
  297. data/spec/models/funding_audit_spec.rb +2 -2
  298. data/spec/models/funding_event_spec.rb +2 -2
  299. data/spec/models/funding_event_type_spec.rb +2 -2
  300. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  301. data/spec/models/funding_request_v1_spec.rb +2 -2
  302. data/spec/models/funding_request_v2_spec.rb +2 -2
  303. data/spec/models/fx_summary_v3_spec.rb +2 -2
  304. data/spec/models/fx_summary_v4_spec.rb +2 -2
  305. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  306. data/spec/models/get_fundings_response_spec.rb +2 -2
  307. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  308. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  309. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  310. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  311. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +2 -2
  312. data/spec/models/get_payout_statistics_spec.rb +2 -2
  313. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  314. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  315. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  316. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  317. data/spec/models/individual2_spec.rb +2 -2
  318. data/spec/models/individual_response_spec.rb +2 -2
  319. data/spec/models/individual_spec.rb +2 -2
  320. data/spec/models/individual_v1_name_spec.rb +2 -2
  321. data/spec/models/individual_v1_spec.rb +2 -2
  322. data/spec/models/inline_response400_errors_spec.rb +2 -2
  323. data/spec/models/inline_response400_spec.rb +2 -2
  324. data/spec/models/inline_response401_errors_spec.rb +2 -2
  325. data/spec/models/inline_response401_spec.rb +2 -2
  326. data/spec/models/inline_response403_errors_spec.rb +2 -2
  327. data/spec/models/inline_response403_spec.rb +2 -2
  328. data/spec/models/inline_response409_errors_spec.rb +59 -0
  329. data/spec/models/inline_response409_spec.rb +47 -0
  330. data/spec/models/invitation_status_response_spec.rb +2 -2
  331. data/spec/models/invitation_status_spec.rb +2 -2
  332. data/spec/models/invite_payee_request2_spec.rb +2 -2
  333. data/spec/models/invite_payee_request_spec.rb +2 -2
  334. data/spec/models/invite_user_request_spec.rb +2 -2
  335. data/spec/models/kyc_state_spec.rb +2 -2
  336. data/spec/models/language2_spec.rb +2 -2
  337. data/spec/models/language_spec.rb +2 -2
  338. data/spec/models/link_for_response_spec.rb +2 -2
  339. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  340. data/spec/models/list_payments_response_page_spec.rb +2 -2
  341. data/spec/models/list_payments_response_spec.rb +2 -2
  342. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  343. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  344. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  345. data/spec/models/list_source_account_response_spec.rb +2 -2
  346. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  347. data/spec/models/location_type_spec.rb +2 -2
  348. data/spec/models/marketing_opt_in_spec.rb +2 -2
  349. data/spec/models/mfa_details_spec.rb +2 -2
  350. data/spec/models/mfa_type_spec.rb +2 -2
  351. data/spec/models/notifications_spec.rb +2 -2
  352. data/spec/models/ofac_status2_spec.rb +2 -2
  353. data/spec/models/ofac_status_spec.rb +2 -2
  354. data/spec/models/onboarded_status2_spec.rb +2 -2
  355. data/spec/models/onboarded_status_spec.rb +2 -2
  356. data/spec/models/page_for_response_spec.rb +2 -2
  357. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  358. data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
  359. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
  360. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  361. data/spec/models/paged_payee_response2_spec.rb +2 -2
  362. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  363. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  364. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  365. data/spec/models/paged_payee_response_spec.rb +2 -2
  366. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  367. data/spec/models/paged_response_page_spec.rb +2 -2
  368. data/spec/models/paged_response_spec.rb +2 -2
  369. data/spec/models/paged_user_response_links_spec.rb +2 -2
  370. data/spec/models/paged_user_response_page_spec.rb +2 -2
  371. data/spec/models/paged_user_response_spec.rb +2 -2
  372. data/spec/models/password_request_spec.rb +2 -2
  373. data/spec/models/payee2_spec.rb +2 -2
  374. data/spec/models/payee_address2_spec.rb +2 -2
  375. data/spec/models/payee_address_spec.rb +2 -2
  376. data/spec/models/payee_delta2_spec.rb +2 -2
  377. data/spec/models/payee_delta_response2_links_spec.rb +2 -2
  378. data/spec/models/payee_delta_response2_spec.rb +2 -2
  379. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  380. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  381. data/spec/models/payee_delta_response_spec.rb +2 -2
  382. data/spec/models/payee_delta_spec.rb +2 -2
  383. data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
  384. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  385. data/spec/models/payee_invitation_status_spec.rb +2 -2
  386. data/spec/models/payee_payment_channel2_spec.rb +2 -2
  387. data/spec/models/payee_payment_channel_spec.rb +2 -2
  388. data/spec/models/payee_payor_ref_spec.rb +2 -2
  389. data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
  390. data/spec/models/payee_payor_ref_v3_spec.rb +2 -2
  391. data/spec/models/payee_response2_spec.rb +2 -2
  392. data/spec/models/payee_response_spec.rb +2 -2
  393. data/spec/models/payee_response_v2_spec.rb +2 -2
  394. data/spec/models/payee_response_v3_spec.rb +2 -2
  395. data/spec/models/payee_spec.rb +2 -2
  396. data/spec/models/payee_type_spec.rb +2 -2
  397. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  398. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  399. data/spec/models/payment_channel_country_spec.rb +2 -2
  400. data/spec/models/payment_channel_rule_spec.rb +2 -2
  401. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  402. data/spec/models/payment_delta_response_spec.rb +2 -2
  403. data/spec/models/payment_delta_spec.rb +2 -2
  404. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  405. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  406. data/spec/models/payment_instruction_spec.rb +2 -2
  407. data/spec/models/payment_rails_spec.rb +2 -2
  408. data/spec/models/payment_response_v3_spec.rb +2 -2
  409. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  410. data/spec/models/payment_response_v4_spec.rb +2 -2
  411. data/spec/models/payor_address_spec.rb +2 -2
  412. data/spec/models/payor_address_v2_spec.rb +2 -2
  413. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  414. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  415. data/spec/models/payor_branding_response_spec.rb +2 -2
  416. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  417. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  418. data/spec/models/payor_create_application_request_spec.rb +2 -2
  419. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  420. data/spec/models/payor_links_response_links_spec.rb +2 -2
  421. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  422. data/spec/models/payor_links_response_spec.rb +2 -2
  423. data/spec/models/payor_logo_request_spec.rb +2 -2
  424. data/spec/models/payor_v1_spec.rb +2 -2
  425. data/spec/models/payor_v2_spec.rb +2 -2
  426. data/spec/models/payout_payor_v4_spec.rb +2 -2
  427. data/spec/models/payout_principal_v4_spec.rb +2 -2
  428. data/spec/models/payout_status_v3_spec.rb +2 -2
  429. data/spec/models/payout_status_v4_spec.rb +2 -2
  430. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  431. data/spec/models/payout_summary_audit_v4_spec.rb +2 -2
  432. data/spec/models/payout_summary_response_spec.rb +2 -2
  433. data/spec/models/payout_type_v4_spec.rb +2 -2
  434. data/spec/models/query_batch_response2_spec.rb +2 -2
  435. data/spec/models/query_batch_response_spec.rb +2 -2
  436. data/spec/models/quote_fx_summary_spec.rb +2 -2
  437. data/spec/models/quote_response_spec.rb +2 -2
  438. data/spec/models/region_spec.rb +2 -2
  439. data/spec/models/register_sms_request_spec.rb +2 -2
  440. data/spec/models/rejected_payment_spec.rb +2 -2
  441. data/spec/models/resend_token_request_spec.rb +2 -2
  442. data/spec/models/reset_password_request_spec.rb +2 -2
  443. data/spec/models/role_spec.rb +2 -2
  444. data/spec/models/role_update_request_spec.rb +2 -2
  445. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  446. data/spec/models/self_update_password_request_spec.rb +2 -2
  447. data/spec/models/set_notifications_request_spec.rb +2 -2
  448. data/spec/models/source_account_response_spec.rb +2 -2
  449. data/spec/models/source_account_response_v2_spec.rb +2 -2
  450. data/spec/models/source_account_spec.rb +2 -2
  451. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  452. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  453. data/spec/models/supported_countries_response2_spec.rb +2 -2
  454. data/spec/models/supported_countries_response_spec.rb +2 -2
  455. data/spec/models/supported_country2_spec.rb +2 -2
  456. data/spec/models/supported_country_spec.rb +2 -2
  457. data/spec/models/supported_currency_response_spec.rb +2 -2
  458. data/spec/models/supported_currency_spec.rb +2 -2
  459. data/spec/models/transfer_request_spec.rb +2 -2
  460. data/spec/models/unregister_mfa_request_spec.rb +2 -2
  461. data/spec/models/update_remote_id_request_spec.rb +2 -2
  462. data/spec/models/user_details_update_request_spec.rb +2 -2
  463. data/spec/models/user_info_spec.rb +2 -2
  464. data/spec/models/user_response2_roles_spec.rb +2 -2
  465. data/spec/models/user_response2_spec.rb +2 -2
  466. data/spec/models/user_response_spec.rb +2 -2
  467. data/spec/models/user_status_spec.rb +2 -2
  468. data/spec/models/user_type2_spec.rb +2 -2
  469. data/spec/models/user_type_spec.rb +2 -2
  470. data/spec/models/validate_password_response_spec.rb +2 -2
  471. data/spec/models/watchlist_status_spec.rb +2 -2
  472. data/spec/spec_helper.rb +2 -2
  473. data/specs/api/countries_api_spec.rb +68 -0
  474. data/specs/api/currencies_api_spec.rb +46 -0
  475. data/specs/api/funding_manager_api_spec.rb +205 -0
  476. data/specs/api/funding_manager_private_api_spec.rb +47 -0
  477. data/specs/api/get_payout_api_spec.rb +47 -0
  478. data/specs/api/instruct_payout_api_spec.rb +47 -0
  479. data/specs/api/login_api_spec.rb +82 -0
  480. data/specs/api/payee_invitation_api_spec.rb +153 -0
  481. data/specs/api/payees_api_spec.rb +198 -0
  482. data/specs/api/payment_audit_service_api_spec.rb +267 -0
  483. data/specs/api/payors_api_spec.rb +138 -0
  484. data/specs/api/payors_private_api_spec.rb +47 -0
  485. data/specs/api/payout_history_api_spec.rb +95 -0
  486. data/specs/api/quote_payout_api_spec.rb +47 -0
  487. data/specs/api/submit_payout_api_spec.rb +47 -0
  488. data/specs/api/tokens_api_spec.rb +48 -0
  489. data/specs/api/users_api_spec.rb +235 -0
  490. data/specs/api/withdraw_payout_api_spec.rb +47 -0
  491. data/velopayments.gemspec +2 -2
  492. metadata +226 -199
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -52,6 +52,12 @@ module VeloPayments
52
52
  }
53
53
  end
54
54
 
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
55
61
  # Initializes the object
56
62
  # @param [Hash] attributes Model attributes in the form of hash
57
63
  def initialize(attributes = {})
@@ -236,7 +242,11 @@ module VeloPayments
236
242
  hash = {}
237
243
  self.class.attribute_map.each_pair do |attr, param|
238
244
  value = self.send(attr)
239
- next if value.nil?
245
+ if value.nil?
246
+ is_nullable = self.class.openapi_nullable.include?(attr)
247
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
248
+ end
249
+
240
250
  hash[param] = _to_hash(value)
241
251
  end
242
252
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -37,6 +37,12 @@ module VeloPayments
37
37
  }
38
38
  end
39
39
 
40
+ # List of attributes with nullable: true
41
+ def self.openapi_nullable
42
+ Set.new([
43
+ ])
44
+ end
45
+
40
46
  # Initializes the object
41
47
  # @param [Hash] attributes Model attributes in the form of hash
42
48
  def initialize(attributes = {})
@@ -191,7 +197,11 @@ module VeloPayments
191
197
  hash = {}
192
198
  self.class.attribute_map.each_pair do |attr, param|
193
199
  value = self.send(attr)
194
- next if value.nil?
200
+ if value.nil?
201
+ is_nullable = self.class.openapi_nullable.include?(attr)
202
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
203
+ end
204
+
195
205
  hash[param] = _to_hash(value)
196
206
  end
197
207
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -74,6 +74,12 @@ module VeloPayments
74
74
  }
75
75
  end
76
76
 
77
+ # List of attributes with nullable: true
78
+ def self.openapi_nullable
79
+ Set.new([
80
+ ])
81
+ end
82
+
77
83
  # Initializes the object
78
84
  # @param [Hash] attributes Model attributes in the form of hash
79
85
  def initialize(attributes = {})
@@ -287,7 +293,11 @@ module VeloPayments
287
293
  hash = {}
288
294
  self.class.attribute_map.each_pair do |attr, param|
289
295
  value = self.send(attr)
290
- next if value.nil?
296
+ if value.nil?
297
+ is_nullable = self.class.openapi_nullable.include?(attr)
298
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
299
+ end
300
+
291
301
  hash[param] = _to_hash(value)
292
302
  end
293
303
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -86,6 +86,12 @@ module VeloPayments
86
86
  }
87
87
  end
88
88
 
89
+ # List of attributes with nullable: true
90
+ def self.openapi_nullable
91
+ Set.new([
92
+ ])
93
+ end
94
+
89
95
  # Initializes the object
90
96
  # @param [Hash] attributes Model attributes in the form of hash
91
97
  def initialize(attributes = {})
@@ -319,7 +325,11 @@ module VeloPayments
319
325
  hash = {}
320
326
  self.class.attribute_map.each_pair do |attr, param|
321
327
  value = self.send(attr)
322
- next if value.nil?
328
+ if value.nil?
329
+ is_nullable = self.class.openapi_nullable.include?(attr)
330
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
331
+ end
332
+
323
333
  hash[param] = _to_hash(value)
324
334
  end
325
335
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -62,6 +62,12 @@ module VeloPayments
62
62
  }
63
63
  end
64
64
 
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ ])
69
+ end
70
+
65
71
  # Initializes the object
66
72
  # @param [Hash] attributes Model attributes in the form of hash
67
73
  def initialize(attributes = {})
@@ -269,7 +275,11 @@ module VeloPayments
269
275
  hash = {}
270
276
  self.class.attribute_map.each_pair do |attr, param|
271
277
  value = self.send(attr)
272
- next if value.nil?
278
+ if value.nil?
279
+ is_nullable = self.class.openapi_nullable.include?(attr)
280
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
281
+ end
282
+
273
283
  hash[param] = _to_hash(value)
274
284
  end
275
285
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -65,6 +65,12 @@ module VeloPayments
65
65
  }
66
66
  end
67
67
 
68
+ # List of attributes with nullable: true
69
+ def self.openapi_nullable
70
+ Set.new([
71
+ ])
72
+ end
73
+
68
74
  # Initializes the object
69
75
  # @param [Hash] attributes Model attributes in the form of hash
70
76
  def initialize(attributes = {})
@@ -233,7 +239,11 @@ module VeloPayments
233
239
  hash = {}
234
240
  self.class.attribute_map.each_pair do |attr, param|
235
241
  value = self.send(attr)
236
- next if value.nil?
242
+ if value.nil?
243
+ is_nullable = self.class.openapi_nullable.include?(attr)
244
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
245
+ end
246
+
237
247
  hash[param] = _to_hash(value)
238
248
  end
239
249
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -65,6 +65,12 @@ module VeloPayments
65
65
  }
66
66
  end
67
67
 
68
+ # List of attributes with nullable: true
69
+ def self.openapi_nullable
70
+ Set.new([
71
+ ])
72
+ end
73
+
68
74
  # Initializes the object
69
75
  # @param [Hash] attributes Model attributes in the form of hash
70
76
  def initialize(attributes = {})
@@ -233,7 +239,11 @@ module VeloPayments
233
239
  hash = {}
234
240
  self.class.attribute_map.each_pair do |attr, param|
235
241
  value = self.send(attr)
236
- next if value.nil?
242
+ if value.nil?
243
+ is_nullable = self.class.openapi_nullable.include?(attr)
244
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
245
+ end
246
+
237
247
  hash[param] = _to_hash(value)
238
248
  end
239
249
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -94,6 +94,12 @@ module VeloPayments
94
94
  }
95
95
  end
96
96
 
97
+ # List of attributes with nullable: true
98
+ def self.openapi_nullable
99
+ Set.new([
100
+ ])
101
+ end
102
+
97
103
  # Initializes the object
98
104
  # @param [Hash] attributes Model attributes in the form of hash
99
105
  def initialize(attributes = {})
@@ -430,7 +436,11 @@ module VeloPayments
430
436
  hash = {}
431
437
  self.class.attribute_map.each_pair do |attr, param|
432
438
  value = self.send(attr)
433
- next if value.nil?
439
+ if value.nil?
440
+ is_nullable = self.class.openapi_nullable.include?(attr)
441
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
442
+ end
443
+
434
444
  hash[param] = _to_hash(value)
435
445
  end
436
446
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -30,6 +30,12 @@ module VeloPayments
30
30
  }
31
31
  end
32
32
 
33
+ # List of attributes with nullable: true
34
+ def self.openapi_nullable
35
+ Set.new([
36
+ ])
37
+ end
38
+
33
39
  # Initializes the object
34
40
  # @param [Hash] attributes Model attributes in the form of hash
35
41
  def initialize(attributes = {})
@@ -171,7 +177,11 @@ module VeloPayments
171
177
  hash = {}
172
178
  self.class.attribute_map.each_pair do |attr, param|
173
179
  value = self.send(attr)
174
- next if value.nil?
180
+ if value.nil?
181
+ is_nullable = self.class.openapi_nullable.include?(attr)
182
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
183
+ end
184
+
175
185
  hash[param] = _to_hash(value)
176
186
  end
177
187
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -34,6 +34,12 @@ module VeloPayments
34
34
  }
35
35
  end
36
36
 
37
+ # List of attributes with nullable: true
38
+ def self.openapi_nullable
39
+ Set.new([
40
+ ])
41
+ end
42
+
37
43
  # Initializes the object
38
44
  # @param [Hash] attributes Model attributes in the form of hash
39
45
  def initialize(attributes = {})
@@ -178,7 +184,11 @@ module VeloPayments
178
184
  hash = {}
179
185
  self.class.attribute_map.each_pair do |attr, param|
180
186
  value = self.send(attr)
181
- next if value.nil?
187
+ if value.nil?
188
+ is_nullable = self.class.openapi_nullable.include?(attr)
189
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
190
+ end
191
+
182
192
  hash[param] = _to_hash(value)
183
193
  end
184
194
  hash
@@ -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.19.116
6
+ The version of the OpenAPI document: 2.20.29
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -31,6 +31,12 @@ module VeloPayments
31
31
  }
32
32
  end
33
33
 
34
+ # List of attributes with nullable: true
35
+ def self.openapi_nullable
36
+ Set.new([
37
+ ])
38
+ end
39
+
34
40
  # Initializes the object
35
41
  # @param [Hash] attributes Model attributes in the form of hash
36
42
  def initialize(attributes = {})
@@ -196,7 +202,11 @@ module VeloPayments
196
202
  hash = {}
197
203
  self.class.attribute_map.each_pair do |attr, param|
198
204
  value = self.send(attr)
199
- next if value.nil?
205
+ if value.nil?
206
+ is_nullable = self.class.openapi_nullable.include?(attr)
207
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
208
+ end
209
+
200
210
  hash[param] = _to_hash(value)
201
211
  end
202
212
  hash