velopayments 2.11.73 → 2.14.90.pre.1

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 (360) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/Makefile +7 -1
  4. data/README.md +82 -26
  5. data/docs/Address.md +5 -5
  6. data/docs/AuthApi.md +65 -0
  7. data/docs/AuthResponse.md +25 -0
  8. data/docs/AutoTopUpConfig.md +21 -0
  9. data/docs/Company.md +3 -1
  10. data/docs/CreateIndividual.md +21 -0
  11. data/docs/CreatePayee.md +3 -25
  12. data/docs/CreatePayeeAddress.md +31 -0
  13. data/docs/CreatePayeesCSVRequest.md +17 -15
  14. data/docs/CreatePayoutRequest.md +1 -1
  15. data/docs/FundingManagerApi.md +180 -10
  16. data/docs/{FundingRequest.md → FundingRequestV1.md} +2 -2
  17. data/docs/{FundingRequest2.md → FundingRequestV2.md} +2 -2
  18. data/docs/FxSummaryV3.md +35 -0
  19. data/docs/{FxSummary.md → FxSummaryV4.md} +7 -7
  20. data/docs/GetFundingsResponseAllOf.md +17 -0
  21. data/docs/GetPaymentsForPayoutResponseV3.md +23 -0
  22. data/docs/GetPaymentsForPayoutResponseV3Page.md +25 -0
  23. data/docs/GetPaymentsForPayoutResponseV3Summary.md +33 -0
  24. data/docs/GetPaymentsForPayoutResponseV4.md +23 -0
  25. data/docs/GetPaymentsForPayoutResponseV4Summary.md +33 -0
  26. data/docs/GetPayoutsResponseV3.md +23 -0
  27. data/docs/GetPayoutsResponseV3Links.md +19 -0
  28. data/docs/GetPayoutsResponseV3Page.md +25 -0
  29. data/docs/GetPayoutsResponseV3Summary.md +25 -0
  30. data/docs/GetPayoutsResponseV4.md +23 -0
  31. data/docs/Individual.md +2 -2
  32. data/docs/{PaymentAuditCurrency.md → InvitationStatus.md} +2 -2
  33. data/docs/ListPaymentsResponse.md +4 -4
  34. data/docs/ListPaymentsResponsePage.md +25 -0
  35. data/docs/ListPaymentsResponseSummary.md +25 -0
  36. data/docs/ListSourceAccountResponse.md +2 -2
  37. data/docs/ListSourceAccountResponseLinks.md +19 -0
  38. data/docs/ListSourceAccountResponsePage.md +25 -0
  39. data/docs/ListSourceAccountResponseV2.md +21 -0
  40. data/docs/ListSourceAccountResponseV2Page.md +25 -0
  41. data/docs/Notifications.md +17 -0
  42. data/docs/PagedPayeeInvitationStatusResponse.md +21 -0
  43. data/docs/Payee.md +1 -3
  44. data/docs/PayeeDelta.md +29 -0
  45. data/docs/PayeeDeltaResponse.md +21 -0
  46. data/docs/PayeeDeltaResponseLinks.md +19 -0
  47. data/docs/PayeeDeltaResponsePage.md +25 -0
  48. data/docs/PayeeInvitationApi.md +68 -5
  49. data/docs/PayeeInvitationStatus.md +1 -1
  50. data/docs/PayeeInvitationStatusResponse.md +21 -0
  51. data/docs/PayeeResponse.md +3 -3
  52. data/docs/{GetPaymentsForPayoutResponseLinks.md → PayeeResponseLinks.md} +2 -2
  53. data/docs/{GetPaymentsForPayoutResponsePage.md → PayeeResponsePage.md} +2 -2
  54. data/docs/{GetPaymentsForPayoutResponseSummary.md → PayeeResponseSummary.md} +2 -2
  55. data/docs/PayeesApi.md +61 -0
  56. data/docs/PaymentAuditCurrencyV3.md +16 -0
  57. data/docs/PaymentAuditCurrencyV4.md +16 -0
  58. data/docs/PaymentAuditServiceApi.md +302 -6
  59. data/docs/PaymentEventResponseV3.md +39 -0
  60. data/docs/{PaymentEventResponse.md → PaymentEventResponseV4.md} +8 -8
  61. data/docs/PaymentInstruction.md +6 -6
  62. data/docs/PaymentResponseV3.md +81 -0
  63. data/docs/{PaymentResponse.md → PaymentResponseV4.md} +5 -5
  64. data/docs/PayorApplicationsApi.md +1 -1
  65. data/docs/PayorBrandingResponse.md +5 -5
  66. data/docs/PayorCreateApiKeyRequest.md +3 -3
  67. data/docs/PayorCreateApiKeyResponse.md +2 -2
  68. data/docs/PayorCreateApplicationRequest.md +2 -2
  69. data/docs/PayorEmailOptOutRequest.md +1 -1
  70. data/docs/PayorFundingBankDetailsUpdate.md +3 -3
  71. data/docs/PayorLinksResponse.md +19 -0
  72. data/docs/PayorLinksResponseLinks.md +23 -0
  73. data/docs/PayorLinksResponsePayors.md +23 -0
  74. data/docs/PayorRef.md +2 -2
  75. data/docs/{Payor.md → PayorV1.md} +15 -15
  76. data/docs/PayorV2.md +49 -0
  77. data/docs/PayorsApi.md +116 -6
  78. data/docs/PayoutHistoryApi.md +81 -2
  79. data/docs/{PayoutStatus.md → PayoutStatusV3.md} +2 -2
  80. data/docs/PayoutStatusV4.md +16 -0
  81. data/docs/PayoutSummaryAuditV3.md +41 -0
  82. data/docs/{PayoutSummaryAudit.md → PayoutSummaryAuditV4.md} +9 -7
  83. data/docs/PayoutSummaryResponse.md +4 -4
  84. data/docs/QuoteFxSummary.md +10 -10
  85. data/docs/RejectedPayment.md +10 -8
  86. data/docs/SetNotificationsRequest.md +17 -0
  87. data/docs/SourceAccount.md +3 -3
  88. data/docs/SourceAccountResponse.md +11 -9
  89. data/docs/SourceAccountResponseV2.md +45 -0
  90. data/docs/SourceAccountSummaryV3.md +21 -0
  91. data/docs/SourceAccountSummaryV4.md +21 -0
  92. data/docs/SubmitPayoutApi.md +2 -2
  93. data/docs/SupportedCountry.md +2 -2
  94. data/lib/velopayments.rb +58 -18
  95. data/lib/velopayments/api/auth_api.rb +88 -0
  96. data/lib/velopayments/api/countries_api.rb +35 -17
  97. data/lib/velopayments/api/currencies_api.rb +19 -10
  98. data/lib/velopayments/api/funding_manager_api.rb +323 -69
  99. data/lib/velopayments/api/get_payout_api.rb +20 -11
  100. data/lib/velopayments/api/instruct_payout_api.rb +21 -11
  101. data/lib/velopayments/api/payee_invitation_api.rb +150 -40
  102. data/lib/velopayments/api/payees_api.rb +130 -26
  103. data/lib/velopayments/api/payment_audit_service_api.rb +481 -55
  104. data/lib/velopayments/api/payor_applications_api.rb +40 -21
  105. data/lib/velopayments/api/payors_api.rb +209 -43
  106. data/lib/velopayments/api/payout_history_api.rb +141 -21
  107. data/lib/velopayments/api/quote_payout_api.rb +20 -11
  108. data/lib/velopayments/api/submit_payout_api.rb +22 -12
  109. data/lib/velopayments/api/withdraw_payout_api.rb +21 -11
  110. data/lib/velopayments/api_client.rb +3 -4
  111. data/lib/velopayments/api_error.rb +2 -2
  112. data/lib/velopayments/configuration.rb +7 -6
  113. data/lib/velopayments/models/address.rb +2 -2
  114. data/lib/velopayments/models/auth_response.rb +242 -0
  115. data/lib/velopayments/models/auto_top_up_config.rb +222 -0
  116. data/lib/velopayments/models/challenge.rb +2 -2
  117. data/lib/velopayments/models/company.rb +39 -6
  118. data/lib/velopayments/models/create_individual.rb +249 -0
  119. data/lib/velopayments/models/create_payee.rb +7 -109
  120. data/lib/velopayments/models/create_payee_address.rb +478 -0
  121. data/lib/velopayments/models/create_payees_csv_request.rb +268 -183
  122. data/lib/velopayments/models/create_payees_csv_response.rb +2 -2
  123. data/lib/velopayments/models/create_payees_request.rb +2 -2
  124. data/lib/velopayments/models/create_payment_channel.rb +9 -15
  125. data/lib/velopayments/models/create_payout_request.rb +2 -2
  126. data/lib/velopayments/models/failed_submission.rb +2 -2
  127. data/lib/velopayments/models/funding_audit.rb +2 -2
  128. data/lib/velopayments/models/funding_event.rb +2 -2
  129. data/lib/velopayments/models/funding_event_type.rb +2 -2
  130. data/lib/velopayments/models/{funding_request.rb → funding_request_v1.rb} +5 -5
  131. data/lib/velopayments/models/{funding_request2.rb → funding_request_v2.rb} +5 -5
  132. data/lib/velopayments/models/{fx_summary.rb → fx_summary_v3.rb} +7 -7
  133. data/lib/velopayments/models/fx_summary_v4.rb +363 -0
  134. data/lib/velopayments/models/get_fundings_response.rb +3 -2
  135. data/lib/velopayments/models/get_fundings_response_all_of.rb +196 -0
  136. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +228 -0
  137. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +232 -0
  138. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +311 -0
  139. data/lib/velopayments/models/{get_payments_for_payout_response.rb → get_payments_for_payout_response_v4.rb} +9 -9
  140. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +311 -0
  141. data/lib/velopayments/models/get_payout_statistics.rb +2 -2
  142. data/lib/velopayments/models/{get_payouts_response.rb → get_payouts_response_v3.rb} +9 -9
  143. data/lib/velopayments/models/{get_payments_for_payout_response_links.rb → get_payouts_response_v3_links.rb} +5 -5
  144. data/lib/velopayments/models/{get_payments_for_payout_response_page.rb → get_payouts_response_v3_page.rb} +5 -5
  145. data/lib/velopayments/models/{get_payments_for_payout_response_summary.rb → get_payouts_response_v3_summary.rb} +5 -5
  146. data/lib/velopayments/models/get_payouts_response_v4.rb +228 -0
  147. data/lib/velopayments/models/individual.rb +6 -4
  148. data/lib/velopayments/models/individual_name.rb +2 -2
  149. data/lib/velopayments/models/invitation_status.rb +37 -0
  150. data/lib/velopayments/models/invitation_status_response.rb +2 -2
  151. data/lib/velopayments/models/invite_payee_request.rb +2 -2
  152. data/lib/velopayments/models/language.rb +2 -2
  153. data/lib/velopayments/models/list_payments_response.rb +6 -6
  154. data/lib/velopayments/models/list_payments_response_page.rb +232 -0
  155. data/lib/velopayments/models/list_payments_response_summary.rb +232 -0
  156. data/lib/velopayments/models/list_source_account_response.rb +4 -4
  157. data/lib/velopayments/models/{social.rb → list_source_account_response_links.rb} +18 -27
  158. data/lib/velopayments/models/list_source_account_response_page.rb +232 -0
  159. data/lib/velopayments/models/list_source_account_response_v2.rb +219 -0
  160. data/lib/velopayments/models/list_source_account_response_v2_page.rb +232 -0
  161. data/lib/velopayments/models/marketing_opt_in.rb +2 -2
  162. data/lib/velopayments/models/notifications.rb +196 -0
  163. data/lib/velopayments/models/ofac_status.rb +2 -2
  164. data/lib/velopayments/models/onboarded_status.rb +2 -2
  165. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +219 -0
  166. data/lib/velopayments/models/paged_response.rb +2 -2
  167. data/lib/velopayments/models/paged_response_page.rb +2 -2
  168. data/lib/velopayments/models/payee.rb +6 -15
  169. data/lib/velopayments/models/payee_delta.rb +288 -0
  170. data/lib/velopayments/models/payee_delta_response.rb +219 -0
  171. data/lib/velopayments/models/payee_delta_response_links.rb +205 -0
  172. data/lib/velopayments/models/payee_delta_response_page.rb +232 -0
  173. data/lib/velopayments/models/payee_invitation_status.rb +2 -2
  174. data/lib/velopayments/models/payee_invitation_status_response.rb +224 -0
  175. data/lib/velopayments/models/payee_response.rb +5 -5
  176. data/lib/velopayments/models/payee_response_links.rb +205 -0
  177. data/lib/velopayments/models/payee_response_page.rb +232 -0
  178. data/lib/velopayments/models/payee_response_summary.rb +232 -0
  179. data/lib/velopayments/models/payee_type.rb +2 -2
  180. data/lib/velopayments/models/{payment_audit_currency.rb → payment_audit_currency_v3.rb} +5 -5
  181. data/lib/velopayments/models/payment_audit_currency_v4.rb +37 -0
  182. data/lib/velopayments/models/payment_channel.rb +2 -2
  183. data/lib/velopayments/models/payment_channel_country.rb +2 -2
  184. data/lib/velopayments/models/payment_channel_rule.rb +2 -2
  185. data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
  186. data/lib/velopayments/models/{payment_event_response.rb → payment_event_response_v3.rb} +9 -9
  187. data/lib/velopayments/models/payment_event_response_v4.rb +351 -0
  188. data/lib/velopayments/models/payment_instruction.rb +2 -2
  189. data/lib/velopayments/models/{payment_response.rb → payment_response_v3.rb} +8 -8
  190. data/lib/velopayments/models/payment_response_v4.rb +587 -0
  191. data/lib/velopayments/models/payor_branding_response.rb +2 -2
  192. data/lib/velopayments/models/payor_create_api_key_request.rb +2 -2
  193. data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
  194. data/lib/velopayments/models/payor_create_application_request.rb +2 -2
  195. data/lib/velopayments/models/payor_email_opt_out_request.rb +7 -2
  196. data/lib/velopayments/models/payor_funding_bank_details_update.rb +2 -2
  197. data/lib/velopayments/models/payor_links_response.rb +210 -0
  198. data/lib/velopayments/models/payor_links_response_links.rb +277 -0
  199. data/lib/velopayments/models/payor_links_response_payors.rb +267 -0
  200. data/lib/velopayments/models/payor_logo_request.rb +2 -2
  201. data/lib/velopayments/models/payor_ref.rb +2 -2
  202. data/lib/velopayments/models/{payor.rb → payor_v1.rb} +6 -6
  203. data/lib/velopayments/models/payor_v2.rb +405 -0
  204. data/lib/velopayments/models/{payout_status.rb → payout_status_v3.rb} +5 -5
  205. data/lib/velopayments/models/payout_status_v4.rb +43 -0
  206. data/lib/velopayments/models/{payout_summary_audit.rb → payout_summary_audit_v3.rb} +18 -9
  207. data/lib/velopayments/models/payout_summary_audit_v4.rb +323 -0
  208. data/lib/velopayments/models/payout_summary_response.rb +2 -2
  209. data/lib/velopayments/models/query_batch_response.rb +2 -2
  210. data/lib/velopayments/models/quote_fx_summary.rb +4 -4
  211. data/lib/velopayments/models/quote_response.rb +2 -2
  212. data/lib/velopayments/models/rejected_payment.rb +37 -34
  213. data/lib/velopayments/models/set_notifications_request.rb +230 -0
  214. data/lib/velopayments/models/source_account.rb +2 -2
  215. data/lib/velopayments/models/source_account_response.rb +16 -7
  216. data/lib/velopayments/models/source_account_response_v2.rb +403 -0
  217. data/lib/velopayments/models/{source_account_summary.rb → source_account_summary_v3.rb} +7 -7
  218. data/lib/velopayments/models/source_account_summary_v4.rb +224 -0
  219. data/lib/velopayments/models/supported_countries_response.rb +2 -2
  220. data/lib/velopayments/models/supported_country.rb +36 -2
  221. data/lib/velopayments/models/supported_currency.rb +2 -2
  222. data/lib/velopayments/models/supported_currency_response.rb +2 -2
  223. data/lib/velopayments/version.rb +3 -3
  224. data/oa3-config.json +1 -1
  225. data/spec/api/auth_api_spec.rb +48 -0
  226. data/spec/api/countries_api_spec.rb +2 -2
  227. data/spec/api/currencies_api_spec.rb +2 -2
  228. data/spec/api/funding_manager_api_spec.rb +45 -4
  229. data/spec/api/get_payout_api_spec.rb +2 -2
  230. data/spec/api/instruct_payout_api_spec.rb +2 -2
  231. data/spec/api/payee_invitation_api_spec.rb +20 -4
  232. data/spec/api/payees_api_spec.rb +17 -2
  233. data/spec/api/payment_audit_service_api_spec.rb +91 -5
  234. data/spec/api/payor_applications_api_spec.rb +3 -3
  235. data/spec/api/payors_api_spec.rb +31 -6
  236. data/spec/api/payout_history_api_spec.rb +27 -3
  237. data/spec/api/quote_payout_api_spec.rb +2 -2
  238. data/spec/api/submit_payout_api_spec.rb +3 -3
  239. data/spec/api/withdraw_payout_api_spec.rb +2 -2
  240. data/spec/api_client_spec.rb +2 -2
  241. data/spec/configuration_spec.rb +2 -2
  242. data/spec/models/address_spec.rb +2 -2
  243. data/spec/models/auth_response_spec.rb +65 -0
  244. data/spec/models/{social_spec.rb → auto_top_up_config_spec.rb} +11 -11
  245. data/spec/models/challenge_spec.rb +2 -2
  246. data/spec/models/company_spec.rb +8 -2
  247. data/spec/models/create_individual_spec.rb +53 -0
  248. data/spec/models/create_payee_address_spec.rb +83 -0
  249. data/spec/models/create_payee_spec.rb +2 -68
  250. data/spec/models/create_payees_csv_request_spec.rb +26 -16
  251. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  252. data/spec/models/create_payees_request_spec.rb +2 -2
  253. data/spec/models/create_payment_channel_spec.rb +6 -2
  254. data/spec/models/create_payout_request_spec.rb +2 -2
  255. data/spec/models/failed_submission_spec.rb +2 -2
  256. data/spec/models/funding_audit_spec.rb +2 -2
  257. data/spec/models/funding_event_spec.rb +2 -2
  258. data/spec/models/funding_event_type_spec.rb +2 -2
  259. data/spec/models/{funding_request2_spec.rb → funding_request_v1_spec.rb} +8 -8
  260. data/spec/models/{funding_request_spec.rb → funding_request_v2_spec.rb} +8 -8
  261. data/spec/models/{fx_summary_spec.rb → fx_summary_v3_spec.rb} +8 -8
  262. data/spec/models/fx_summary_v4_spec.rb +103 -0
  263. data/spec/models/get_fundings_response_all_of_spec.rb +41 -0
  264. data/spec/models/get_fundings_response_spec.rb +2 -2
  265. data/spec/models/{get_payments_for_payout_response_page_spec.rb → get_payments_for_payout_response_v3_page_spec.rb} +8 -8
  266. data/spec/models/{get_payments_for_payout_response_spec.rb → get_payments_for_payout_response_v3_spec.rb} +8 -8
  267. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +93 -0
  268. data/spec/models/get_payments_for_payout_response_v4_spec.rb +59 -0
  269. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +93 -0
  270. data/spec/models/get_payout_statistics_spec.rb +2 -2
  271. data/spec/models/get_payouts_response_v3_links_spec.rb +47 -0
  272. data/spec/models/get_payouts_response_v3_page_spec.rb +65 -0
  273. data/spec/models/{get_payouts_response_spec.rb → get_payouts_response_v3_spec.rb} +8 -8
  274. data/spec/models/{get_payments_for_payout_response_summary_spec.rb → get_payouts_response_v3_summary_spec.rb} +8 -8
  275. data/spec/models/get_payouts_response_v4_spec.rb +59 -0
  276. data/spec/models/individual_name_spec.rb +2 -2
  277. data/spec/models/individual_spec.rb +2 -2
  278. data/spec/models/invitation_status_response_spec.rb +2 -2
  279. data/spec/models/invitation_status_spec.rb +35 -0
  280. data/spec/models/invite_payee_request_spec.rb +2 -2
  281. data/spec/models/language_spec.rb +2 -2
  282. data/spec/models/list_payments_response_page_spec.rb +65 -0
  283. data/spec/models/list_payments_response_spec.rb +2 -2
  284. data/spec/models/list_payments_response_summary_spec.rb +65 -0
  285. data/spec/models/{get_payments_for_payout_response_links_spec.rb → list_source_account_response_links_spec.rb} +8 -8
  286. data/spec/models/list_source_account_response_page_spec.rb +65 -0
  287. data/spec/models/list_source_account_response_spec.rb +2 -2
  288. data/spec/models/list_source_account_response_v2_page_spec.rb +65 -0
  289. data/spec/models/list_source_account_response_v2_spec.rb +53 -0
  290. data/spec/models/marketing_opt_in_spec.rb +2 -2
  291. data/spec/models/notifications_spec.rb +41 -0
  292. data/spec/models/ofac_status_spec.rb +2 -2
  293. data/spec/models/onboarded_status_spec.rb +2 -2
  294. data/spec/models/paged_payee_invitation_status_response_spec.rb +53 -0
  295. data/spec/models/paged_response_page_spec.rb +2 -2
  296. data/spec/models/paged_response_spec.rb +2 -2
  297. data/spec/models/payee_delta_response_links_spec.rb +47 -0
  298. data/spec/models/payee_delta_response_page_spec.rb +65 -0
  299. data/spec/models/payee_delta_response_spec.rb +53 -0
  300. data/spec/models/payee_delta_spec.rb +77 -0
  301. data/spec/models/payee_invitation_status_response_spec.rb +53 -0
  302. data/spec/models/payee_invitation_status_spec.rb +2 -2
  303. data/spec/models/payee_response_links_spec.rb +47 -0
  304. data/spec/models/payee_response_page_spec.rb +65 -0
  305. data/spec/models/payee_response_spec.rb +2 -2
  306. data/spec/models/payee_response_summary_spec.rb +65 -0
  307. data/spec/models/payee_spec.rb +2 -8
  308. data/spec/models/payee_type_spec.rb +2 -2
  309. data/spec/models/{payment_audit_currency_spec.rb → payment_audit_currency_v3_spec.rb} +8 -8
  310. data/spec/models/payment_audit_currency_v4_spec.rb +35 -0
  311. data/spec/models/payment_channel_country_spec.rb +2 -2
  312. data/spec/models/payment_channel_rule_spec.rb +2 -2
  313. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  314. data/spec/models/payment_channel_spec.rb +2 -2
  315. data/spec/models/{payment_event_response_spec.rb → payment_event_response_v3_spec.rb} +8 -8
  316. data/spec/models/payment_event_response_v4_spec.rb +111 -0
  317. data/spec/models/payment_instruction_spec.rb +2 -2
  318. data/spec/models/{payment_response_spec.rb → payment_response_v3_spec.rb} +8 -8
  319. data/spec/models/payment_response_v4_spec.rb +241 -0
  320. data/spec/models/payor_branding_response_spec.rb +2 -2
  321. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  322. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  323. data/spec/models/payor_create_application_request_spec.rb +2 -2
  324. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  325. data/spec/models/payor_funding_bank_details_update_spec.rb +2 -2
  326. data/spec/models/payor_links_response_links_spec.rb +63 -0
  327. data/spec/models/payor_links_response_payors_spec.rb +63 -0
  328. data/spec/models/payor_links_response_spec.rb +47 -0
  329. data/spec/models/payor_logo_request_spec.rb +2 -2
  330. data/spec/models/payor_ref_spec.rb +2 -2
  331. data/spec/models/{payor_spec.rb → payor_v1_spec.rb} +8 -8
  332. data/spec/models/payor_v2_spec.rb +145 -0
  333. data/spec/models/{payout_status_spec.rb → payout_status_v3_spec.rb} +8 -8
  334. data/spec/models/payout_status_v4_spec.rb +35 -0
  335. data/spec/models/{payout_summary_audit_spec.rb → payout_summary_audit_v3_spec.rb} +14 -8
  336. data/spec/models/payout_summary_audit_v4_spec.rb +113 -0
  337. data/spec/models/payout_summary_response_spec.rb +2 -2
  338. data/spec/models/query_batch_response_spec.rb +2 -2
  339. data/spec/models/quote_fx_summary_spec.rb +2 -2
  340. data/spec/models/quote_response_spec.rb +2 -2
  341. data/spec/models/rejected_payment_spec.rb +8 -6
  342. data/spec/models/set_notifications_request_spec.rb +41 -0
  343. data/spec/models/source_account_response_spec.rb +8 -2
  344. data/spec/models/source_account_response_v2_spec.rb +129 -0
  345. data/spec/models/source_account_spec.rb +2 -2
  346. data/spec/models/{source_account_summary_spec.rb → source_account_summary_v3_spec.rb} +8 -8
  347. data/spec/models/source_account_summary_v4_spec.rb +53 -0
  348. data/spec/models/supported_countries_response_spec.rb +2 -2
  349. data/spec/models/supported_country_spec.rb +10 -2
  350. data/spec/models/supported_currency_response_spec.rb +2 -2
  351. data/spec/models/supported_currency_spec.rb +2 -2
  352. data/spec/spec_helper.rb +2 -2
  353. data/velopayments-2.11.73.gem +0 -0
  354. data/velopayments-2.14.90.gem +0 -0
  355. data/velopayments.gemspec +2 -2
  356. metadata +230 -68
  357. data/docs/GetPaymentsForPayoutResponse.md +0 -23
  358. data/docs/GetPayoutsResponse.md +0 -23
  359. data/docs/Social.md +0 -21
  360. data/docs/SourceAccountSummary.md +0 -21
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -62,18 +62,6 @@ describe 'CreatePayee' do
62
62
  end
63
63
  end
64
64
 
65
- describe 'test attribute "display_name"' do
66
- it 'should work' do
67
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
- end
69
- end
70
-
71
- describe 'test attribute "country"' do
72
- it 'should work' do
73
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
- end
75
- end
76
-
77
65
  describe 'test attribute "address"' do
78
66
  it 'should work' do
79
67
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -98,18 +86,6 @@ describe 'CreatePayee' do
98
86
  end
99
87
  end
100
88
 
101
- describe 'test attribute "accept_terms_and_conditions_timestamp"' do
102
- it 'should work' do
103
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
- end
105
- end
106
-
107
- describe 'test attribute "cellphone_number"' do
108
- it 'should work' do
109
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
- end
111
- end
112
-
113
89
  describe 'test attribute "company"' do
114
90
  it 'should work' do
115
91
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -122,46 +98,4 @@ describe 'CreatePayee' do
122
98
  end
123
99
  end
124
100
 
125
- describe 'test attribute "created"' do
126
- it 'should work' do
127
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
- end
129
- end
130
-
131
- describe 'test attribute "grace_period_end_date"' do
132
- it 'should work' do
133
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
- end
135
- end
136
-
137
- describe 'test attribute "last_ofac_check_timestamp"' do
138
- it 'should work' do
139
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
- end
141
- end
142
-
143
- describe 'test attribute "marketing_opt_ins"' do
144
- it 'should work' do
145
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
146
- end
147
- end
148
-
149
- describe 'test attribute "ofac_status"' do
150
- it 'should work' do
151
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
- end
153
- end
154
-
155
- describe 'test attribute "onboarded_status"' do
156
- it 'should work' do
157
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
158
- end
159
- end
160
-
161
- describe 'test attribute "social"' do
162
- it 'should work' do
163
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
164
- end
165
- end
166
-
167
101
  end
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -98,6 +98,18 @@ describe 'CreatePayeesCSVRequest' do
98
98
  end
99
99
  end
100
100
 
101
+ describe 'test attribute "individual_national_identification"' do
102
+ it 'should work' do
103
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
+ end
105
+ end
106
+
107
+ describe 'test attribute "individual_date_of_birth"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
101
113
  describe 'test attribute "individual_title"' do
102
114
  it 'should work' do
103
115
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -122,43 +134,43 @@ describe 'CreatePayeesCSVRequest' do
122
134
  end
123
135
  end
124
136
 
125
- describe 'test attribute "individual_national_identification"' do
137
+ describe 'test attribute "company_name"' do
126
138
  it 'should work' do
127
139
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
140
  end
129
141
  end
130
142
 
131
- describe 'test attribute "individual_date_of_birth"' do
143
+ describe 'test attribute "company_ein"' do
132
144
  it 'should work' do
133
145
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
146
  end
135
147
  end
136
148
 
137
- describe 'test attribute "company_name"' do
149
+ describe 'test attribute "company_operating_name"' do
138
150
  it 'should work' do
139
151
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
152
  end
141
153
  end
142
154
 
143
- describe 'test attribute "company_tax_id"' do
155
+ describe 'test attribute "payment_channel_account_number"' do
144
156
  it 'should work' do
145
157
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
146
158
  end
147
159
  end
148
160
 
149
- describe 'test attribute "payment_channel_iban"' do
161
+ describe 'test attribute "payment_channel_routing_number"' do
150
162
  it 'should work' do
151
163
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
164
  end
153
165
  end
154
166
 
155
- describe 'test attribute "payment_channel_account_number"' do
167
+ describe 'test attribute "payment_channel_account_name"' do
156
168
  it 'should work' do
157
169
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
158
170
  end
159
171
  end
160
172
 
161
- describe 'test attribute "payment_channel_routing_no"' do
173
+ describe 'test attribute "payment_channel_iban"' do
162
174
  it 'should work' do
163
175
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
164
176
  end
@@ -167,6 +179,10 @@ describe 'CreatePayeesCSVRequest' do
167
179
  describe 'test attribute "payment_channel_country_code"' do
168
180
  it 'should work' do
169
181
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
182
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "false", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"])
183
+ # validator.allowable_values.each do |value|
184
+ # expect { @instance.payment_channel_country_code = value }.not_to raise_error
185
+ # end
170
186
  end
171
187
  end
172
188
 
@@ -180,7 +196,7 @@ describe 'CreatePayeesCSVRequest' do
180
196
  end
181
197
  end
182
198
 
183
- describe 'test attribute "payment_channel_account_name"' do
199
+ describe 'test attribute "challenge_description"' do
184
200
  it 'should work' do
185
201
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
186
202
  end
@@ -192,12 +208,6 @@ describe 'CreatePayeesCSVRequest' do
192
208
  end
193
209
  end
194
210
 
195
- describe 'test attribute "challenge_description"' do
196
- it 'should work' do
197
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
198
- end
199
- end
200
-
201
211
  describe 'test attribute "payee_language"' do
202
212
  it 'should work' do
203
213
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -59,6 +59,10 @@ describe 'CreatePaymentChannel' do
59
59
  describe 'test attribute "country_code"' do
60
60
  it 'should work' do
61
61
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "false", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"])
63
+ # validator.allowable_values.each do |value|
64
+ # expect { @instance.country_code = value }.not_to raise_error
65
+ # end
62
66
  end
63
67
  end
64
68
 
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,22 +14,22 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for VeloPayments::FundingRequest2
17
+ # Unit tests for VeloPayments::FundingRequestV1
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe 'FundingRequest2' do
20
+ describe 'FundingRequestV1' do
21
21
  before do
22
22
  # run before each test
23
- @instance = VeloPayments::FundingRequest2.new
23
+ @instance = VeloPayments::FundingRequestV1.new
24
24
  end
25
25
 
26
26
  after do
27
27
  # run after each test
28
28
  end
29
29
 
30
- describe 'test an instance of FundingRequest2' do
31
- it 'should create an instance of FundingRequest2' do
32
- expect(@instance).to be_instance_of(VeloPayments::FundingRequest2)
30
+ describe 'test an instance of FundingRequestV1' do
31
+ it 'should create an instance of FundingRequestV1' do
32
+ expect(@instance).to be_instance_of(VeloPayments::FundingRequestV1)
33
33
  end
34
34
  end
35
35
  describe 'test attribute "amount"' do
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,22 +14,22 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for VeloPayments::FundingRequest
17
+ # Unit tests for VeloPayments::FundingRequestV2
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe 'FundingRequest' do
20
+ describe 'FundingRequestV2' do
21
21
  before do
22
22
  # run before each test
23
- @instance = VeloPayments::FundingRequest.new
23
+ @instance = VeloPayments::FundingRequestV2.new
24
24
  end
25
25
 
26
26
  after do
27
27
  # run after each test
28
28
  end
29
29
 
30
- describe 'test an instance of FundingRequest' do
31
- it 'should create an instance of FundingRequest' do
32
- expect(@instance).to be_instance_of(VeloPayments::FundingRequest)
30
+ describe 'test an instance of FundingRequestV2' do
31
+ it 'should create an instance of FundingRequestV2' do
32
+ expect(@instance).to be_instance_of(VeloPayments::FundingRequestV2)
33
33
  end
34
34
  end
35
35
  describe 'test attribute "amount"' do
@@ -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
- OpenAPI spec version: 2.11.73
6
+ The version of the OpenAPI document: 2.14.92
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,22 +14,22 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for VeloPayments::FxSummary
17
+ # Unit tests for VeloPayments::FxSummaryV3
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe 'FxSummary' do
20
+ describe 'FxSummaryV3' do
21
21
  before do
22
22
  # run before each test
23
- @instance = VeloPayments::FxSummary.new
23
+ @instance = VeloPayments::FxSummaryV3.new
24
24
  end
25
25
 
26
26
  after do
27
27
  # run after each test
28
28
  end
29
29
 
30
- describe 'test an instance of FxSummary' do
31
- it 'should create an instance of FxSummary' do
32
- expect(@instance).to be_instance_of(VeloPayments::FxSummary)
30
+ describe 'test an instance of FxSummaryV3' do
31
+ it 'should create an instance of FxSummaryV3' do
32
+ expect(@instance).to be_instance_of(VeloPayments::FxSummaryV3)
33
33
  end
34
34
  end
35
35
  describe 'test attribute "quote_id"' do