velopayments 2.26.124.beta1 → 2.29.128.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (612) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +26 -20
  3. data/README.md +19 -5
  4. data/docs/Challenge2.md +2 -2
  5. data/docs/CreatePayee.md +1 -1
  6. data/docs/CreatePayee2.md +1 -1
  7. data/docs/CreatePayeesCSVRequest.md +74 -0
  8. data/docs/CreatePayeesCSVRequest2.md +74 -0
  9. data/docs/FailedPayee.md +1 -1
  10. data/docs/FailedPayee2.md +1 -1
  11. data/docs/FundingManagerApi.md +44 -44
  12. data/docs/FundingManagerPrivateApi.md +2 -2
  13. data/docs/GetPayeeListResponse.md +1 -1
  14. data/docs/GetPayeeListResponse2.md +1 -1
  15. data/docs/GetPaymentsForPayoutResponseV4Summary.md +3 -1
  16. data/docs/InstructPayoutRequest.md +18 -0
  17. data/docs/InviteUserRequest.md +5 -3
  18. data/docs/PayeeDetailResponse.md +1 -1
  19. data/docs/PayeeDetailResponse2.md +1 -1
  20. data/docs/PayeeInvitationApi.md +18 -18
  21. data/docs/PayeeType2.md +15 -0
  22. data/docs/PayeesApi.md +33 -33
  23. data/docs/PaymentAuditServiceApi.md +32 -20
  24. data/docs/PaymentAuditServiceDeprecatedApi.md +18 -18
  25. data/docs/PaymentResponseV4.md +4 -0
  26. data/docs/PaymentV3.md +3 -1
  27. data/docs/PayorCreateApiKeyRequest.md +1 -1
  28. data/docs/PayorLogoRequest.md +18 -0
  29. data/docs/PayorV2.md +4 -0
  30. data/docs/PayorsApi.md +21 -21
  31. data/docs/PayoutSchedule.md +28 -0
  32. data/docs/PayoutSchedule2.md +26 -0
  33. data/docs/PayoutServiceApi.md +164 -18
  34. data/docs/PayoutSummaryAudit.md +3 -1
  35. data/docs/PayoutSummaryResponseV3.md +3 -1
  36. data/docs/PingResponse.md +20 -0
  37. data/docs/SchedulePayoutRequest.md +20 -0
  38. data/docs/ScheduleStatus.md +15 -0
  39. data/docs/ScheduleStatus2.md +15 -0
  40. data/docs/TokensApi.md +2 -2
  41. data/docs/UpdatePayeeDetailsRequest.md +1 -1
  42. data/docs/UpdatePayeeDetailsRequest2.md +4 -2
  43. data/docs/UserResponse.md +4 -0
  44. data/docs/UsersApi.md +24 -22
  45. data/docs/WebhooksApi.md +74 -6
  46. data/lib/velopayments/api/countries_api.rb +2 -2
  47. data/lib/velopayments/api/currencies_api.rb +2 -2
  48. data/lib/velopayments/api/funding_manager_api.rb +26 -8
  49. data/lib/velopayments/api/funding_manager_private_api.rb +6 -3
  50. data/lib/velopayments/api/login_api.rb +10 -4
  51. data/lib/velopayments/api/payee_invitation_api.rb +18 -6
  52. data/lib/velopayments/api/payees_api.rb +24 -12
  53. data/lib/velopayments/api/payment_audit_service_api.rb +30 -4
  54. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +2 -2
  55. data/lib/velopayments/api/payors_api.rb +18 -6
  56. data/lib/velopayments/api/payors_private_api.rb +6 -3
  57. data/lib/velopayments/api/payout_service_api.rb +153 -7
  58. data/lib/velopayments/api/tokens_api.rb +6 -3
  59. data/lib/velopayments/api/users_api.rb +45 -12
  60. data/lib/velopayments/api/webhooks_api.rb +69 -4
  61. data/lib/velopayments/api_client.rb +5 -5
  62. data/lib/velopayments/api_error.rb +2 -2
  63. data/lib/velopayments/configuration.rb +4 -3
  64. data/lib/velopayments/models/accepted_payment_v3.rb +2 -2
  65. data/lib/velopayments/models/access_token_response.rb +2 -2
  66. data/lib/velopayments/models/access_token_validation_request.rb +2 -2
  67. data/lib/velopayments/models/auth_response.rb +2 -2
  68. data/lib/velopayments/models/auto_top_up_config.rb +2 -2
  69. data/lib/velopayments/models/auto_top_up_config2.rb +2 -2
  70. data/lib/velopayments/models/category.rb +2 -2
  71. data/lib/velopayments/models/challenge.rb +2 -2
  72. data/lib/velopayments/models/challenge2.rb +4 -2
  73. data/lib/velopayments/models/company.rb +2 -2
  74. data/lib/velopayments/models/company2.rb +2 -2
  75. data/lib/velopayments/models/create_funding_account_request_v2.rb +2 -2
  76. data/lib/velopayments/models/create_individual.rb +2 -2
  77. data/lib/velopayments/models/create_individual2.rb +2 -2
  78. data/lib/velopayments/models/create_individual_name.rb +2 -2
  79. data/lib/velopayments/models/create_payee.rb +3 -3
  80. data/lib/velopayments/models/create_payee2.rb +3 -3
  81. data/lib/velopayments/models/create_payee_address.rb +2 -2
  82. data/lib/velopayments/models/create_payee_address2.rb +2 -2
  83. data/lib/velopayments/models/create_payees_csv_request.rb +1149 -0
  84. data/lib/velopayments/models/create_payees_csv_request2.rb +1149 -0
  85. data/lib/velopayments/models/create_payees_csv_response.rb +2 -2
  86. data/lib/velopayments/models/create_payees_csv_response2.rb +2 -2
  87. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +2 -2
  88. data/lib/velopayments/models/create_payees_request.rb +2 -2
  89. data/lib/velopayments/models/create_payees_request2.rb +2 -2
  90. data/lib/velopayments/models/create_payment_channel.rb +2 -2
  91. data/lib/velopayments/models/create_payment_channel2.rb +2 -2
  92. data/lib/velopayments/models/create_payor_link_request.rb +2 -2
  93. data/lib/velopayments/models/create_payout_request_v3.rb +2 -2
  94. data/lib/velopayments/models/create_webhook_request.rb +2 -2
  95. data/lib/velopayments/models/debit_event.rb +2 -2
  96. data/lib/velopayments/models/debit_event_all_of.rb +2 -2
  97. data/lib/velopayments/models/debit_status_changed.rb +2 -2
  98. data/lib/velopayments/models/debit_status_changed_all_of.rb +2 -2
  99. data/lib/velopayments/models/error.rb +2 -2
  100. data/lib/velopayments/models/error_data.rb +2 -2
  101. data/lib/velopayments/models/error_response.rb +2 -2
  102. data/lib/velopayments/models/failed_payee.rb +3 -3
  103. data/lib/velopayments/models/failed_payee2.rb +3 -3
  104. data/lib/velopayments/models/failed_submission.rb +2 -2
  105. data/lib/velopayments/models/failed_submission2.rb +2 -2
  106. data/lib/velopayments/models/funding_account_response.rb +2 -2
  107. data/lib/velopayments/models/funding_account_response2.rb +2 -2
  108. data/lib/velopayments/models/funding_account_type.rb +2 -2
  109. data/lib/velopayments/models/funding_audit.rb +2 -2
  110. data/lib/velopayments/models/funding_event.rb +2 -2
  111. data/lib/velopayments/models/funding_event_type.rb +2 -2
  112. data/lib/velopayments/models/funding_payor_status_audit_response.rb +2 -2
  113. data/lib/velopayments/models/funding_request_v1.rb +2 -2
  114. data/lib/velopayments/models/funding_request_v2.rb +2 -2
  115. data/lib/velopayments/models/funding_request_v3.rb +2 -2
  116. data/lib/velopayments/models/fx_summary.rb +2 -2
  117. data/lib/velopayments/models/fx_summary_v3.rb +2 -2
  118. data/lib/velopayments/models/get_fundings_response.rb +2 -2
  119. data/lib/velopayments/models/get_fundings_response_links.rb +2 -2
  120. data/lib/velopayments/models/get_payee_list_response.rb +3 -3
  121. data/lib/velopayments/models/get_payee_list_response2.rb +3 -3
  122. data/lib/velopayments/models/get_payee_list_response_company.rb +2 -2
  123. data/lib/velopayments/models/get_payee_list_response_company2.rb +2 -2
  124. data/lib/velopayments/models/get_payee_list_response_individual.rb +2 -2
  125. data/lib/velopayments/models/get_payee_list_response_individual2.rb +2 -2
  126. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +2 -2
  127. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +2 -2
  128. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +2 -2
  129. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +2 -2
  130. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +15 -6
  131. data/lib/velopayments/models/get_payout_statistics.rb +2 -2
  132. data/lib/velopayments/models/get_payouts_response.rb +2 -2
  133. data/lib/velopayments/models/get_payouts_response_v3.rb +2 -2
  134. data/lib/velopayments/models/get_payouts_response_v3_links.rb +2 -2
  135. data/lib/velopayments/models/get_payouts_response_v3_page.rb +2 -2
  136. data/lib/velopayments/models/individual.rb +2 -2
  137. data/lib/velopayments/models/individual2.rb +2 -2
  138. data/lib/velopayments/models/individual_name.rb +2 -2
  139. data/lib/velopayments/models/inline_response400.rb +2 -2
  140. data/lib/velopayments/models/inline_response401.rb +2 -2
  141. data/lib/velopayments/models/inline_response403.rb +2 -2
  142. data/lib/velopayments/models/inline_response404.rb +2 -2
  143. data/lib/velopayments/models/inline_response409.rb +2 -2
  144. data/lib/velopayments/models/inline_response412.rb +2 -2
  145. data/lib/velopayments/models/instruct_payout_request.rb +219 -0
  146. data/lib/velopayments/models/invitation_status.rb +2 -2
  147. data/lib/velopayments/models/invitation_status2.rb +2 -2
  148. data/lib/velopayments/models/invite_payee_request.rb +2 -2
  149. data/lib/velopayments/models/invite_payee_request2.rb +2 -2
  150. data/lib/velopayments/models/invite_user_request.rb +27 -5
  151. data/lib/velopayments/models/kyc_state.rb +2 -2
  152. data/lib/velopayments/models/link_for_response.rb +2 -2
  153. data/lib/velopayments/models/list_funding_accounts_response.rb +2 -2
  154. data/lib/velopayments/models/list_funding_accounts_response2.rb +2 -2
  155. data/lib/velopayments/models/list_payments_response_v3.rb +2 -2
  156. data/lib/velopayments/models/list_payments_response_v3_page.rb +2 -2
  157. data/lib/velopayments/models/list_payments_response_v4.rb +2 -2
  158. data/lib/velopayments/models/list_source_account_response.rb +2 -2
  159. data/lib/velopayments/models/list_source_account_response_links.rb +2 -2
  160. data/lib/velopayments/models/list_source_account_response_page.rb +2 -2
  161. data/lib/velopayments/models/list_source_account_response_v2.rb +2 -2
  162. data/lib/velopayments/models/list_source_account_response_v2_links.rb +2 -2
  163. data/lib/velopayments/models/list_source_account_response_v3.rb +2 -2
  164. data/lib/velopayments/models/list_source_account_response_v3_links.rb +2 -2
  165. data/lib/velopayments/models/localisation_details.rb +2 -2
  166. data/lib/velopayments/models/mfa_details.rb +2 -2
  167. data/lib/velopayments/models/mfa_type.rb +2 -2
  168. data/lib/velopayments/models/name.rb +2 -2
  169. data/lib/velopayments/models/name2.rb +2 -2
  170. data/lib/velopayments/models/notification.rb +3 -2
  171. data/lib/velopayments/models/notifications.rb +2 -2
  172. data/lib/velopayments/models/notifications2.rb +2 -2
  173. data/lib/velopayments/models/ofac_status.rb +2 -2
  174. data/lib/velopayments/models/onboarded_status.rb +2 -2
  175. data/lib/velopayments/models/onboarded_status2.rb +2 -2
  176. data/lib/velopayments/models/onboarding_status_changed.rb +2 -2
  177. data/lib/velopayments/models/page_for_response.rb +2 -2
  178. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +2 -2
  179. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +2 -2
  180. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +2 -2
  181. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +2 -2
  182. data/lib/velopayments/models/paged_payee_response.rb +2 -2
  183. data/lib/velopayments/models/paged_payee_response2.rb +2 -2
  184. data/lib/velopayments/models/paged_payee_response_links.rb +2 -2
  185. data/lib/velopayments/models/paged_payee_response_page.rb +2 -2
  186. data/lib/velopayments/models/paged_payee_response_summary.rb +2 -2
  187. data/lib/velopayments/models/paged_payments_response_v3.rb +2 -2
  188. data/lib/velopayments/models/paged_user_response.rb +2 -2
  189. data/lib/velopayments/models/paged_user_response_links.rb +2 -2
  190. data/lib/velopayments/models/paged_user_response_page.rb +2 -2
  191. data/lib/velopayments/models/password_request.rb +2 -2
  192. data/lib/velopayments/models/payable_issue.rb +2 -2
  193. data/lib/velopayments/models/payable_issue2.rb +2 -2
  194. data/lib/velopayments/models/payable_status_changed.rb +2 -2
  195. data/lib/velopayments/models/payee_address.rb +2 -2
  196. data/lib/velopayments/models/payee_address2.rb +2 -2
  197. data/lib/velopayments/models/payee_delta.rb +2 -2
  198. data/lib/velopayments/models/payee_delta2.rb +2 -2
  199. data/lib/velopayments/models/payee_delta_response.rb +2 -2
  200. data/lib/velopayments/models/payee_delta_response2.rb +2 -2
  201. data/lib/velopayments/models/payee_delta_response2_links.rb +2 -2
  202. data/lib/velopayments/models/payee_delta_response_links.rb +2 -2
  203. data/lib/velopayments/models/payee_delta_response_page.rb +2 -2
  204. data/lib/velopayments/models/payee_detail_response.rb +3 -3
  205. data/lib/velopayments/models/payee_detail_response2.rb +3 -3
  206. data/lib/velopayments/models/payee_details_changed.rb +2 -2
  207. data/lib/velopayments/models/payee_event.rb +2 -2
  208. data/lib/velopayments/models/payee_event_all_of.rb +2 -2
  209. data/lib/velopayments/models/payee_event_all_of_reasons.rb +2 -2
  210. data/lib/velopayments/models/payee_invitation_status_response.rb +2 -2
  211. data/lib/velopayments/models/payee_invitation_status_response2.rb +2 -2
  212. data/lib/velopayments/models/payee_payor_ref.rb +2 -2
  213. data/lib/velopayments/models/payee_payor_ref_v3.rb +2 -2
  214. data/lib/velopayments/models/payee_type.rb +4 -4
  215. data/lib/velopayments/models/payee_type2.rb +37 -0
  216. data/lib/velopayments/models/payee_user_self_update_request.rb +2 -2
  217. data/lib/velopayments/models/payment_audit_currency.rb +2 -2
  218. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  219. data/lib/velopayments/models/payment_channel_country.rb +2 -2
  220. data/lib/velopayments/models/payment_channel_rule.rb +2 -2
  221. data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
  222. data/lib/velopayments/models/payment_delta.rb +2 -2
  223. data/lib/velopayments/models/payment_delta_response.rb +2 -2
  224. data/lib/velopayments/models/payment_delta_response_v1.rb +2 -2
  225. data/lib/velopayments/models/payment_delta_v1.rb +2 -2
  226. data/lib/velopayments/models/payment_event.rb +2 -2
  227. data/lib/velopayments/models/payment_event_all_of.rb +2 -2
  228. data/lib/velopayments/models/payment_event_response.rb +2 -2
  229. data/lib/velopayments/models/payment_event_response_v3.rb +2 -2
  230. data/lib/velopayments/models/payment_instruction_v3.rb +2 -2
  231. data/lib/velopayments/models/payment_rails.rb +2 -2
  232. data/lib/velopayments/models/payment_rejected_or_returned.rb +2 -2
  233. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +2 -2
  234. data/lib/velopayments/models/payment_response_v3.rb +2 -2
  235. data/lib/velopayments/models/payment_response_v4.rb +22 -3
  236. data/lib/velopayments/models/payment_response_v4_payout.rb +2 -2
  237. data/lib/velopayments/models/payment_status_changed.rb +2 -2
  238. data/lib/velopayments/models/payment_status_changed_all_of.rb +2 -2
  239. data/lib/velopayments/models/payment_v3.rb +16 -6
  240. data/lib/velopayments/models/payor_address.rb +2 -2
  241. data/lib/velopayments/models/payor_address_v2.rb +2 -2
  242. data/lib/velopayments/models/payor_aml_transaction.rb +2 -2
  243. data/lib/velopayments/models/payor_aml_transaction_v3.rb +2 -2
  244. data/lib/velopayments/models/payor_branding_response.rb +2 -2
  245. data/lib/velopayments/models/payor_create_api_key_request.rb +3 -3
  246. data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
  247. data/lib/velopayments/models/payor_create_application_request.rb +2 -2
  248. data/lib/velopayments/models/payor_email_opt_out_request.rb +2 -2
  249. data/lib/velopayments/models/payor_links_response.rb +2 -2
  250. data/lib/velopayments/models/payor_links_response_links.rb +2 -2
  251. data/lib/velopayments/models/payor_links_response_payors.rb +2 -2
  252. data/lib/velopayments/models/payor_logo_request.rb +218 -0
  253. data/lib/velopayments/models/payor_v1.rb +2 -2
  254. data/lib/velopayments/models/payor_v2.rb +23 -3
  255. data/lib/velopayments/models/payout_company_v3.rb +2 -2
  256. data/lib/velopayments/models/payout_individual_v3.rb +2 -2
  257. data/lib/velopayments/models/payout_name_v3.rb +2 -2
  258. data/lib/velopayments/models/payout_payee_v3.rb +2 -2
  259. data/lib/velopayments/models/payout_payor.rb +2 -2
  260. data/lib/velopayments/models/payout_payor_ids.rb +2 -2
  261. data/lib/velopayments/models/payout_principal.rb +2 -2
  262. data/lib/velopayments/models/payout_schedule.rb +291 -0
  263. data/lib/velopayments/models/payout_schedule2.rb +281 -0
  264. data/lib/velopayments/models/payout_status.rb +2 -2
  265. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  266. data/lib/velopayments/models/payout_summary_audit.rb +15 -6
  267. data/lib/velopayments/models/payout_summary_audit_v3.rb +2 -2
  268. data/lib/velopayments/models/payout_summary_response_v3.rb +15 -6
  269. data/lib/velopayments/models/payout_type.rb +2 -2
  270. data/lib/velopayments/models/ping.rb +2 -2
  271. data/lib/velopayments/models/ping_response.rb +227 -0
  272. data/lib/velopayments/models/query_batch_response.rb +2 -2
  273. data/lib/velopayments/models/query_batch_response2.rb +2 -2
  274. data/lib/velopayments/models/quote_fx_summary_v3.rb +2 -2
  275. data/lib/velopayments/models/quote_response_v3.rb +2 -2
  276. data/lib/velopayments/models/region_v2.rb +2 -2
  277. data/lib/velopayments/models/register_sms_request.rb +2 -2
  278. data/lib/velopayments/models/rejected_payment_v3.rb +2 -2
  279. data/lib/velopayments/models/resend_token_request.rb +2 -2
  280. data/lib/velopayments/models/reset_password_request.rb +2 -2
  281. data/lib/velopayments/models/role.rb +2 -2
  282. data/lib/velopayments/models/role_update_request.rb +2 -2
  283. data/lib/velopayments/models/schedule_payout_request.rb +239 -0
  284. data/lib/velopayments/models/schedule_status.rb +38 -0
  285. data/lib/velopayments/models/schedule_status2.rb +38 -0
  286. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +2 -2
  287. data/lib/velopayments/models/self_update_password_request.rb +2 -2
  288. data/lib/velopayments/models/set_notifications_request.rb +2 -2
  289. data/lib/velopayments/models/source_account_response.rb +2 -2
  290. data/lib/velopayments/models/source_account_response_v2.rb +2 -2
  291. data/lib/velopayments/models/source_account_response_v3.rb +2 -2
  292. data/lib/velopayments/models/source_account_summary.rb +2 -2
  293. data/lib/velopayments/models/source_account_summary_v3.rb +2 -2
  294. data/lib/velopayments/models/source_account_type.rb +2 -2
  295. data/lib/velopayments/models/source_account_v3.rb +2 -2
  296. data/lib/velopayments/models/source_event.rb +2 -2
  297. data/lib/velopayments/models/supported_countries_response.rb +2 -2
  298. data/lib/velopayments/models/supported_countries_response_v2.rb +2 -2
  299. data/lib/velopayments/models/supported_country.rb +2 -2
  300. data/lib/velopayments/models/supported_country_v2.rb +2 -2
  301. data/lib/velopayments/models/supported_currency_response_v2.rb +2 -2
  302. data/lib/velopayments/models/supported_currency_v2.rb +2 -2
  303. data/lib/velopayments/models/transfer_request.rb +2 -2
  304. data/lib/velopayments/models/transfer_request2.rb +2 -2
  305. data/lib/velopayments/models/transmission_type.rb +2 -2
  306. data/lib/velopayments/models/transmission_types.rb +2 -2
  307. data/lib/velopayments/models/transmission_types2.rb +2 -2
  308. data/lib/velopayments/models/unregister_mfa_request.rb +2 -2
  309. data/lib/velopayments/models/update_payee_details_request.rb +3 -3
  310. data/lib/velopayments/models/update_payee_details_request2.rb +35 -8
  311. data/lib/velopayments/models/update_remote_id_request.rb +2 -2
  312. data/lib/velopayments/models/update_remote_id_request2.rb +2 -2
  313. data/lib/velopayments/models/update_webhook_request.rb +2 -2
  314. data/lib/velopayments/models/user_details_update_request.rb +2 -2
  315. data/lib/velopayments/models/user_info.rb +2 -2
  316. data/lib/velopayments/models/user_response.rb +59 -3
  317. data/lib/velopayments/models/user_status.rb +2 -2
  318. data/lib/velopayments/models/user_type.rb +2 -2
  319. data/lib/velopayments/models/user_type2.rb +2 -2
  320. data/lib/velopayments/models/validate_password_response.rb +2 -2
  321. data/lib/velopayments/models/watchlist_status.rb +2 -2
  322. data/lib/velopayments/models/watchlist_status2.rb +2 -2
  323. data/lib/velopayments/models/webhook_response.rb +2 -2
  324. data/lib/velopayments/models/webhooks_response.rb +2 -2
  325. data/lib/velopayments/models/withdraw_payment_request.rb +2 -2
  326. data/lib/velopayments/version.rb +3 -3
  327. data/lib/velopayments.rb +13 -2
  328. data/oa3-config.json +1 -1
  329. data/spec/api/countries_api_spec.rb +2 -2
  330. data/spec/api/currencies_api_spec.rb +2 -2
  331. data/spec/api/funding_manager_api_spec.rb +2 -2
  332. data/spec/api/funding_manager_private_api_spec.rb +2 -2
  333. data/spec/api/login_api_spec.rb +2 -2
  334. data/spec/api/payee_invitation_api_spec.rb +2 -2
  335. data/spec/api/payees_api_spec.rb +5 -5
  336. data/spec/api/payment_audit_service_api_spec.rb +9 -3
  337. data/spec/api/payment_audit_service_deprecated_api_spec.rb +2 -2
  338. data/spec/api/payors_api_spec.rb +2 -2
  339. data/spec/api/payors_private_api_spec.rb +2 -2
  340. data/spec/api/payout_service_api_spec.rb +29 -3
  341. data/spec/api/tokens_api_spec.rb +2 -2
  342. data/spec/api/users_api_spec.rb +3 -2
  343. data/spec/api/webhooks_api_spec.rb +12 -2
  344. data/spec/api_client_spec.rb +4 -4
  345. data/spec/configuration_spec.rb +2 -2
  346. data/spec/models/accepted_payment_v3_spec.rb +2 -2
  347. data/spec/models/access_token_response_spec.rb +2 -2
  348. data/spec/models/access_token_validation_request_spec.rb +2 -2
  349. data/spec/models/auth_response_spec.rb +2 -2
  350. data/spec/models/auto_top_up_config2_spec.rb +2 -2
  351. data/spec/models/auto_top_up_config_spec.rb +2 -2
  352. data/spec/models/category_spec.rb +2 -2
  353. data/spec/models/challenge2_spec.rb +2 -2
  354. data/spec/models/challenge_spec.rb +2 -2
  355. data/spec/models/company2_spec.rb +2 -2
  356. data/spec/models/company_spec.rb +2 -2
  357. data/spec/models/create_funding_account_request_v2_spec.rb +2 -2
  358. data/spec/models/create_individual2_spec.rb +2 -2
  359. data/spec/models/create_individual_name_spec.rb +2 -2
  360. data/spec/models/create_individual_spec.rb +2 -2
  361. data/spec/models/create_payee2_spec.rb +2 -2
  362. data/spec/models/create_payee_address2_spec.rb +2 -2
  363. data/spec/models/create_payee_address_spec.rb +2 -2
  364. data/spec/models/create_payee_spec.rb +2 -2
  365. data/spec/models/create_payees_csv_request2_spec.rb +214 -0
  366. data/spec/models/create_payees_csv_request_spec.rb +214 -0
  367. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  368. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
  369. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  370. data/spec/models/create_payees_request2_spec.rb +2 -2
  371. data/spec/models/create_payees_request_spec.rb +2 -2
  372. data/spec/models/create_payment_channel2_spec.rb +2 -2
  373. data/spec/models/create_payment_channel_spec.rb +2 -2
  374. data/spec/models/create_payor_link_request_spec.rb +2 -2
  375. data/spec/models/create_payout_request_v3_spec.rb +2 -2
  376. data/spec/models/create_webhook_request_spec.rb +2 -2
  377. data/spec/models/debit_event_all_of_spec.rb +2 -2
  378. data/spec/models/debit_event_spec.rb +2 -2
  379. data/spec/models/debit_status_changed_all_of_spec.rb +2 -2
  380. data/spec/models/debit_status_changed_spec.rb +2 -2
  381. data/spec/models/error_data_spec.rb +2 -2
  382. data/spec/models/error_response_spec.rb +2 -2
  383. data/spec/models/error_spec.rb +2 -2
  384. data/spec/models/failed_payee2_spec.rb +2 -2
  385. data/spec/models/failed_payee_spec.rb +2 -2
  386. data/spec/models/failed_submission2_spec.rb +2 -2
  387. data/spec/models/failed_submission_spec.rb +2 -2
  388. data/spec/models/funding_account_response2_spec.rb +2 -2
  389. data/spec/models/funding_account_response_spec.rb +2 -2
  390. data/spec/models/funding_account_type_spec.rb +2 -2
  391. data/spec/models/funding_audit_spec.rb +2 -2
  392. data/spec/models/funding_event_spec.rb +2 -2
  393. data/spec/models/funding_event_type_spec.rb +2 -2
  394. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  395. data/spec/models/funding_request_v1_spec.rb +2 -2
  396. data/spec/models/funding_request_v2_spec.rb +2 -2
  397. data/spec/models/funding_request_v3_spec.rb +2 -2
  398. data/spec/models/fx_summary_spec.rb +2 -2
  399. data/spec/models/fx_summary_v3_spec.rb +2 -2
  400. data/spec/models/get_fundings_response_links_spec.rb +2 -2
  401. data/spec/models/get_fundings_response_spec.rb +2 -2
  402. data/spec/models/get_payee_list_response2_spec.rb +2 -2
  403. data/spec/models/get_payee_list_response_company2_spec.rb +2 -2
  404. data/spec/models/get_payee_list_response_company_spec.rb +2 -2
  405. data/spec/models/get_payee_list_response_individual2_spec.rb +2 -2
  406. data/spec/models/get_payee_list_response_individual_spec.rb +2 -2
  407. data/spec/models/get_payee_list_response_spec.rb +2 -2
  408. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  409. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  410. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  411. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  412. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
  413. data/spec/models/get_payout_statistics_spec.rb +2 -2
  414. data/spec/models/get_payouts_response_spec.rb +2 -2
  415. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  416. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  417. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  418. data/spec/models/individual2_spec.rb +2 -2
  419. data/spec/models/individual_name_spec.rb +2 -2
  420. data/spec/models/individual_spec.rb +2 -2
  421. data/spec/models/inline_response400_spec.rb +2 -2
  422. data/spec/models/inline_response401_spec.rb +2 -2
  423. data/spec/models/inline_response403_spec.rb +2 -2
  424. data/spec/models/inline_response404_spec.rb +2 -2
  425. data/spec/models/inline_response409_spec.rb +2 -2
  426. data/spec/models/inline_response412_spec.rb +2 -2
  427. data/spec/models/instruct_payout_request_spec.rb +34 -0
  428. data/spec/models/invitation_status2_spec.rb +2 -2
  429. data/spec/models/invitation_status_spec.rb +2 -2
  430. data/spec/models/invite_payee_request2_spec.rb +2 -2
  431. data/spec/models/invite_payee_request_spec.rb +2 -2
  432. data/spec/models/invite_user_request_spec.rb +12 -2
  433. data/spec/models/kyc_state_spec.rb +2 -2
  434. data/spec/models/link_for_response_spec.rb +2 -2
  435. data/spec/models/list_funding_accounts_response2_spec.rb +2 -2
  436. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  437. data/spec/models/list_payments_response_v3_page_spec.rb +2 -2
  438. data/spec/models/list_payments_response_v3_spec.rb +2 -2
  439. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  440. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  441. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  442. data/spec/models/list_source_account_response_spec.rb +2 -2
  443. data/spec/models/list_source_account_response_v2_links_spec.rb +2 -2
  444. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  445. data/spec/models/list_source_account_response_v3_links_spec.rb +2 -2
  446. data/spec/models/list_source_account_response_v3_spec.rb +2 -2
  447. data/spec/models/localisation_details_spec.rb +2 -2
  448. data/spec/models/mfa_details_spec.rb +2 -2
  449. data/spec/models/mfa_type_spec.rb +2 -2
  450. data/spec/models/name2_spec.rb +2 -2
  451. data/spec/models/name_spec.rb +2 -2
  452. data/spec/models/notification_spec.rb +2 -2
  453. data/spec/models/notifications2_spec.rb +2 -2
  454. data/spec/models/notifications_spec.rb +2 -2
  455. data/spec/models/ofac_status_spec.rb +2 -2
  456. data/spec/models/onboarded_status2_spec.rb +2 -2
  457. data/spec/models/onboarded_status_spec.rb +2 -2
  458. data/spec/models/onboarding_status_changed_spec.rb +2 -2
  459. data/spec/models/page_for_response_spec.rb +2 -2
  460. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  461. data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
  462. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
  463. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  464. data/spec/models/paged_payee_response2_spec.rb +2 -2
  465. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  466. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  467. data/spec/models/paged_payee_response_spec.rb +2 -2
  468. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  469. data/spec/models/paged_payments_response_v3_spec.rb +2 -2
  470. data/spec/models/paged_user_response_links_spec.rb +2 -2
  471. data/spec/models/paged_user_response_page_spec.rb +2 -2
  472. data/spec/models/paged_user_response_spec.rb +2 -2
  473. data/spec/models/password_request_spec.rb +2 -2
  474. data/spec/models/payable_issue2_spec.rb +2 -2
  475. data/spec/models/payable_issue_spec.rb +2 -2
  476. data/spec/models/payable_status_changed_spec.rb +2 -2
  477. data/spec/models/payee_address2_spec.rb +2 -2
  478. data/spec/models/payee_address_spec.rb +2 -2
  479. data/spec/models/payee_delta2_spec.rb +2 -2
  480. data/spec/models/payee_delta_response2_links_spec.rb +2 -2
  481. data/spec/models/payee_delta_response2_spec.rb +2 -2
  482. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  483. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  484. data/spec/models/payee_delta_response_spec.rb +2 -2
  485. data/spec/models/payee_delta_spec.rb +2 -2
  486. data/spec/models/payee_detail_response2_spec.rb +2 -2
  487. data/spec/models/payee_detail_response_spec.rb +2 -2
  488. data/spec/models/payee_details_changed_spec.rb +2 -2
  489. data/spec/models/payee_event_all_of_reasons_spec.rb +2 -2
  490. data/spec/models/payee_event_all_of_spec.rb +2 -2
  491. data/spec/models/payee_event_spec.rb +2 -2
  492. data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
  493. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  494. data/spec/models/payee_payor_ref_spec.rb +2 -2
  495. data/spec/models/payee_payor_ref_v3_spec.rb +2 -2
  496. data/spec/models/payee_type2_spec.rb +28 -0
  497. data/spec/models/payee_type_spec.rb +2 -2
  498. data/spec/models/payee_user_self_update_request_spec.rb +2 -2
  499. data/spec/models/payment_audit_currency_spec.rb +2 -2
  500. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  501. data/spec/models/payment_channel_country_spec.rb +2 -2
  502. data/spec/models/payment_channel_rule_spec.rb +2 -2
  503. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  504. data/spec/models/payment_delta_response_spec.rb +2 -2
  505. data/spec/models/payment_delta_response_v1_spec.rb +2 -2
  506. data/spec/models/payment_delta_spec.rb +2 -2
  507. data/spec/models/payment_delta_v1_spec.rb +2 -2
  508. data/spec/models/payment_event_all_of_spec.rb +2 -2
  509. data/spec/models/payment_event_response_spec.rb +2 -2
  510. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  511. data/spec/models/payment_event_spec.rb +2 -2
  512. data/spec/models/payment_instruction_v3_spec.rb +2 -2
  513. data/spec/models/payment_rails_spec.rb +2 -2
  514. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +2 -2
  515. data/spec/models/payment_rejected_or_returned_spec.rb +2 -2
  516. data/spec/models/payment_response_v3_spec.rb +2 -2
  517. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  518. data/spec/models/payment_response_v4_spec.rb +14 -2
  519. data/spec/models/payment_status_changed_all_of_spec.rb +2 -2
  520. data/spec/models/payment_status_changed_spec.rb +2 -2
  521. data/spec/models/payment_v3_spec.rb +8 -2
  522. data/spec/models/payor_address_spec.rb +2 -2
  523. data/spec/models/payor_address_v2_spec.rb +2 -2
  524. data/spec/models/payor_aml_transaction_spec.rb +2 -2
  525. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  526. data/spec/models/payor_branding_response_spec.rb +2 -2
  527. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  528. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  529. data/spec/models/payor_create_application_request_spec.rb +2 -2
  530. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  531. data/spec/models/payor_links_response_links_spec.rb +2 -2
  532. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  533. data/spec/models/payor_links_response_spec.rb +2 -2
  534. data/spec/models/payor_logo_request_spec.rb +34 -0
  535. data/spec/models/payor_v1_spec.rb +2 -2
  536. data/spec/models/payor_v2_spec.rb +14 -2
  537. data/spec/models/payout_company_v3_spec.rb +2 -2
  538. data/spec/models/payout_individual_v3_spec.rb +2 -2
  539. data/spec/models/payout_name_v3_spec.rb +2 -2
  540. data/spec/models/payout_payee_v3_spec.rb +2 -2
  541. data/spec/models/payout_payor_ids_spec.rb +2 -2
  542. data/spec/models/payout_payor_spec.rb +2 -2
  543. data/spec/models/payout_principal_spec.rb +2 -2
  544. data/spec/models/payout_schedule2_spec.rb +58 -0
  545. data/spec/models/payout_schedule_spec.rb +64 -0
  546. data/spec/models/payout_status_spec.rb +2 -2
  547. data/spec/models/payout_status_v3_spec.rb +2 -2
  548. data/spec/models/payout_summary_audit_spec.rb +8 -2
  549. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  550. data/spec/models/payout_summary_response_v3_spec.rb +8 -2
  551. data/spec/models/payout_type_spec.rb +2 -2
  552. data/spec/models/ping_response_spec.rb +40 -0
  553. data/spec/models/ping_spec.rb +2 -2
  554. data/spec/models/query_batch_response2_spec.rb +2 -2
  555. data/spec/models/query_batch_response_spec.rb +2 -2
  556. data/spec/models/quote_fx_summary_v3_spec.rb +2 -2
  557. data/spec/models/quote_response_v3_spec.rb +2 -2
  558. data/spec/models/region_v2_spec.rb +2 -2
  559. data/spec/models/register_sms_request_spec.rb +2 -2
  560. data/spec/models/rejected_payment_v3_spec.rb +2 -2
  561. data/spec/models/resend_token_request_spec.rb +2 -2
  562. data/spec/models/reset_password_request_spec.rb +2 -2
  563. data/spec/models/role_spec.rb +2 -2
  564. data/spec/models/role_update_request_spec.rb +2 -2
  565. data/spec/models/schedule_payout_request_spec.rb +40 -0
  566. data/spec/models/schedule_status2_spec.rb +28 -0
  567. data/spec/models/schedule_status_spec.rb +28 -0
  568. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  569. data/spec/models/self_update_password_request_spec.rb +2 -2
  570. data/spec/models/set_notifications_request_spec.rb +2 -2
  571. data/spec/models/source_account_response_spec.rb +2 -2
  572. data/spec/models/source_account_response_v2_spec.rb +2 -2
  573. data/spec/models/source_account_response_v3_spec.rb +2 -2
  574. data/spec/models/source_account_summary_spec.rb +2 -2
  575. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  576. data/spec/models/source_account_type_spec.rb +2 -2
  577. data/spec/models/source_account_v3_spec.rb +2 -2
  578. data/spec/models/source_event_spec.rb +2 -2
  579. data/spec/models/supported_countries_response_spec.rb +2 -2
  580. data/spec/models/supported_countries_response_v2_spec.rb +2 -2
  581. data/spec/models/supported_country_spec.rb +2 -2
  582. data/spec/models/supported_country_v2_spec.rb +2 -2
  583. data/spec/models/supported_currency_response_v2_spec.rb +2 -2
  584. data/spec/models/supported_currency_v2_spec.rb +2 -2
  585. data/spec/models/transfer_request2_spec.rb +2 -2
  586. data/spec/models/transfer_request_spec.rb +2 -2
  587. data/spec/models/transmission_type_spec.rb +2 -2
  588. data/spec/models/transmission_types2_spec.rb +2 -2
  589. data/spec/models/transmission_types_spec.rb +2 -2
  590. data/spec/models/unregister_mfa_request_spec.rb +2 -2
  591. data/spec/models/update_payee_details_request2_spec.rb +8 -2
  592. data/spec/models/update_payee_details_request_spec.rb +2 -2
  593. data/spec/models/update_remote_id_request2_spec.rb +2 -2
  594. data/spec/models/update_remote_id_request_spec.rb +2 -2
  595. data/spec/models/update_webhook_request_spec.rb +2 -2
  596. data/spec/models/user_details_update_request_spec.rb +2 -2
  597. data/spec/models/user_info_spec.rb +2 -2
  598. data/spec/models/user_response_spec.rb +18 -2
  599. data/spec/models/user_status_spec.rb +2 -2
  600. data/spec/models/user_type2_spec.rb +2 -2
  601. data/spec/models/user_type_spec.rb +2 -2
  602. data/spec/models/validate_password_response_spec.rb +2 -2
  603. data/spec/models/watchlist_status2_spec.rb +2 -2
  604. data/spec/models/watchlist_status_spec.rb +2 -2
  605. data/spec/models/webhook_response_spec.rb +2 -2
  606. data/spec/models/webhooks_response_spec.rb +2 -2
  607. data/spec/models/withdraw_payment_request_spec.rb +2 -2
  608. data/spec/spec_helper.rb +2 -2
  609. data/specs/api/payment_audit_service_deprecated_api_spec.rb +177 -0
  610. data/specs/api/webhooks_api_spec.rb +96 -0
  611. data/velopayments.gemspec +2 -2
  612. metadata +48 -2
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -55,7 +55,7 @@ module VeloPayments
55
55
  :'individual' => :'Individual',
56
56
  :'company' => :'Company',
57
57
  :'language' => :'String',
58
- :'payee_type' => :'PayeeType',
58
+ :'payee_type' => :'PayeeType2',
59
59
  :'challenge' => :'Challenge',
60
60
  :'email' => :'String'
61
61
  }
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -30,6 +30,9 @@ module VeloPayments
30
30
 
31
31
  attr_accessor :email
32
32
 
33
+ # The phone number of a device that the payee wishes to receive sms messages on
34
+ attr_accessor :contact_sms_number
35
+
33
36
  # Attribute mapping from ruby-style variable name to JSON key.
34
37
  def self.attribute_map
35
38
  {
@@ -39,7 +42,8 @@ module VeloPayments
39
42
  :'language' => :'language',
40
43
  :'payee_type' => :'payeeType',
41
44
  :'challenge' => :'challenge',
42
- :'email' => :'email'
45
+ :'email' => :'email',
46
+ :'contact_sms_number' => :'contactSmsNumber'
43
47
  }
44
48
  end
45
49
 
@@ -55,9 +59,10 @@ module VeloPayments
55
59
  :'individual' => :'Individual2',
56
60
  :'company' => :'Company2',
57
61
  :'language' => :'String',
58
- :'payee_type' => :'PayeeType',
62
+ :'payee_type' => :'PayeeType2',
59
63
  :'challenge' => :'Challenge2',
60
- :'email' => :'String'
64
+ :'email' => :'String',
65
+ :'contact_sms_number' => :'String'
61
66
  }
62
67
  end
63
68
 
@@ -65,7 +70,7 @@ module VeloPayments
65
70
  def self.openapi_nullable
66
71
  Set.new([
67
72
  :'company',
68
- :'email'
73
+ :'email',
69
74
  ])
70
75
  end
71
76
 
@@ -111,21 +116,42 @@ module VeloPayments
111
116
  if attributes.key?(:'email')
112
117
  self.email = attributes[:'email']
113
118
  end
119
+
120
+ if attributes.key?(:'contact_sms_number')
121
+ self.contact_sms_number = attributes[:'contact_sms_number']
122
+ end
114
123
  end
115
124
 
116
125
  # Show invalid properties with the reasons. Usually used together with valid?
117
126
  # @return Array for valid properties with the reasons
118
127
  def list_invalid_properties
119
128
  invalid_properties = Array.new
129
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
130
+ if !@contact_sms_number.nil? && @contact_sms_number !~ pattern
131
+ invalid_properties.push("invalid value for \"contact_sms_number\", must conform to the pattern #{pattern}.")
132
+ end
133
+
120
134
  invalid_properties
121
135
  end
122
136
 
123
137
  # Check to see if the all the properties in the model are valid
124
138
  # @return true if the model is valid
125
139
  def valid?
140
+ return false if !@contact_sms_number.nil? && @contact_sms_number !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
126
141
  true
127
142
  end
128
143
 
144
+ # Custom attribute writer method with validation
145
+ # @param [Object] contact_sms_number Value to be assigned
146
+ def contact_sms_number=(contact_sms_number)
147
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
148
+ if !contact_sms_number.nil? && contact_sms_number !~ pattern
149
+ fail ArgumentError, "invalid value for \"contact_sms_number\", must conform to the pattern #{pattern}."
150
+ end
151
+
152
+ @contact_sms_number = contact_sms_number
153
+ end
154
+
129
155
  # Checks equality by comparing each attribute.
130
156
  # @param [Object] Object to be compared
131
157
  def ==(o)
@@ -137,7 +163,8 @@ module VeloPayments
137
163
  language == o.language &&
138
164
  payee_type == o.payee_type &&
139
165
  challenge == o.challenge &&
140
- email == o.email
166
+ email == o.email &&
167
+ contact_sms_number == o.contact_sms_number
141
168
  end
142
169
 
143
170
  # @see the `==` method
@@ -149,7 +176,7 @@ module VeloPayments
149
176
  # Calculates hash code according to all attributes.
150
177
  # @return [Integer] Hash code
151
178
  def hash
152
- [address, individual, company, language, payee_type, challenge, email].hash
179
+ [address, individual, company, language, payee_type, challenge, email, contact_sms_number].hash
153
180
  end
154
181
 
155
182
  # Builds the object from hash
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.26.124
6
+ The version of the OpenAPI document: 2.29.128
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
9
+ OpenAPI Generator version: 6.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12