velopayments 2.23.78.beta1 → 2.26.124.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 (891) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +2 -3
  3. data/README.md +61 -71
  4. data/docs/AcceptedPaymentV3.md +22 -17
  5. data/docs/AccessTokenResponse.md +20 -19
  6. data/docs/AccessTokenValidationRequest.md +8 -7
  7. data/docs/AuthResponse.md +18 -17
  8. data/docs/AutoTopUpConfig.md +12 -11
  9. data/docs/AutoTopUpConfig2.md +14 -13
  10. data/docs/Category.md +15 -0
  11. data/docs/Challenge.md +10 -9
  12. data/docs/Challenge2.md +10 -9
  13. data/docs/Company.md +12 -11
  14. data/docs/Company2.md +12 -11
  15. data/docs/CountriesApi.md +74 -21
  16. data/docs/CreateFundingAccountRequestV2.md +20 -19
  17. data/docs/CreateIndividual.md +12 -11
  18. data/docs/CreateIndividual2.md +12 -11
  19. data/docs/CreateIndividualName.md +24 -0
  20. data/docs/CreatePayee.md +28 -27
  21. data/docs/CreatePayee2.md +28 -27
  22. data/docs/CreatePayeeAddress.md +22 -21
  23. data/docs/CreatePayeeAddress2.md +22 -21
  24. data/docs/CreatePayeesCSVResponse.md +10 -9
  25. data/docs/CreatePayeesCSVResponse2.md +10 -9
  26. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
  27. data/docs/CreatePayeesRequest.md +10 -9
  28. data/docs/CreatePayeesRequest2.md +10 -9
  29. data/docs/CreatePaymentChannel.md +20 -19
  30. data/docs/CreatePaymentChannel2.md +20 -19
  31. data/docs/CreatePayorLinkRequest.md +12 -11
  32. data/docs/CreatePayoutRequestV3.md +14 -15
  33. data/docs/CreateWebhookRequest.md +16 -13
  34. data/docs/CurrenciesApi.md +26 -9
  35. data/docs/DebitEvent.md +24 -0
  36. data/docs/DebitEventAllOf.md +18 -0
  37. data/docs/DebitStatusChanged.md +26 -0
  38. data/docs/DebitStatusChangedAllOf.md +18 -0
  39. data/docs/Error.md +20 -13
  40. data/docs/ErrorData.md +20 -0
  41. data/docs/ErrorResponse.md +12 -9
  42. data/docs/FailedPayee.md +38 -0
  43. data/docs/FailedPayee2.md +38 -0
  44. data/docs/FailedSubmission.md +10 -9
  45. data/docs/FailedSubmission2.md +10 -9
  46. data/docs/FundingAccountResponse.md +26 -25
  47. data/docs/FundingAccountResponse2.md +26 -25
  48. data/docs/FundingAccountType.md +4 -5
  49. data/docs/FundingAudit.md +24 -23
  50. data/docs/FundingEvent.md +14 -13
  51. data/docs/FundingEventType.md +4 -5
  52. data/docs/FundingManagerApi.md +549 -259
  53. data/docs/FundingManagerPrivateApi.md +98 -13
  54. data/docs/FundingPayorStatusAuditResponse.md +14 -13
  55. data/docs/FundingRequestV1.md +8 -7
  56. data/docs/FundingRequestV2.md +8 -7
  57. data/docs/FundingRequestV3.md +10 -9
  58. data/docs/FxSummary.md +36 -0
  59. data/docs/FxSummaryV3.md +26 -25
  60. data/docs/GetFundingsResponse.md +12 -11
  61. data/docs/GetFundingsResponseLinks.md +10 -9
  62. data/docs/GetPayeeListResponse.md +40 -39
  63. data/docs/GetPayeeListResponse2.md +50 -0
  64. data/docs/GetPayeeListResponseCompany.md +10 -9
  65. data/docs/GetPayeeListResponseCompany2.md +20 -0
  66. data/docs/GetPayeeListResponseIndividual.md +8 -7
  67. data/docs/GetPayeeListResponseIndividual2.md +18 -0
  68. data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
  69. data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
  70. data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
  71. data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
  72. data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -43
  73. data/docs/GetPayoutStatistics.md +10 -9
  74. data/docs/GetPayoutsResponse.md +22 -0
  75. data/docs/GetPayoutsResponseV3.md +12 -11
  76. data/docs/GetPayoutsResponseV3Links.md +10 -9
  77. data/docs/GetPayoutsResponseV3Page.md +16 -15
  78. data/docs/Individual.md +12 -11
  79. data/docs/Individual2.md +12 -11
  80. data/docs/IndividualName.md +24 -0
  81. data/docs/InlineResponse400.md +12 -9
  82. data/docs/InlineResponse401.md +12 -9
  83. data/docs/InlineResponse403.md +12 -9
  84. data/docs/InlineResponse404.md +12 -9
  85. data/docs/InlineResponse409.md +12 -9
  86. data/docs/InlineResponse412.md +12 -9
  87. data/docs/InvitationStatus.md +4 -5
  88. data/docs/InvitationStatus2.md +4 -5
  89. data/docs/InvitePayeeRequest.md +8 -7
  90. data/docs/InvitePayeeRequest2.md +8 -7
  91. data/docs/InviteUserRequest.md +26 -25
  92. data/docs/KycState.md +4 -5
  93. data/docs/LinkForResponse.md +10 -9
  94. data/docs/ListFundingAccountsResponse.md +12 -11
  95. data/docs/ListFundingAccountsResponse2.md +12 -11
  96. data/docs/ListPaymentsResponseV3.md +12 -11
  97. data/docs/ListPaymentsResponseV3Page.md +16 -15
  98. data/docs/ListPaymentsResponseV4.md +12 -11
  99. data/docs/ListSourceAccountResponse.md +12 -11
  100. data/docs/ListSourceAccountResponseLinks.md +10 -9
  101. data/docs/ListSourceAccountResponsePage.md +16 -15
  102. data/docs/ListSourceAccountResponseV2.md +12 -11
  103. data/docs/ListSourceAccountResponseV2Links.md +10 -9
  104. data/docs/ListSourceAccountResponseV3.md +12 -11
  105. data/docs/ListSourceAccountResponseV3Links.md +10 -9
  106. data/docs/LocalisationDetails.md +20 -0
  107. data/docs/LoginApi.md +109 -41
  108. data/docs/MFADetails.md +10 -9
  109. data/docs/MFAType.md +4 -5
  110. data/docs/Name.md +14 -13
  111. data/docs/Name2.md +24 -0
  112. data/docs/Notification.md +26 -0
  113. data/docs/Notifications.md +8 -7
  114. data/docs/Notifications2.md +8 -7
  115. data/docs/OfacStatus.md +4 -5
  116. data/docs/OnboardedStatus.md +4 -5
  117. data/docs/OnboardedStatus2.md +4 -5
  118. data/docs/OnboardingStatusChanged.md +26 -0
  119. data/docs/PageForResponse.md +16 -15
  120. data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
  121. data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
  122. data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
  123. data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
  124. data/docs/PagedPayeeResponse.md +14 -13
  125. data/docs/PagedPayeeResponse2.md +14 -13
  126. data/docs/PagedPayeeResponseLinks.md +10 -9
  127. data/docs/PagedPayeeResponsePage.md +16 -15
  128. data/docs/PagedPayeeResponseSummary.md +16 -15
  129. data/docs/PagedPaymentsResponseV3.md +12 -11
  130. data/docs/PagedUserResponse.md +12 -11
  131. data/docs/PagedUserResponseLinks.md +10 -9
  132. data/docs/PagedUserResponsePage.md +16 -15
  133. data/docs/PasswordRequest.md +8 -7
  134. data/docs/PayableIssue.md +20 -0
  135. data/docs/PayableIssue2.md +20 -0
  136. data/docs/PayableStatusChanged.md +26 -0
  137. data/docs/PayeeAddress.md +22 -21
  138. data/docs/PayeeAddress2.md +22 -21
  139. data/docs/PayeeDelta.md +20 -19
  140. data/docs/PayeeDelta2.md +20 -19
  141. data/docs/PayeeDeltaResponse.md +12 -11
  142. data/docs/PayeeDeltaResponse2.md +12 -11
  143. data/docs/PayeeDeltaResponse2Links.md +10 -9
  144. data/docs/PayeeDeltaResponseLinks.md +10 -9
  145. data/docs/PayeeDeltaResponsePage.md +16 -15
  146. data/docs/PayeeDetailResponse.md +64 -63
  147. data/docs/PayeeDetailResponse2.md +64 -63
  148. data/docs/PayeeDetailsChanged.md +26 -0
  149. data/docs/PayeeEvent.md +26 -0
  150. data/docs/PayeeEventAllOf.md +20 -0
  151. data/docs/PayeeEventAllOfReasons.md +20 -0
  152. data/docs/PayeeInvitationApi.md +216 -359
  153. data/docs/PayeeInvitationStatusResponse.md +12 -11
  154. data/docs/PayeeInvitationStatusResponse2.md +12 -11
  155. data/docs/PayeePayorRef.md +20 -11
  156. data/docs/PayeePayorRefV3.md +20 -15
  157. data/docs/PayeeType.md +4 -5
  158. data/docs/PayeeUserSelfUpdateRequest.md +18 -17
  159. data/docs/PayeesApi.md +346 -499
  160. data/docs/PaymentAuditCurrency.md +15 -0
  161. data/docs/PaymentAuditCurrencyV3.md +4 -5
  162. data/docs/PaymentAuditServiceApi.md +242 -631
  163. data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
  164. data/docs/PaymentChannelCountry.md +10 -9
  165. data/docs/PaymentChannelRule.md +20 -19
  166. data/docs/PaymentChannelRulesResponse.md +8 -7
  167. data/docs/PaymentDelta.md +22 -21
  168. data/docs/PaymentDeltaResponse.md +12 -11
  169. data/docs/PaymentDeltaResponseV1.md +22 -0
  170. data/docs/PaymentDeltaV1.md +32 -0
  171. data/docs/PaymentEvent.md +28 -0
  172. data/docs/PaymentEventAllOf.md +22 -0
  173. data/docs/PaymentEventResponse.md +40 -0
  174. data/docs/PaymentEventResponseV3.md +30 -29
  175. data/docs/PaymentInstructionV3.md +24 -19
  176. data/docs/PaymentRails.md +4 -5
  177. data/docs/PaymentRejectedOrReturned.md +34 -0
  178. data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
  179. data/docs/PaymentResponseV3.md +78 -77
  180. data/docs/PaymentResponseV4.md +96 -85
  181. data/docs/PaymentResponseV4Payout.md +12 -11
  182. data/docs/PaymentStatusChanged.md +30 -0
  183. data/docs/PaymentStatusChangedAllOf.md +18 -0
  184. data/docs/PaymentV3.md +32 -27
  185. data/docs/PayorAddress.md +22 -21
  186. data/docs/PayorAddressV2.md +22 -21
  187. data/docs/PayorAmlTransaction.md +70 -0
  188. data/docs/PayorAmlTransactionV3.md +56 -61
  189. data/docs/PayorBrandingResponse.md +16 -15
  190. data/docs/PayorCreateApiKeyRequest.md +12 -11
  191. data/docs/PayorCreateApiKeyResponse.md +10 -9
  192. data/docs/PayorCreateApplicationRequest.md +10 -9
  193. data/docs/PayorEmailOptOutRequest.md +8 -7
  194. data/docs/PayorLinksResponse.md +10 -9
  195. data/docs/PayorLinksResponseLinks.md +14 -13
  196. data/docs/PayorLinksResponsePayors.md +14 -13
  197. data/docs/PayorV1.md +50 -49
  198. data/docs/PayorV2.md +52 -49
  199. data/docs/PayorsApi.md +236 -101
  200. data/docs/PayorsPrivateApi.md +29 -13
  201. data/docs/PayoutCompanyV3.md +8 -7
  202. data/docs/PayoutIndividualV3.md +8 -7
  203. data/docs/PayoutNameV3.md +10 -9
  204. data/docs/PayoutPayeeV3.md +12 -11
  205. data/docs/PayoutPayor.md +26 -0
  206. data/docs/PayoutPayorIds.md +22 -0
  207. data/docs/PayoutPrincipal.md +20 -0
  208. data/docs/PayoutServiceApi.md +208 -88
  209. data/docs/PayoutStatus.md +15 -0
  210. data/docs/PayoutStatusV3.md +4 -5
  211. data/docs/PayoutSummaryAudit.md +48 -0
  212. data/docs/PayoutSummaryAuditV3.md +30 -29
  213. data/docs/PayoutSummaryResponseV3.md +26 -25
  214. data/docs/PayoutType.md +15 -0
  215. data/docs/Ping.md +22 -0
  216. data/docs/QueryBatchResponse.md +14 -13
  217. data/docs/QueryBatchResponse2.md +14 -13
  218. data/docs/QuoteFxSummaryV3.md +28 -27
  219. data/docs/QuoteResponseV3.md +8 -7
  220. data/docs/RegionV2.md +10 -9
  221. data/docs/RegisterSmsRequest.md +8 -7
  222. data/docs/RejectedPaymentV3.md +28 -23
  223. data/docs/ResendTokenRequest.md +10 -9
  224. data/docs/ResetPasswordRequest.md +8 -7
  225. data/docs/Role.md +8 -7
  226. data/docs/RoleUpdateRequest.md +10 -9
  227. data/docs/SelfMFATypeUnregisterRequest.md +8 -7
  228. data/docs/SelfUpdatePasswordRequest.md +10 -9
  229. data/docs/SetNotificationsRequest.md +8 -7
  230. data/docs/SourceAccountResponse.md +34 -33
  231. data/docs/SourceAccountResponseV2.md +38 -37
  232. data/docs/SourceAccountResponseV3.md +42 -37
  233. data/docs/SourceAccountSummary.md +22 -0
  234. data/docs/SourceAccountSummaryV3.md +12 -11
  235. data/docs/SourceAccountType.md +4 -5
  236. data/docs/SourceAccountV3.md +14 -13
  237. data/docs/SourceEvent.md +22 -0
  238. data/docs/SupportedCountriesResponse.md +8 -7
  239. data/docs/SupportedCountriesResponseV2.md +8 -7
  240. data/docs/SupportedCountry.md +10 -9
  241. data/docs/SupportedCountryV2.md +12 -11
  242. data/docs/SupportedCurrencyResponseV2.md +8 -7
  243. data/docs/SupportedCurrencyV2.md +10 -9
  244. data/docs/TokensApi.md +31 -15
  245. data/docs/TransferRequest.md +12 -11
  246. data/docs/TransferRequest2.md +12 -11
  247. data/docs/TransmissionType.md +4 -5
  248. data/docs/TransmissionTypes.md +12 -11
  249. data/docs/TransmissionTypes2.md +12 -11
  250. data/docs/UnregisterMFARequest.md +10 -9
  251. data/docs/UpdatePayeeDetailsRequest.md +20 -19
  252. data/docs/UpdatePayeeDetailsRequest2.md +20 -19
  253. data/docs/UpdateRemoteIdRequest.md +10 -9
  254. data/docs/UpdateRemoteIdRequest2.md +20 -0
  255. data/docs/UpdateWebhookRequest.md +14 -11
  256. data/docs/UserDetailsUpdateRequest.md +22 -21
  257. data/docs/UserInfo.md +12 -11
  258. data/docs/UserResponse.md +34 -33
  259. data/docs/UserStatus.md +4 -5
  260. data/docs/UserType.md +4 -5
  261. data/docs/UserType2.md +4 -5
  262. data/docs/UsersApi.md +478 -189
  263. data/docs/ValidatePasswordResponse.md +14 -13
  264. data/docs/WatchlistStatus.md +4 -5
  265. data/docs/WatchlistStatus2.md +4 -5
  266. data/docs/WebhookResponse.md +18 -15
  267. data/docs/WebhooksApi.md +109 -92
  268. data/docs/WebhooksResponse.md +12 -11
  269. data/docs/WithdrawPaymentRequest.md +8 -7
  270. data/lib/velopayments.rb +50 -48
  271. data/lib/velopayments/api/countries_api.rb +2 -2
  272. data/lib/velopayments/api/currencies_api.rb +2 -2
  273. data/lib/velopayments/api/funding_manager_api.rb +5 -2
  274. data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
  275. data/lib/velopayments/api/login_api.rb +2 -2
  276. data/lib/velopayments/api/payee_invitation_api.rb +25 -358
  277. data/lib/velopayments/api/payees_api.rb +28 -468
  278. data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
  279. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
  280. data/lib/velopayments/api/payors_api.rb +2 -2
  281. data/lib/velopayments/api/payors_private_api.rb +2 -2
  282. data/lib/velopayments/api/payout_service_api.rb +9 -2
  283. data/lib/velopayments/api/tokens_api.rb +2 -2
  284. data/lib/velopayments/api/users_api.rb +2 -2
  285. data/lib/velopayments/api/webhooks_api.rb +2 -61
  286. data/lib/velopayments/api_client.rb +6 -5
  287. data/lib/velopayments/api_error.rb +2 -2
  288. data/lib/velopayments/configuration.rb +9 -7
  289. data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
  290. data/lib/velopayments/models/access_token_response.rb +12 -4
  291. data/lib/velopayments/models/access_token_validation_request.rb +12 -4
  292. data/lib/velopayments/models/auth_response.rb +12 -4
  293. data/lib/velopayments/models/auto_top_up_config.rb +12 -4
  294. data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
  295. data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
  296. data/lib/velopayments/models/challenge.rb +12 -4
  297. data/lib/velopayments/models/challenge2.rb +12 -4
  298. data/lib/velopayments/models/company.rb +12 -4
  299. data/lib/velopayments/models/company2.rb +12 -4
  300. data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
  301. data/lib/velopayments/models/create_individual.rb +13 -5
  302. data/lib/velopayments/models/create_individual2.rb +13 -5
  303. data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
  304. data/lib/velopayments/models/create_payee.rb +16 -7
  305. data/lib/velopayments/models/create_payee2.rb +15 -6
  306. data/lib/velopayments/models/create_payee_address.rb +45 -21
  307. data/lib/velopayments/models/create_payee_address2.rb +12 -4
  308. data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
  309. data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
  310. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
  311. data/lib/velopayments/models/create_payees_request.rb +12 -4
  312. data/lib/velopayments/models/create_payees_request2.rb +12 -4
  313. data/lib/velopayments/models/create_payment_channel.rb +12 -4
  314. data/lib/velopayments/models/create_payment_channel2.rb +12 -4
  315. data/lib/velopayments/models/create_payor_link_request.rb +12 -4
  316. data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
  317. data/lib/velopayments/models/create_webhook_request.rb +31 -8
  318. data/lib/velopayments/models/debit_event.rb +278 -0
  319. data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
  320. data/lib/velopayments/models/debit_status_changed.rb +293 -0
  321. data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
  322. data/lib/velopayments/models/error.rb +46 -10
  323. data/lib/velopayments/models/error_data.rb +229 -0
  324. data/lib/velopayments/models/error_response.rb +41 -10
  325. data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
  326. data/lib/velopayments/models/failed_payee2.rb +313 -0
  327. data/lib/velopayments/models/failed_submission.rb +13 -5
  328. data/lib/velopayments/models/failed_submission2.rb +13 -5
  329. data/lib/velopayments/models/funding_account_response.rb +12 -4
  330. data/lib/velopayments/models/funding_account_response2.rb +12 -4
  331. data/lib/velopayments/models/funding_account_type.rb +2 -2
  332. data/lib/velopayments/models/funding_audit.rb +12 -4
  333. data/lib/velopayments/models/funding_event.rb +12 -4
  334. data/lib/velopayments/models/funding_event_type.rb +2 -2
  335. data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
  336. data/lib/velopayments/models/funding_request_v1.rb +12 -4
  337. data/lib/velopayments/models/funding_request_v2.rb +12 -4
  338. data/lib/velopayments/models/funding_request_v3.rb +12 -4
  339. data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
  340. data/lib/velopayments/models/fx_summary_v3.rb +12 -4
  341. data/lib/velopayments/models/get_fundings_response.rb +12 -4
  342. data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
  343. data/lib/velopayments/models/get_payee_list_response.rb +14 -5
  344. data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
  345. data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
  346. data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
  347. data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
  348. data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
  349. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
  350. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
  351. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
  352. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
  353. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
  354. data/lib/velopayments/models/get_payout_statistics.rb +12 -4
  355. data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
  356. data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
  357. data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
  358. data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
  359. data/lib/velopayments/models/individual.rb +13 -5
  360. data/lib/velopayments/models/individual2.rb +13 -5
  361. data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
  362. data/lib/velopayments/models/inline_response400.rb +43 -10
  363. data/lib/velopayments/models/inline_response401.rb +43 -10
  364. data/lib/velopayments/models/inline_response403.rb +43 -10
  365. data/lib/velopayments/models/inline_response404.rb +43 -10
  366. data/lib/velopayments/models/inline_response409.rb +43 -10
  367. data/lib/velopayments/models/inline_response412.rb +43 -10
  368. data/lib/velopayments/models/invitation_status.rb +2 -2
  369. data/lib/velopayments/models/invitation_status2.rb +2 -2
  370. data/lib/velopayments/models/invite_payee_request.rb +12 -4
  371. data/lib/velopayments/models/invite_payee_request2.rb +12 -4
  372. data/lib/velopayments/models/invite_user_request.rb +12 -4
  373. data/lib/velopayments/models/kyc_state.rb +2 -2
  374. data/lib/velopayments/models/link_for_response.rb +12 -4
  375. data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
  376. data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
  377. data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
  378. data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
  379. data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
  380. data/lib/velopayments/models/list_source_account_response.rb +12 -4
  381. data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
  382. data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
  383. data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
  384. data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
  385. data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
  386. data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
  387. data/lib/velopayments/models/localisation_details.rb +231 -0
  388. data/lib/velopayments/models/mfa_details.rb +12 -4
  389. data/lib/velopayments/models/mfa_type.rb +2 -2
  390. data/lib/velopayments/models/name.rb +12 -4
  391. data/lib/velopayments/models/name2.rb +341 -0
  392. data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
  393. data/lib/velopayments/models/notifications.rb +12 -4
  394. data/lib/velopayments/models/notifications2.rb +12 -4
  395. data/lib/velopayments/models/ofac_status.rb +2 -2
  396. data/lib/velopayments/models/onboarded_status.rb +2 -2
  397. data/lib/velopayments/models/onboarded_status2.rb +2 -2
  398. data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
  399. data/lib/velopayments/models/page_for_response.rb +12 -4
  400. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
  401. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
  402. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
  403. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
  404. data/lib/velopayments/models/paged_payee_response.rb +13 -5
  405. data/lib/velopayments/models/paged_payee_response2.rb +14 -6
  406. data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
  407. data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
  408. data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
  409. data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
  410. data/lib/velopayments/models/paged_user_response.rb +12 -4
  411. data/lib/velopayments/models/paged_user_response_links.rb +12 -4
  412. data/lib/velopayments/models/paged_user_response_page.rb +12 -4
  413. data/lib/velopayments/models/password_request.rb +12 -4
  414. data/lib/velopayments/models/payable_issue.rb +238 -0
  415. data/lib/velopayments/models/payable_issue2.rb +238 -0
  416. data/lib/velopayments/models/payable_status_changed.rb +289 -0
  417. data/lib/velopayments/models/payee_address.rb +12 -4
  418. data/lib/velopayments/models/payee_address2.rb +12 -4
  419. data/lib/velopayments/models/payee_delta.rb +13 -5
  420. data/lib/velopayments/models/payee_delta2.rb +12 -4
  421. data/lib/velopayments/models/payee_delta_response.rb +12 -4
  422. data/lib/velopayments/models/payee_delta_response2.rb +12 -4
  423. data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
  424. data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
  425. data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
  426. data/lib/velopayments/models/payee_detail_response.rb +18 -9
  427. data/lib/velopayments/models/payee_detail_response2.rb +16 -7
  428. data/lib/velopayments/models/payee_details_changed.rb +289 -0
  429. data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
  430. data/lib/velopayments/models/payee_event_all_of.rb +236 -0
  431. data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
  432. data/lib/velopayments/models/payee_invitation_status_response.rb +12 -4
  433. data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
  434. data/lib/velopayments/models/payee_payor_ref.rb +58 -8
  435. data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
  436. data/lib/velopayments/models/payee_type.rb +2 -2
  437. data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
  438. data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
  439. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  440. data/lib/velopayments/models/payment_channel_country.rb +12 -4
  441. data/lib/velopayments/models/payment_channel_rule.rb +12 -4
  442. data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
  443. data/lib/velopayments/models/payment_delta.rb +12 -4
  444. data/lib/velopayments/models/payment_delta_response.rb +12 -4
  445. data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
  446. data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
  447. data/lib/velopayments/models/payment_event.rb +297 -0
  448. data/lib/velopayments/models/payment_event_all_of.rb +243 -0
  449. data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
  450. data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
  451. data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
  452. data/lib/velopayments/models/payment_rails.rb +2 -2
  453. data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
  454. data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
  455. data/lib/velopayments/models/payment_response_v3.rb +12 -4
  456. data/lib/velopayments/models/payment_response_v4.rb +65 -8
  457. data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
  458. data/lib/velopayments/models/payment_status_changed.rb +312 -0
  459. data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
  460. data/lib/velopayments/models/payment_v3.rb +34 -8
  461. data/lib/velopayments/models/payor_address.rb +12 -4
  462. data/lib/velopayments/models/payor_address_v2.rb +12 -4
  463. data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
  464. data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
  465. data/lib/velopayments/models/payor_branding_response.rb +12 -4
  466. data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
  467. data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
  468. data/lib/velopayments/models/payor_create_application_request.rb +12 -4
  469. data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
  470. data/lib/velopayments/models/payor_links_response.rb +12 -4
  471. data/lib/velopayments/models/payor_links_response_links.rb +12 -4
  472. data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
  473. data/lib/velopayments/models/payor_v1.rb +12 -4
  474. data/lib/velopayments/models/payor_v2.rb +28 -8
  475. data/lib/velopayments/models/payout_company_v3.rb +12 -4
  476. data/lib/velopayments/models/payout_individual_v3.rb +12 -4
  477. data/lib/velopayments/models/payout_name_v3.rb +12 -4
  478. data/lib/velopayments/models/payout_payee_v3.rb +12 -4
  479. data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
  480. data/lib/velopayments/models/payout_payor_ids.rb +255 -0
  481. data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
  482. data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
  483. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  484. data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
  485. data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
  486. data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
  487. data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
  488. data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
  489. data/lib/velopayments/models/query_batch_response.rb +12 -4
  490. data/lib/velopayments/models/query_batch_response2.rb +12 -4
  491. data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
  492. data/lib/velopayments/models/quote_response_v3.rb +12 -4
  493. data/lib/velopayments/models/region_v2.rb +12 -4
  494. data/lib/velopayments/models/register_sms_request.rb +12 -4
  495. data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
  496. data/lib/velopayments/models/resend_token_request.rb +12 -4
  497. data/lib/velopayments/models/reset_password_request.rb +12 -4
  498. data/lib/velopayments/models/role.rb +12 -4
  499. data/lib/velopayments/models/role_update_request.rb +12 -4
  500. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
  501. data/lib/velopayments/models/self_update_password_request.rb +12 -4
  502. data/lib/velopayments/models/set_notifications_request.rb +12 -4
  503. data/lib/velopayments/models/source_account_response.rb +12 -4
  504. data/lib/velopayments/models/source_account_response_v2.rb +12 -4
  505. data/lib/velopayments/models/source_account_response_v3.rb +40 -12
  506. data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
  507. data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
  508. data/lib/velopayments/models/source_account_type.rb +2 -2
  509. data/lib/velopayments/models/source_account_v3.rb +12 -4
  510. data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
  511. data/lib/velopayments/models/supported_countries_response.rb +12 -4
  512. data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
  513. data/lib/velopayments/models/supported_country.rb +12 -4
  514. data/lib/velopayments/models/supported_country_v2.rb +12 -4
  515. data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
  516. data/lib/velopayments/models/supported_currency_v2.rb +12 -4
  517. data/lib/velopayments/models/transfer_request.rb +12 -4
  518. data/lib/velopayments/models/transfer_request2.rb +12 -4
  519. data/lib/velopayments/models/transmission_type.rb +2 -2
  520. data/lib/velopayments/models/transmission_types.rb +12 -4
  521. data/lib/velopayments/models/transmission_types2.rb +12 -4
  522. data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
  523. data/lib/velopayments/models/update_payee_details_request.rb +19 -10
  524. data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
  525. data/lib/velopayments/models/update_remote_id_request.rb +12 -4
  526. data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
  527. data/lib/velopayments/models/update_webhook_request.rb +32 -8
  528. data/lib/velopayments/models/user_details_update_request.rb +12 -4
  529. data/lib/velopayments/models/user_info.rb +12 -4
  530. data/lib/velopayments/models/user_response.rb +27 -4
  531. data/lib/velopayments/models/user_status.rb +2 -2
  532. data/lib/velopayments/models/user_type.rb +2 -2
  533. data/lib/velopayments/models/user_type2.rb +2 -2
  534. data/lib/velopayments/models/validate_password_response.rb +12 -4
  535. data/lib/velopayments/models/watchlist_status.rb +2 -2
  536. data/lib/velopayments/models/watchlist_status2.rb +2 -2
  537. data/lib/velopayments/models/webhook_response.rb +27 -8
  538. data/lib/velopayments/models/webhooks_response.rb +12 -4
  539. data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
  540. data/lib/velopayments/version.rb +3 -3
  541. data/oa3-config.json +1 -1
  542. data/spec/api/countries_api_spec.rb +2 -2
  543. data/spec/api/currencies_api_spec.rb +2 -2
  544. data/spec/api/funding_manager_api_spec.rb +3 -2
  545. data/spec/api/funding_manager_private_api_spec.rb +14 -2
  546. data/spec/api/login_api_spec.rb +2 -2
  547. data/spec/api/payee_invitation_api_spec.rb +10 -75
  548. data/spec/api/payees_api_spec.rb +11 -99
  549. data/spec/api/payment_audit_service_api_spec.rb +9 -147
  550. data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
  551. data/spec/api/payors_api_spec.rb +2 -2
  552. data/spec/api/payors_private_api_spec.rb +2 -2
  553. data/spec/api/payout_service_api_spec.rb +3 -2
  554. data/spec/api/tokens_api_spec.rb +2 -2
  555. data/spec/api/users_api_spec.rb +2 -2
  556. data/spec/api/webhooks_api_spec.rb +2 -12
  557. data/spec/api_client_spec.rb +2 -2
  558. data/spec/configuration_spec.rb +2 -2
  559. data/spec/models/accepted_payment_v3_spec.rb +17 -12
  560. data/spec/models/access_token_response_spec.rb +5 -12
  561. data/spec/models/access_token_validation_request_spec.rb +5 -12
  562. data/spec/models/auth_response_spec.rb +5 -12
  563. data/spec/models/auto_top_up_config2_spec.rb +5 -12
  564. data/spec/models/auto_top_up_config_spec.rb +5 -12
  565. data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
  566. data/spec/models/challenge2_spec.rb +5 -12
  567. data/spec/models/challenge_spec.rb +5 -12
  568. data/spec/models/company2_spec.rb +5 -12
  569. data/spec/models/company_spec.rb +5 -12
  570. data/spec/models/create_funding_account_request_v2_spec.rb +6 -13
  571. data/spec/models/create_individual2_spec.rb +5 -12
  572. data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
  573. data/spec/models/create_individual_spec.rb +5 -12
  574. data/spec/models/create_payee2_spec.rb +5 -12
  575. data/spec/models/create_payee_address2_spec.rb +6 -13
  576. data/spec/models/create_payee_address_spec.rb +9 -12
  577. data/spec/models/create_payee_spec.rb +5 -12
  578. data/spec/models/create_payees_csv_response2_spec.rb +5 -12
  579. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
  580. data/spec/models/create_payees_csv_response_spec.rb +5 -12
  581. data/spec/models/create_payees_request2_spec.rb +5 -12
  582. data/spec/models/create_payees_request_spec.rb +5 -12
  583. data/spec/models/create_payment_channel2_spec.rb +7 -14
  584. data/spec/models/create_payment_channel_spec.rb +7 -14
  585. data/spec/models/create_payor_link_request_spec.rb +6 -13
  586. data/spec/models/create_payout_request_v3_spec.rb +5 -18
  587. data/spec/models/create_webhook_request_spec.rb +11 -12
  588. data/spec/models/debit_event_all_of_spec.rb +34 -0
  589. data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
  590. data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
  591. data/spec/models/debit_status_changed_spec.rb +58 -0
  592. data/spec/models/{ping_response_spec.rb → error_data_spec.rb} +10 -17
  593. data/spec/models/error_response_spec.rb +11 -12
  594. data/spec/models/error_spec.rb +24 -13
  595. data/spec/models/failed_payee2_spec.rb +94 -0
  596. data/spec/models/failed_payee_spec.rb +94 -0
  597. data/spec/models/failed_submission2_spec.rb +5 -12
  598. data/spec/models/failed_submission_spec.rb +5 -12
  599. data/spec/models/funding_account_response2_spec.rb +5 -12
  600. data/spec/models/funding_account_response_spec.rb +5 -12
  601. data/spec/models/funding_account_type_spec.rb +5 -12
  602. data/spec/models/funding_audit_spec.rb +8 -15
  603. data/spec/models/funding_event_spec.rb +5 -12
  604. data/spec/models/funding_event_type_spec.rb +5 -12
  605. data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
  606. data/spec/models/funding_request_v1_spec.rb +5 -12
  607. data/spec/models/funding_request_v2_spec.rb +5 -12
  608. data/spec/models/funding_request_v3_spec.rb +5 -12
  609. data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
  610. data/spec/models/fx_summary_v3_spec.rb +7 -14
  611. data/spec/models/get_fundings_response_links_spec.rb +5 -12
  612. data/spec/models/get_fundings_response_spec.rb +5 -12
  613. data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
  614. data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
  615. data/spec/models/get_payee_list_response_company_spec.rb +5 -12
  616. data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
  617. data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
  618. data/spec/models/get_payee_list_response_spec.rb +5 -12
  619. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
  620. data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
  621. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
  622. data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
  623. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +5 -16
  624. data/spec/models/get_payout_statistics_spec.rb +5 -12
  625. data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
  626. data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
  627. data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
  628. data/spec/models/get_payouts_response_v3_spec.rb +5 -12
  629. data/spec/models/individual2_spec.rb +5 -12
  630. data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
  631. data/spec/models/individual_spec.rb +5 -12
  632. data/spec/models/inline_response400_spec.rb +11 -12
  633. data/spec/models/inline_response401_spec.rb +11 -12
  634. data/spec/models/inline_response403_spec.rb +11 -12
  635. data/spec/models/inline_response404_spec.rb +11 -12
  636. data/spec/models/inline_response409_spec.rb +11 -12
  637. data/spec/models/inline_response412_spec.rb +11 -12
  638. data/spec/models/invitation_status2_spec.rb +5 -12
  639. data/spec/models/invitation_status_spec.rb +5 -12
  640. data/spec/models/invite_payee_request2_spec.rb +5 -12
  641. data/spec/models/invite_payee_request_spec.rb +5 -12
  642. data/spec/models/invite_user_request_spec.rb +6 -13
  643. data/spec/models/kyc_state_spec.rb +5 -12
  644. data/spec/models/link_for_response_spec.rb +5 -12
  645. data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
  646. data/spec/models/list_funding_accounts_response_spec.rb +5 -12
  647. data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
  648. data/spec/models/list_payments_response_v3_spec.rb +5 -12
  649. data/spec/models/list_payments_response_v4_spec.rb +5 -12
  650. data/spec/models/list_source_account_response_links_spec.rb +5 -12
  651. data/spec/models/list_source_account_response_page_spec.rb +5 -12
  652. data/spec/models/list_source_account_response_spec.rb +5 -12
  653. data/spec/models/list_source_account_response_v2_links_spec.rb +5 -12
  654. data/spec/models/list_source_account_response_v2_spec.rb +5 -12
  655. data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
  656. data/spec/models/list_source_account_response_v3_spec.rb +5 -12
  657. data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
  658. data/spec/models/mfa_details_spec.rb +5 -12
  659. data/spec/models/mfa_type_spec.rb +5 -12
  660. data/spec/models/name2_spec.rb +52 -0
  661. data/spec/models/name_spec.rb +5 -12
  662. data/spec/models/notification_spec.rb +58 -0
  663. data/spec/models/notifications2_spec.rb +5 -12
  664. data/spec/models/notifications_spec.rb +5 -12
  665. data/spec/models/ofac_status_spec.rb +5 -12
  666. data/spec/models/onboarded_status2_spec.rb +5 -12
  667. data/spec/models/onboarded_status_spec.rb +5 -12
  668. data/spec/models/{payee_payor_ref2_spec.rb → onboarding_status_changed_spec.rb} +13 -20
  669. data/spec/models/page_for_response_spec.rb +5 -12
  670. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
  671. data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
  672. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
  673. data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
  674. data/spec/models/paged_payee_response2_spec.rb +5 -12
  675. data/spec/models/paged_payee_response_links_spec.rb +5 -12
  676. data/spec/models/paged_payee_response_page_spec.rb +5 -12
  677. data/spec/models/paged_payee_response_spec.rb +5 -12
  678. data/spec/models/paged_payee_response_summary_spec.rb +6 -13
  679. data/spec/models/paged_payments_response_v3_spec.rb +5 -12
  680. data/spec/models/paged_user_response_links_spec.rb +5 -12
  681. data/spec/models/paged_user_response_page_spec.rb +5 -12
  682. data/spec/models/paged_user_response_spec.rb +5 -12
  683. data/spec/models/password_request_spec.rb +5 -12
  684. data/spec/models/payable_issue2_spec.rb +40 -0
  685. data/spec/models/payable_issue_spec.rb +40 -0
  686. data/spec/models/payable_status_changed_spec.rb +58 -0
  687. data/spec/models/payee_address2_spec.rb +5 -12
  688. data/spec/models/payee_address_spec.rb +5 -12
  689. data/spec/models/payee_delta2_spec.rb +5 -12
  690. data/spec/models/payee_delta_response2_links_spec.rb +5 -12
  691. data/spec/models/payee_delta_response2_spec.rb +5 -12
  692. data/spec/models/payee_delta_response_links_spec.rb +5 -12
  693. data/spec/models/payee_delta_response_page_spec.rb +5 -12
  694. data/spec/models/payee_delta_response_spec.rb +5 -12
  695. data/spec/models/payee_delta_spec.rb +5 -12
  696. data/spec/models/payee_detail_response2_spec.rb +5 -12
  697. data/spec/models/payee_detail_response_spec.rb +5 -12
  698. data/spec/models/payee_details_changed_spec.rb +58 -0
  699. data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
  700. data/spec/models/payee_event_all_of_spec.rb +40 -0
  701. data/spec/models/{inline_response401_errors_spec.rb → payee_event_spec.rb} +17 -18
  702. data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
  703. data/spec/models/payee_invitation_status_response_spec.rb +6 -13
  704. data/spec/models/payee_payor_ref_spec.rb +29 -12
  705. data/spec/models/payee_payor_ref_v3_spec.rb +17 -12
  706. data/spec/models/payee_type_spec.rb +5 -12
  707. data/spec/models/payee_user_self_update_request_spec.rb +5 -12
  708. data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
  709. data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
  710. data/spec/models/payment_channel_country_spec.rb +5 -12
  711. data/spec/models/payment_channel_rule_spec.rb +5 -12
  712. data/spec/models/payment_channel_rules_response_spec.rb +5 -12
  713. data/spec/models/payment_delta_response_spec.rb +5 -12
  714. data/spec/models/{payment_delta_response_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
  715. data/spec/models/payment_delta_spec.rb +5 -12
  716. data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
  717. data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
  718. data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
  719. data/spec/models/payment_event_response_v3_spec.rb +6 -13
  720. data/spec/models/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
  721. data/spec/models/payment_instruction_v3_spec.rb +17 -12
  722. data/spec/models/payment_rails_spec.rb +5 -12
  723. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
  724. data/spec/models/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
  725. data/spec/models/payment_response_v3_spec.rb +7 -14
  726. data/spec/models/payment_response_v4_payout_spec.rb +5 -12
  727. data/spec/models/payment_response_v4_spec.rb +37 -14
  728. data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
  729. data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
  730. data/spec/models/payment_v3_spec.rb +18 -13
  731. data/spec/models/payor_address_spec.rb +5 -12
  732. data/spec/models/payor_address_v2_spec.rb +5 -12
  733. data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
  734. data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
  735. data/spec/models/payor_branding_response_spec.rb +5 -12
  736. data/spec/models/payor_create_api_key_request_spec.rb +6 -13
  737. data/spec/models/payor_create_api_key_response_spec.rb +5 -12
  738. data/spec/models/payor_create_application_request_spec.rb +5 -12
  739. data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
  740. data/spec/models/payor_links_response_links_spec.rb +6 -13
  741. data/spec/models/payor_links_response_payors_spec.rb +6 -13
  742. data/spec/models/payor_links_response_spec.rb +5 -12
  743. data/spec/models/payor_v1_spec.rb +6 -13
  744. data/spec/models/payor_v2_spec.rb +12 -13
  745. data/spec/models/payout_company_v3_spec.rb +5 -12
  746. data/spec/models/payout_individual_v3_spec.rb +5 -12
  747. data/spec/models/payout_name_v3_spec.rb +5 -12
  748. data/spec/models/payout_payee_v3_spec.rb +5 -12
  749. data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
  750. data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
  751. data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
  752. data/spec/models/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
  753. data/spec/models/payout_status_v3_spec.rb +5 -12
  754. data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
  755. data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
  756. data/spec/models/payout_summary_response_v3_spec.rb +5 -12
  757. data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
  758. data/spec/models/ping_spec.rb +46 -0
  759. data/spec/models/query_batch_response2_spec.rb +6 -13
  760. data/spec/models/query_batch_response_spec.rb +6 -13
  761. data/spec/models/quote_fx_summary_v3_spec.rb +7 -14
  762. data/spec/models/quote_response_v3_spec.rb +5 -12
  763. data/spec/models/region_v2_spec.rb +5 -12
  764. data/spec/models/register_sms_request_spec.rb +5 -12
  765. data/spec/models/rejected_payment_v3_spec.rb +17 -12
  766. data/spec/models/resend_token_request_spec.rb +6 -13
  767. data/spec/models/reset_password_request_spec.rb +5 -12
  768. data/spec/models/role_spec.rb +5 -12
  769. data/spec/models/role_update_request_spec.rb +5 -12
  770. data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
  771. data/spec/models/self_update_password_request_spec.rb +5 -12
  772. data/spec/models/set_notifications_request_spec.rb +5 -12
  773. data/spec/models/source_account_response_spec.rb +6 -13
  774. data/spec/models/source_account_response_v2_spec.rb +6 -13
  775. data/spec/models/source_account_response_v3_spec.rb +19 -14
  776. data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
  777. data/spec/models/source_account_summary_v3_spec.rb +5 -12
  778. data/spec/models/source_account_type_spec.rb +5 -12
  779. data/spec/models/source_account_v3_spec.rb +5 -12
  780. data/spec/models/source_event_spec.rb +46 -0
  781. data/spec/models/supported_countries_response_spec.rb +5 -12
  782. data/spec/models/supported_countries_response_v2_spec.rb +5 -12
  783. data/spec/models/supported_country_spec.rb +5 -12
  784. data/spec/models/supported_country_v2_spec.rb +5 -12
  785. data/spec/models/supported_currency_response_v2_spec.rb +5 -12
  786. data/spec/models/supported_currency_v2_spec.rb +5 -12
  787. data/spec/models/transfer_request2_spec.rb +5 -12
  788. data/spec/models/transfer_request_spec.rb +5 -12
  789. data/spec/models/transmission_type_spec.rb +5 -12
  790. data/spec/models/transmission_types2_spec.rb +5 -12
  791. data/spec/models/transmission_types_spec.rb +5 -12
  792. data/spec/models/unregister_mfa_request_spec.rb +6 -13
  793. data/spec/models/update_payee_details_request2_spec.rb +5 -12
  794. data/spec/models/update_payee_details_request_spec.rb +5 -12
  795. data/spec/models/update_remote_id_request2_spec.rb +40 -0
  796. data/spec/models/update_remote_id_request_spec.rb +5 -12
  797. data/spec/models/update_webhook_request_spec.rb +11 -12
  798. data/spec/models/user_details_update_request_spec.rb +5 -12
  799. data/spec/models/user_info_spec.rb +5 -12
  800. data/spec/models/user_response_spec.rb +8 -15
  801. data/spec/models/user_status_spec.rb +5 -12
  802. data/spec/models/user_type2_spec.rb +5 -12
  803. data/spec/models/user_type_spec.rb +5 -12
  804. data/spec/models/validate_password_response_spec.rb +5 -12
  805. data/spec/models/watchlist_status2_spec.rb +5 -12
  806. data/spec/models/watchlist_status_spec.rb +5 -12
  807. data/spec/models/webhook_response_spec.rb +11 -12
  808. data/spec/models/webhooks_response_spec.rb +5 -12
  809. data/spec/models/withdraw_payment_request_spec.rb +5 -12
  810. data/spec/spec_helper.rb +2 -2
  811. data/specs/api/payee_invitation_api_spec.rb +0 -42
  812. data/specs/api/payees_api_spec.rb +0 -99
  813. data/specs/api/payment_audit_service_api_spec.rb +0 -150
  814. data/velopayments.gemspec +2 -2
  815. metadata +194 -186
  816. data/docs/CompanyResponse.md +0 -19
  817. data/docs/CompanyV1.md +0 -21
  818. data/docs/CreateIndividual2Name.md +0 -23
  819. data/docs/CreatePayeesCSVRequest.md +0 -73
  820. data/docs/CreatePayeesCSVRequest2.md +0 -73
  821. data/docs/FxSummaryV4.md +0 -35
  822. data/docs/GetPayoutsResponseV4.md +0 -21
  823. data/docs/IndividualResponse.md +0 -17
  824. data/docs/IndividualV1.md +0 -21
  825. data/docs/IndividualV1Name.md +0 -23
  826. data/docs/InlineResponse400Errors.md +0 -23
  827. data/docs/InlineResponse401Errors.md +0 -23
  828. data/docs/InlineResponse403Errors.md +0 -23
  829. data/docs/InlineResponse404Errors.md +0 -23
  830. data/docs/InlineResponse409Errors.md +0 -23
  831. data/docs/InlineResponse412Errors.md +0 -23
  832. data/docs/InvitationStatusResponse.md +0 -17
  833. data/docs/Language.md +0 -16
  834. data/docs/Language2.md +0 -16
  835. data/docs/LocationType.md +0 -16
  836. data/docs/MarketingOptIn.md +0 -19
  837. data/docs/OfacStatus2.md +0 -16
  838. data/docs/PagedPayeeResponse2Summary.md +0 -25
  839. data/docs/Payee.md +0 -55
  840. data/docs/Payee2.md +0 -57
  841. data/docs/PayeeInvitationStatus.md +0 -21
  842. data/docs/PayeePaymentChannel.md +0 -29
  843. data/docs/PayeePaymentChannel2.md +0 -29
  844. data/docs/PayeePayorRef2.md +0 -25
  845. data/docs/PayeePayorRefV2.md +0 -25
  846. data/docs/PayeeResponse.md +0 -55
  847. data/docs/PayeeResponseV2.md +0 -73
  848. data/docs/PayeeType2.md +0 -16
  849. data/docs/PaymentAuditCurrencyV4.md +0 -16
  850. data/docs/PaymentDeltaResponseV4.md +0 -21
  851. data/docs/PaymentDeltaV4.md +0 -31
  852. data/docs/PaymentEventResponseV4.md +0 -39
  853. data/docs/PayorAmlTransactionV4.md +0 -71
  854. data/docs/PayorLogoRequest.md +0 -17
  855. data/docs/PayoutPayorV4.md +0 -25
  856. data/docs/PayoutPrincipalV4.md +0 -19
  857. data/docs/PayoutStatusV4.md +0 -16
  858. data/docs/PayoutSummaryAuditV4.md +0 -47
  859. data/docs/PayoutTypeV4.md +0 -16
  860. data/docs/PingResponse.md +0 -19
  861. data/docs/SourceAccountSummaryV4.md +0 -21
  862. data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
  863. data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
  864. data/lib/velopayments/models/inline_response401_errors.rb +0 -240
  865. data/lib/velopayments/models/inline_response409_errors.rb +0 -240
  866. data/lib/velopayments/models/inline_response412_errors.rb +0 -240
  867. data/lib/velopayments/models/language.rb +0 -46
  868. data/lib/velopayments/models/language2.rb +0 -46
  869. data/lib/velopayments/models/location_type.rb +0 -40
  870. data/lib/velopayments/models/ofac_status2.rb +0 -38
  871. data/lib/velopayments/models/payee2.rb +0 -460
  872. data/lib/velopayments/models/payee_payment_channel.rb +0 -455
  873. data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
  874. data/lib/velopayments/models/payee_response.rb +0 -392
  875. data/lib/velopayments/models/payee_response_v2.rb +0 -475
  876. data/lib/velopayments/models/payor_logo_request.rb +0 -210
  877. data/spec/models/create_payees_csv_request2_spec.rb +0 -225
  878. data/spec/models/create_payees_csv_request_spec.rb +0 -221
  879. data/spec/models/inline_response403_errors_spec.rb +0 -59
  880. data/spec/models/inline_response404_errors_spec.rb +0 -59
  881. data/spec/models/inline_response409_errors_spec.rb +0 -59
  882. data/spec/models/inline_response412_errors_spec.rb +0 -59
  883. data/spec/models/location_type_spec.rb +0 -35
  884. data/spec/models/payee2_spec.rb +0 -165
  885. data/spec/models/payee_invitation_status_spec.rb +0 -57
  886. data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
  887. data/spec/models/payee_response_spec.rb +0 -155
  888. data/spec/models/payee_response_v2_spec.rb +0 -209
  889. data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
  890. data/spec/models/payout_status_v4_spec.rb +0 -35
  891. data/spec/models/payout_type_v4_spec.rb +0 -35
@@ -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.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -52,6 +52,11 @@ module VeloPayments
52
52
  }
53
53
  end
54
54
 
55
+ # Returns all the JSON keys this model knows about
56
+ def self.acceptable_attributes
57
+ attribute_map.values
58
+ end
59
+
55
60
  # Attribute type mapping.
56
61
  def self.openapi_types
57
62
  {
@@ -218,7 +223,9 @@ module VeloPayments
218
223
  end
219
224
  end
220
225
  else # model
221
- VeloPayments.const_get(type).build_from_hash(value)
226
+ # models (e.g. Pet) or oneOf
227
+ klass = VeloPayments.const_get(type)
228
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
222
229
  end
223
230
  end
224
231
 
@@ -244,7 +251,7 @@ module VeloPayments
244
251
  is_nullable = self.class.openapi_nullable.include?(attr)
245
252
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
246
253
  end
247
-
254
+
248
255
  hash[param] = _to_hash(value)
249
256
  end
250
257
  hash
@@ -269,4 +276,5 @@ module VeloPayments
269
276
  end
270
277
 
271
278
  end
279
+
272
280
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -52,6 +52,11 @@ module VeloPayments
52
52
  }
53
53
  end
54
54
 
55
+ # Returns all the JSON keys this model knows about
56
+ def self.acceptable_attributes
57
+ attribute_map.values
58
+ end
59
+
55
60
  # Attribute type mapping.
56
61
  def self.openapi_types
57
62
  {
@@ -218,7 +223,9 @@ module VeloPayments
218
223
  end
219
224
  end
220
225
  else # model
221
- VeloPayments.const_get(type).build_from_hash(value)
226
+ # models (e.g. Pet) or oneOf
227
+ klass = VeloPayments.const_get(type)
228
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
222
229
  end
223
230
  end
224
231
 
@@ -244,7 +251,7 @@ module VeloPayments
244
251
  is_nullable = self.class.openapi_nullable.include?(attr)
245
252
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
246
253
  end
247
-
254
+
248
255
  hash[param] = _to_hash(value)
249
256
  end
250
257
  hash
@@ -269,4 +276,5 @@ module VeloPayments
269
276
  end
270
277
 
271
278
  end
279
+
272
280
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -21,27 +21,52 @@ module VeloPayments
21
21
 
22
22
  attr_accessor :invitation_status
23
23
 
24
+ # The timestamp when the invitation status is updated
25
+ attr_accessor :invitation_status_timestamp
26
+
27
+ attr_accessor :payment_channel_id
28
+
29
+ # Indicates if the payee is payable for this payor
30
+ attr_accessor :payable_status
31
+
32
+ # Indicates any conditions which prevent the payee from being payable for this payor
33
+ attr_accessor :payable_issues
34
+
24
35
  # Attribute mapping from ruby-style variable name to JSON key.
25
36
  def self.attribute_map
26
37
  {
27
38
  :'payor_id' => :'payorId',
28
39
  :'remote_id' => :'remoteId',
29
- :'invitation_status' => :'invitationStatus'
40
+ :'invitation_status' => :'invitationStatus',
41
+ :'invitation_status_timestamp' => :'invitationStatusTimestamp',
42
+ :'payment_channel_id' => :'paymentChannelId',
43
+ :'payable_status' => :'payableStatus',
44
+ :'payable_issues' => :'payableIssues'
30
45
  }
31
46
  end
32
47
 
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ attribute_map.values
51
+ end
52
+
33
53
  # Attribute type mapping.
34
54
  def self.openapi_types
35
55
  {
36
56
  :'payor_id' => :'String',
37
57
  :'remote_id' => :'String',
38
- :'invitation_status' => :'String'
58
+ :'invitation_status' => :'InvitationStatus',
59
+ :'invitation_status_timestamp' => :'Time',
60
+ :'payment_channel_id' => :'String',
61
+ :'payable_status' => :'Boolean',
62
+ :'payable_issues' => :'Array<PayableIssue2>'
39
63
  }
40
64
  end
41
65
 
42
66
  # List of attributes with nullable: true
43
67
  def self.openapi_nullable
44
68
  Set.new([
69
+ :'invitation_status_timestamp',
45
70
  ])
46
71
  end
47
72
 
@@ -71,6 +96,24 @@ module VeloPayments
71
96
  if attributes.key?(:'invitation_status')
72
97
  self.invitation_status = attributes[:'invitation_status']
73
98
  end
99
+
100
+ if attributes.key?(:'invitation_status_timestamp')
101
+ self.invitation_status_timestamp = attributes[:'invitation_status_timestamp']
102
+ end
103
+
104
+ if attributes.key?(:'payment_channel_id')
105
+ self.payment_channel_id = attributes[:'payment_channel_id']
106
+ end
107
+
108
+ if attributes.key?(:'payable_status')
109
+ self.payable_status = attributes[:'payable_status']
110
+ end
111
+
112
+ if attributes.key?(:'payable_issues')
113
+ if (value = attributes[:'payable_issues']).is_a?(Array)
114
+ self.payable_issues = value
115
+ end
116
+ end
74
117
  end
75
118
 
76
119
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,7 +136,11 @@ module VeloPayments
93
136
  self.class == o.class &&
94
137
  payor_id == o.payor_id &&
95
138
  remote_id == o.remote_id &&
96
- invitation_status == o.invitation_status
139
+ invitation_status == o.invitation_status &&
140
+ invitation_status_timestamp == o.invitation_status_timestamp &&
141
+ payment_channel_id == o.payment_channel_id &&
142
+ payable_status == o.payable_status &&
143
+ payable_issues == o.payable_issues
97
144
  end
98
145
 
99
146
  # @see the `==` method
@@ -105,7 +152,7 @@ module VeloPayments
105
152
  # Calculates hash code according to all attributes.
106
153
  # @return [Integer] Hash code
107
154
  def hash
108
- [payor_id, remote_id, invitation_status].hash
155
+ [payor_id, remote_id, invitation_status, invitation_status_timestamp, payment_channel_id, payable_status, payable_issues].hash
109
156
  end
110
157
 
111
158
  # Builds the object from hash
@@ -174,7 +221,9 @@ module VeloPayments
174
221
  end
175
222
  end
176
223
  else # model
177
- VeloPayments.const_get(type).build_from_hash(value)
224
+ # models (e.g. Pet) or oneOf
225
+ klass = VeloPayments.const_get(type)
226
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
178
227
  end
179
228
  end
180
229
 
@@ -200,7 +249,7 @@ module VeloPayments
200
249
  is_nullable = self.class.openapi_nullable.include?(attr)
201
250
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
202
251
  end
203
-
252
+
204
253
  hash[param] = _to_hash(value)
205
254
  end
206
255
  hash
@@ -225,4 +274,5 @@ module VeloPayments
225
274
  end
226
275
 
227
276
  end
277
+
228
278
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -26,6 +26,12 @@ module VeloPayments
26
26
 
27
27
  attr_accessor :payment_channel_id
28
28
 
29
+ # Indicates if the payee is payable for this payor
30
+ attr_accessor :payable_status
31
+
32
+ # Indicates any conditions which prevent the payee from being payable for this payor
33
+ attr_accessor :payable_issues
34
+
29
35
  # Attribute mapping from ruby-style variable name to JSON key.
30
36
  def self.attribute_map
31
37
  {
@@ -33,10 +39,17 @@ module VeloPayments
33
39
  :'remote_id' => :'remoteId',
34
40
  :'invitation_status' => :'invitationStatus',
35
41
  :'invitation_status_timestamp' => :'invitationStatusTimestamp',
36
- :'payment_channel_id' => :'paymentChannelId'
42
+ :'payment_channel_id' => :'paymentChannelId',
43
+ :'payable_status' => :'payableStatus',
44
+ :'payable_issues' => :'payableIssues'
37
45
  }
38
46
  end
39
47
 
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ attribute_map.values
51
+ end
52
+
40
53
  # Attribute type mapping.
41
54
  def self.openapi_types
42
55
  {
@@ -44,7 +57,9 @@ module VeloPayments
44
57
  :'remote_id' => :'String',
45
58
  :'invitation_status' => :'InvitationStatus2',
46
59
  :'invitation_status_timestamp' => :'Time',
47
- :'payment_channel_id' => :'String'
60
+ :'payment_channel_id' => :'String',
61
+ :'payable_status' => :'Boolean',
62
+ :'payable_issues' => :'Array<PayableIssue>'
48
63
  }
49
64
  end
50
65
 
@@ -89,6 +104,16 @@ module VeloPayments
89
104
  if attributes.key?(:'payment_channel_id')
90
105
  self.payment_channel_id = attributes[:'payment_channel_id']
91
106
  end
107
+
108
+ if attributes.key?(:'payable_status')
109
+ self.payable_status = attributes[:'payable_status']
110
+ end
111
+
112
+ if attributes.key?(:'payable_issues')
113
+ if (value = attributes[:'payable_issues']).is_a?(Array)
114
+ self.payable_issues = value
115
+ end
116
+ end
92
117
  end
93
118
 
94
119
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -113,7 +138,9 @@ module VeloPayments
113
138
  remote_id == o.remote_id &&
114
139
  invitation_status == o.invitation_status &&
115
140
  invitation_status_timestamp == o.invitation_status_timestamp &&
116
- payment_channel_id == o.payment_channel_id
141
+ payment_channel_id == o.payment_channel_id &&
142
+ payable_status == o.payable_status &&
143
+ payable_issues == o.payable_issues
117
144
  end
118
145
 
119
146
  # @see the `==` method
@@ -125,7 +152,7 @@ module VeloPayments
125
152
  # Calculates hash code according to all attributes.
126
153
  # @return [Integer] Hash code
127
154
  def hash
128
- [payor_id, remote_id, invitation_status, invitation_status_timestamp, payment_channel_id].hash
155
+ [payor_id, remote_id, invitation_status, invitation_status_timestamp, payment_channel_id, payable_status, payable_issues].hash
129
156
  end
130
157
 
131
158
  # Builds the object from hash
@@ -194,7 +221,9 @@ module VeloPayments
194
221
  end
195
222
  end
196
223
  else # model
197
- VeloPayments.const_get(type).build_from_hash(value)
224
+ # models (e.g. Pet) or oneOf
225
+ klass = VeloPayments.const_get(type)
226
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
198
227
  end
199
228
  end
200
229
 
@@ -220,7 +249,7 @@ module VeloPayments
220
249
  is_nullable = self.class.openapi_nullable.include?(attr)
221
250
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
222
251
  end
223
-
252
+
224
253
  hash[param] = _to_hash(value)
225
254
  end
226
255
  hash
@@ -245,4 +274,5 @@ module VeloPayments
245
274
  end
246
275
 
247
276
  end
277
+
248
278
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.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.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -44,6 +44,11 @@ module VeloPayments
44
44
  }
45
45
  end
46
46
 
47
+ # Returns all the JSON keys this model knows about
48
+ def self.acceptable_attributes
49
+ attribute_map.values
50
+ end
51
+
47
52
  # Attribute type mapping.
48
53
  def self.openapi_types
49
54
  {
@@ -311,7 +316,9 @@ module VeloPayments
311
316
  end
312
317
  end
313
318
  else # model
314
- VeloPayments.const_get(type).build_from_hash(value)
319
+ # models (e.g. Pet) or oneOf
320
+ klass = VeloPayments.const_get(type)
321
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
315
322
  end
316
323
  end
317
324
 
@@ -337,7 +344,7 @@ module VeloPayments
337
344
  is_nullable = self.class.openapi_nullable.include?(attr)
338
345
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
339
346
  end
340
-
347
+
341
348
  hash[param] = _to_hash(value)
342
349
  end
343
350
  hash
@@ -362,4 +369,5 @@ module VeloPayments
362
369
  end
363
370
 
364
371
  end
372
+
365
373
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.23.78
6
+ The version of the OpenAPI document: 2.26.124
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 5.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module VeloPayments
17
- class PaymentAuditCurrencyV4
17
+ class PaymentAuditCurrency
18
18
  USD = "USD".freeze
19
19
  GBP = "GBP".freeze
20
20
  EUR = "EUR".freeze
@@ -30,8 +30,8 @@ module VeloPayments
30
30
  # @param [String] The enum value in the form of the string
31
31
  # @return [String] The enum value
32
32
  def build_from_hash(value)
33
- constantValues = PaymentAuditCurrencyV4.constants.select { |c| PaymentAuditCurrencyV4::const_get(c) == value }
34
- raise "Invalid ENUM value #{value} for class #PaymentAuditCurrencyV4" if constantValues.empty?
33
+ constantValues = PaymentAuditCurrency.constants.select { |c| PaymentAuditCurrency::const_get(c) == value }
34
+ raise "Invalid ENUM value #{value} for class #PaymentAuditCurrency" if constantValues.empty?
35
35
  value
36
36
  end
37
37
  end