velopayments 2.19.40.beta1 → 2.19.116

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