velopayments 2.29.128.beta1 → 2.35.58

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 (761) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile.lock +72 -0
  3. data/Makefile +21 -37
  4. data/README.md +122 -144
  5. data/docs/AcceptedPaymentV3.md +16 -14
  6. data/docs/AuthResponse.md +1 -1
  7. data/docs/{AutoTopUpConfig.md → AutoTopUpConfigV2.md} +2 -2
  8. data/docs/{AutoTopUpConfig2.md → AutoTopUpConfigV3.md} +2 -2
  9. data/docs/{Challenge.md → ChallengeV3.md} +2 -2
  10. data/docs/{Challenge2.md → ChallengeV4.md} +2 -2
  11. data/docs/{Company2.md → CompanyV3.md} +2 -2
  12. data/docs/{Company.md → CompanyV4.md} +2 -2
  13. data/docs/CreateFundingAccountRequestV2.md +4 -4
  14. data/docs/{CreateIndividual.md → CreateIndividualV3.md} +3 -3
  15. data/docs/{CreateIndividualName.md → CreateIndividualV3Name.md} +2 -2
  16. data/docs/{CreateIndividual2.md → CreateIndividualV4.md} +3 -3
  17. data/docs/{CreatePayeeAddress.md → CreatePayeeAddressV3.md} +2 -2
  18. data/docs/{PayeeAddress2.md → CreatePayeeAddressV4.md} +3 -3
  19. data/docs/{CreatePayee.md → CreatePayeeV3.md} +8 -8
  20. data/docs/CreatePayeeV4.md +34 -0
  21. data/docs/{CreatePayeesCSVRequest.md → CreatePayeesCSVRequestV3.md} +6 -6
  22. data/docs/{CreatePayeesCSVRequest2.md → CreatePayeesCSVRequestV4.md} +6 -6
  23. data/docs/{CreatePayeesCSVResponse.md → CreatePayeesCSVResponseV3.md} +3 -3
  24. data/docs/{CreatePayeesCSVResponseRejectedCsvRows.md → CreatePayeesCSVResponseV3RejectedCsvRows.md} +2 -2
  25. data/docs/{CreatePayeesCSVResponse2.md → CreatePayeesCSVResponseV4.md} +3 -3
  26. data/docs/{CreatePayeesRequest2.md → CreatePayeesRequestV3.md} +3 -3
  27. data/docs/{CreatePayeesRequest.md → CreatePayeesRequestV4.md} +3 -3
  28. data/docs/{CreatePaymentChannel.md → CreatePaymentChannelV3.md} +6 -6
  29. data/docs/{CreatePaymentChannel2.md → CreatePaymentChannelV4.md} +6 -6
  30. data/docs/{FailedPayee.md → FailedPayeeV3.md} +8 -8
  31. data/docs/{FailedPayee2.md → FailedPayeeV4.md} +9 -9
  32. data/docs/{FailedSubmission.md → FailedSubmissionV3.md} +3 -3
  33. data/docs/{FailedSubmission2.md → FailedSubmissionV4.md} +3 -3
  34. data/docs/{FundingAccountResponse2.md → FundingAccountResponseV2.md} +4 -4
  35. data/docs/FundingApi.md +459 -0
  36. data/docs/FundingAudit.md +3 -3
  37. data/docs/FundingEvent.md +1 -1
  38. data/docs/FundingResponse.md +44 -0
  39. data/docs/FxSummary.md +6 -6
  40. data/docs/FxSummaryV3.md +4 -4
  41. data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md} +2 -2
  42. data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md} +2 -2
  43. data/docs/GetPayeeListResponseIndividualV3.md +18 -0
  44. data/docs/GetPayeeListResponseIndividualV4.md +18 -0
  45. data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md} +8 -8
  46. data/docs/{GetPayeeListResponse2.md → GetPayeeListResponseV4.md} +9 -9
  47. data/docs/GetPaymentsForPayoutResponseV3Summary.md +1 -1
  48. data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
  49. data/docs/GetPaymentsForPayoutResponseV4Summary.md +2 -2
  50. data/docs/GetPayoutsResponse.md +2 -2
  51. data/docs/{Individual.md → IndividualV3.md} +3 -3
  52. data/docs/{IndividualName.md → IndividualV3Name.md} +2 -2
  53. data/docs/{Individual2.md → IndividualV4.md} +3 -3
  54. data/docs/{InstructPayoutRequest.md → InstructPayoutRequestV3.md} +2 -2
  55. data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
  56. data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
  57. data/docs/ListFundingAccountsResponseV2.md +22 -0
  58. data/docs/{ListSourceAccountResponseLinks.md → ListFundingAccountsResponseV2Links.md} +2 -2
  59. data/docs/{ListSourceAccountResponsePage.md → ListFundingAccountsResponseV2Page.md} +2 -2
  60. data/docs/LoginApi.md +1 -1
  61. data/docs/{Name.md → NameV3.md} +2 -2
  62. data/docs/{Name2.md → NameV4.md} +2 -2
  63. data/docs/Notification.md +2 -2
  64. data/docs/NotificationSource.md +94 -0
  65. data/docs/{Notifications.md → NotificationsV2.md} +2 -2
  66. data/docs/{Notifications2.md → NotificationsV3.md} +2 -2
  67. data/docs/PagedPayeeInvitationStatusResponseV3.md +22 -0
  68. data/docs/{PagedPayeeInvitationStatusResponsePage.md → PagedPayeeInvitationStatusResponseV3Page.md} +2 -2
  69. data/docs/PagedPayeeInvitationStatusResponseV4.md +22 -0
  70. data/docs/PagedPayeeResponseV3.md +24 -0
  71. data/docs/{PagedPayeeResponseLinks.md → PagedPayeeResponseV3Links.md} +2 -2
  72. data/docs/{PagedPayeeResponsePage.md → PagedPayeeResponseV3Page.md} +2 -2
  73. data/docs/{PagedPayeeResponseSummary.md → PagedPayeeResponseV3Summary.md} +2 -2
  74. data/docs/PagedPayeeResponseV4.md +24 -0
  75. data/docs/PagedPaymentsResponseV3.md +2 -2
  76. data/docs/{PayableIssue.md → PayableIssueV3.md} +2 -2
  77. data/docs/{PayableIssue2.md → PayableIssueV4.md} +2 -2
  78. data/docs/{CreatePayeeAddress2.md → PayeeAddressV3.md} +3 -3
  79. data/docs/{PayeeAddress.md → PayeeAddressV4.md} +2 -2
  80. data/docs/PayeeDeltaResponseV3.md +22 -0
  81. data/docs/{PayeeDeltaResponseLinks.md → PayeeDeltaResponseV3Links.md} +2 -2
  82. data/docs/{PayeeDeltaResponsePage.md → PayeeDeltaResponseV3Page.md} +2 -2
  83. data/docs/PayeeDeltaResponseV4.md +22 -0
  84. data/docs/{PayeeDeltaResponse2Links.md → PayeeDeltaResponseV4Links.md} +2 -2
  85. data/docs/{PayeeDelta.md → PayeeDeltaV3.md} +3 -3
  86. data/docs/{PayeeDelta2.md → PayeeDeltaV4.md} +4 -4
  87. data/docs/{PayeeDetailResponse2.md → PayeeDetailResponseV3.md} +11 -11
  88. data/docs/{PayeeDetailResponse.md → PayeeDetailResponseV4.md} +10 -10
  89. data/docs/PayeeInvitationApi.md +111 -111
  90. data/docs/{PayeeInvitationStatusResponse.md → PayeeInvitationStatusResponseV3.md} +3 -3
  91. data/docs/{PayeeInvitationStatusResponse2.md → PayeeInvitationStatusResponseV4.md} +3 -3
  92. data/docs/PayeePayorRefV3.md +2 -2
  93. data/docs/{PayeePayorRef.md → PayeePayorRefV4.md} +4 -4
  94. data/docs/{OfacStatus.md → PayeeTypeEnum.md} +2 -2
  95. data/docs/PayeesApi.md +62 -62
  96. data/docs/PaymentAuditServiceApi.md +12 -4
  97. data/docs/PaymentChannelRule.md +3 -1
  98. data/docs/PaymentDeltaResponse.md +2 -2
  99. data/docs/PaymentDeltaResponseV1.md +2 -2
  100. data/docs/PaymentEventResponse.md +12 -6
  101. data/docs/PaymentEventResponseV3.md +3 -3
  102. data/docs/PaymentInstructionV3.md +3 -3
  103. data/docs/PaymentResponseV3.md +6 -4
  104. data/docs/PaymentResponseV4.md +13 -7
  105. data/docs/PaymentV3.md +23 -21
  106. data/docs/PayorBrandingResponse.md +3 -3
  107. data/docs/PayorCreateApiKeyRequest.md +2 -2
  108. data/docs/PayorHierarchyApi.md +83 -0
  109. data/docs/PayorLinksResponseLinks.md +1 -1
  110. data/docs/PayorLinksResponsePayors.md +1 -1
  111. data/docs/PayorV1.md +2 -2
  112. data/docs/PayorV2.md +9 -5
  113. data/docs/PayorsApi.md +41 -117
  114. data/docs/PayoutSchedule.md +2 -2
  115. data/docs/{PayoutSchedule2.md → PayoutScheduleV3.md} +4 -4
  116. data/docs/PayoutSummaryAudit.md +2 -2
  117. data/docs/PayoutSummaryAuditV3.md +1 -1
  118. data/docs/PayoutSummaryResponseV3.md +10 -10
  119. data/docs/{PayoutServiceApi.md → PayoutsApi.md} +42 -42
  120. data/docs/PostInstructFxInfo.md +24 -0
  121. data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md} +4 -4
  122. data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md} +4 -4
  123. data/docs/QuoteFxSummaryV3.md +15 -15
  124. data/docs/RejectedPaymentV3.md +16 -16
  125. data/docs/{SchedulePayoutRequest.md → SchedulePayoutRequestV3.md} +2 -2
  126. data/docs/SetNotificationsRequest2.md +18 -0
  127. data/docs/SourceAccountResponseV2.md +2 -2
  128. data/docs/SourceAccountResponseV3.md +4 -4
  129. data/docs/SourceAccountSummary.md +2 -2
  130. data/docs/SourceAccountSummaryV3.md +1 -1
  131. data/docs/SourceAccountV3.md +5 -5
  132. data/docs/SourceAccountsApi.md +603 -0
  133. data/docs/{TransferRequest.md → TransferRequestV2.md} +2 -2
  134. data/docs/{TransferRequest2.md → TransferRequestV3.md} +3 -3
  135. data/docs/{UpdatePayeeDetailsRequest.md → UpdatePayeeDetailsRequestV3.md} +7 -7
  136. data/docs/{UpdatePayeeDetailsRequest2.md → UpdatePayeeDetailsRequestV4.md} +7 -7
  137. data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
  138. data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
  139. data/docs/WebhooksResponse.md +2 -2
  140. data/lib/velopayments/api/countries_api.rb +2 -2
  141. data/lib/velopayments/api/currencies_api.rb +2 -2
  142. data/lib/velopayments/api/funding_api.rb +481 -0
  143. data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
  144. data/lib/velopayments/api/login_api.rb +5 -5
  145. data/lib/velopayments/api/payee_invitation_api.rb +112 -112
  146. data/lib/velopayments/api/payees_api.rb +80 -80
  147. data/lib/velopayments/api/payment_audit_service_api.rb +34 -18
  148. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +12 -12
  149. data/{spec/models/create_webhook_request_spec.rb → lib/velopayments/api/payor_hierarchy_api.rb} +67 -37
  150. data/lib/velopayments/api/payors_api.rb +41 -107
  151. data/lib/velopayments/api/payors_private_api.rb +2 -2
  152. data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +52 -52
  153. data/lib/velopayments/api/source_accounts_api.rb +632 -0
  154. data/lib/velopayments/api/tokens_api.rb +2 -2
  155. data/lib/velopayments/api/users_api.rb +5 -5
  156. data/lib/velopayments/api/webhooks_api.rb +4 -4
  157. data/lib/velopayments/api_client.rb +5 -3
  158. data/lib/velopayments/api_error.rb +3 -2
  159. data/lib/velopayments/configuration.rb +31 -12
  160. data/lib/velopayments/models/accepted_payment_v3.rb +193 -23
  161. data/lib/velopayments/models/access_token_response.rb +15 -19
  162. data/lib/velopayments/models/access_token_validation_request.rb +17 -19
  163. data/lib/velopayments/models/auth_response.rb +19 -19
  164. data/lib/velopayments/models/{auto_top_up_config.rb → auto_top_up_config_v2.rb} +20 -22
  165. data/lib/velopayments/models/{auto_top_up_config2.rb → auto_top_up_config_v3.rb} +20 -22
  166. data/lib/velopayments/models/category.rb +8 -5
  167. data/lib/velopayments/models/{challenge.rb → challenge_v3.rb} +22 -22
  168. data/lib/velopayments/models/{challenge2.rb → challenge_v4.rb} +22 -22
  169. data/lib/velopayments/models/{company.rb → company_v3.rb} +20 -22
  170. data/lib/velopayments/models/{company2.rb → company_v4.rb} +20 -22
  171. data/lib/velopayments/models/create_funding_account_request_v2.rb +55 -37
  172. data/lib/velopayments/models/{create_individual.rb → create_individual_v3.rb} +29 -25
  173. data/lib/velopayments/models/{individual_name.rb → create_individual_v3_name.rb} +34 -26
  174. data/lib/velopayments/models/{create_individual2.rb → create_individual_v4.rb} +29 -25
  175. data/lib/velopayments/models/{create_payee_address2.rb → create_payee_address_v3.rb} +37 -51
  176. data/lib/velopayments/models/{create_payee_address.rb → create_payee_address_v4.rb} +49 -52
  177. data/lib/velopayments/models/{create_payee.rb → create_payee_v3.rb} +33 -28
  178. data/lib/velopayments/models/{create_payee2.rb → create_payee_v4.rb} +55 -50
  179. data/lib/velopayments/models/{create_payees_csv_request.rb → create_payees_csv_request_v3.rb} +209 -81
  180. data/lib/velopayments/models/{create_payees_csv_request2.rb → create_payees_csv_request_v4.rb} +209 -81
  181. data/lib/velopayments/models/{create_payees_csv_response.rb → create_payees_csv_response_v3.rb} +19 -23
  182. data/lib/velopayments/models/{create_payees_csv_response_rejected_csv_rows.rb → create_payees_csv_response_v3_rejected_csv_rows.rb} +18 -22
  183. data/lib/velopayments/models/{create_payees_csv_response2.rb → create_payees_csv_response_v4.rb} +19 -23
  184. data/lib/velopayments/models/{create_payees_request.rb → create_payees_request_v3.rb} +23 -23
  185. data/lib/velopayments/models/{create_payees_request2.rb → create_payees_request_v4.rb} +23 -23
  186. data/lib/velopayments/models/{create_payment_channel.rb → create_payment_channel_v3.rb} +104 -67
  187. data/lib/velopayments/models/{create_payment_channel2.rb → create_payment_channel_v4.rb} +104 -67
  188. data/lib/velopayments/models/create_payor_link_request.rb +21 -19
  189. data/lib/velopayments/models/create_payout_request_v3.rb +22 -20
  190. data/lib/velopayments/models/create_webhook_request.rb +28 -22
  191. data/lib/velopayments/models/debit_event.rb +23 -19
  192. data/lib/velopayments/models/debit_event_all_of.rb +17 -19
  193. data/lib/velopayments/models/debit_status_changed.rb +25 -19
  194. data/lib/velopayments/models/debit_status_changed_all_of.rb +17 -19
  195. data/lib/velopayments/models/error.rb +15 -19
  196. data/lib/velopayments/models/error_data.rb +15 -19
  197. data/lib/velopayments/models/error_response.rb +20 -20
  198. data/lib/velopayments/models/{failed_payee.rb → failed_payee_v3.rb} +25 -28
  199. data/lib/velopayments/models/{failed_payee2.rb → failed_payee_v4.rb} +26 -29
  200. data/lib/velopayments/models/{failed_submission.rb → failed_submission_v3.rb} +19 -23
  201. data/lib/velopayments/models/{failed_submission2.rb → failed_submission_v4.rb} +19 -23
  202. data/lib/velopayments/models/{funding_account_response2.rb → funding_account_response_v2.rb} +43 -28
  203. data/lib/velopayments/models/funding_audit.rb +18 -77
  204. data/lib/velopayments/models/funding_event.rb +17 -20
  205. data/lib/velopayments/models/funding_payor_status_audit_response.rb +22 -22
  206. data/lib/velopayments/models/funding_request_v2.rb +17 -19
  207. data/lib/velopayments/models/funding_request_v3.rb +19 -19
  208. data/lib/velopayments/models/{source_account_response.rb → funding_response.rb} +178 -138
  209. data/lib/velopayments/models/fx_summary.rb +87 -61
  210. data/lib/velopayments/models/fx_summary_v3.rb +87 -61
  211. data/lib/velopayments/models/get_fundings_response.rb +15 -19
  212. data/lib/velopayments/models/get_fundings_response_links.rb +15 -19
  213. data/lib/velopayments/models/{get_payee_list_response_company.rb → get_payee_list_response_company_v3.rb} +24 -24
  214. data/lib/velopayments/models/{get_payee_list_response_company2.rb → get_payee_list_response_company_v4.rb} +24 -24
  215. data/lib/velopayments/models/{get_payee_list_response_individual.rb → get_payee_list_response_individual_v3.rb} +19 -23
  216. data/lib/velopayments/models/{get_payee_list_response_individual2.rb → get_payee_list_response_individual_v4.rb} +19 -23
  217. data/lib/velopayments/models/{get_payee_list_response.rb → get_payee_list_response_v3.rb} +66 -27
  218. data/lib/velopayments/models/{get_payee_list_response2.rb → get_payee_list_response_v4.rb} +67 -28
  219. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +15 -19
  220. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +15 -19
  221. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +16 -54
  222. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +17 -21
  223. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +19 -21
  224. data/lib/velopayments/models/get_payout_statistics.rb +19 -19
  225. data/lib/velopayments/models/get_payouts_response.rb +17 -21
  226. data/lib/velopayments/models/get_payouts_response_v3.rb +15 -19
  227. data/lib/velopayments/models/get_payouts_response_v3_links.rb +15 -19
  228. data/lib/velopayments/models/get_payouts_response_v3_page.rb +15 -19
  229. data/lib/velopayments/models/{individual.rb → individual_v3.rb} +29 -25
  230. data/lib/velopayments/models/{create_individual_name.rb → individual_v3_name.rb} +34 -26
  231. data/lib/velopayments/models/{individual2.rb → individual_v4.rb} +29 -25
  232. data/lib/velopayments/models/inline_response400.rb +15 -19
  233. data/lib/velopayments/models/inline_response401.rb +15 -19
  234. data/lib/velopayments/models/inline_response403.rb +15 -19
  235. data/lib/velopayments/models/inline_response404.rb +15 -19
  236. data/lib/velopayments/models/inline_response409.rb +15 -19
  237. data/lib/velopayments/models/inline_response412.rb +15 -19
  238. data/lib/velopayments/models/{instruct_payout_request.rb → instruct_payout_request_v3.rb} +18 -22
  239. data/lib/velopayments/models/{invite_payee_request.rb → invite_payee_request_v3.rb} +20 -22
  240. data/lib/velopayments/models/{invite_payee_request2.rb → invite_payee_request_v4.rb} +20 -22
  241. data/lib/velopayments/models/invite_user_request.rb +37 -23
  242. data/lib/velopayments/models/link_for_response.rb +15 -19
  243. data/lib/velopayments/models/{list_funding_accounts_response2.rb → list_funding_accounts_response_v2.rb} +21 -25
  244. data/lib/velopayments/models/{payee_delta_response_links.rb → list_funding_accounts_response_v2_links.rb} +18 -22
  245. data/lib/velopayments/models/{paged_payee_response_page.rb → list_funding_accounts_response_v2_page.rb} +18 -22
  246. data/lib/velopayments/models/list_payments_response_v3.rb +15 -19
  247. data/lib/velopayments/models/list_payments_response_v3_page.rb +15 -19
  248. data/lib/velopayments/models/list_payments_response_v4.rb +15 -19
  249. data/lib/velopayments/models/list_source_account_response_v2.rb +15 -19
  250. data/lib/velopayments/models/list_source_account_response_v2_links.rb +15 -19
  251. data/lib/velopayments/models/list_source_account_response_v3.rb +15 -19
  252. data/lib/velopayments/models/list_source_account_response_v3_links.rb +15 -19
  253. data/lib/velopayments/models/localisation_details.rb +15 -19
  254. data/lib/velopayments/models/mfa_details.rb +37 -19
  255. data/lib/velopayments/models/mfa_type.rb +8 -5
  256. data/lib/velopayments/models/{name.rb → name_v3.rb} +42 -30
  257. data/lib/velopayments/models/{name2.rb → name_v4.rb} +42 -30
  258. data/lib/velopayments/models/notification.rb +24 -22
  259. data/lib/velopayments/models/{invitation_status2.rb → notification_source.rb} +48 -20
  260. data/lib/velopayments/models/{notifications.rb → notifications_v2.rb} +18 -22
  261. data/lib/velopayments/models/{notifications2.rb → notifications_v3.rb} +18 -22
  262. data/lib/velopayments/models/onboarding_status_changed.rb +23 -19
  263. data/lib/velopayments/models/page_for_response.rb +15 -19
  264. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +15 -19
  265. data/lib/velopayments/models/{paged_payee_invitation_status_response.rb → paged_payee_invitation_status_response_v3.rb} +21 -25
  266. data/lib/velopayments/models/{paged_payee_invitation_status_response_page.rb → paged_payee_invitation_status_response_v3_page.rb} +18 -22
  267. data/lib/velopayments/models/{paged_payee_invitation_status_response2.rb → paged_payee_invitation_status_response_v4.rb} +21 -25
  268. data/lib/velopayments/models/{paged_payee_response.rb → paged_payee_response_v3.rb} +22 -26
  269. data/lib/velopayments/models/{paged_payee_response_links.rb → paged_payee_response_v3_links.rb} +18 -22
  270. data/lib/velopayments/models/{payee_delta_response_page.rb → paged_payee_response_v3_page.rb} +18 -22
  271. data/lib/velopayments/models/{paged_payee_response_summary.rb → paged_payee_response_v3_summary.rb} +18 -22
  272. data/lib/velopayments/models/{paged_payee_response2.rb → paged_payee_response_v4.rb} +22 -26
  273. data/lib/velopayments/models/paged_payments_response_v3.rb +17 -21
  274. data/lib/velopayments/models/paged_user_response.rb +15 -19
  275. data/lib/velopayments/models/paged_user_response_links.rb +15 -19
  276. data/lib/velopayments/models/paged_user_response_page.rb +15 -19
  277. data/lib/velopayments/models/password_request.rb +17 -19
  278. data/lib/velopayments/models/{payable_issue.rb → payable_issue_v3.rb} +22 -22
  279. data/lib/velopayments/models/{payable_issue2.rb → payable_issue_v4.rb} +22 -22
  280. data/lib/velopayments/models/payable_status_changed.rb +23 -19
  281. data/lib/velopayments/models/{payee_address2.rb → payee_address_v3.rb} +41 -27
  282. data/lib/velopayments/models/{payee_address.rb → payee_address_v4.rb} +24 -22
  283. data/lib/velopayments/models/{payee_delta_response.rb → payee_delta_response_v3.rb} +21 -25
  284. data/lib/velopayments/models/{payee_delta_response2_links.rb → payee_delta_response_v3_links.rb} +18 -22
  285. data/lib/velopayments/models/{list_source_account_response_page.rb → payee_delta_response_v3_page.rb} +18 -22
  286. data/lib/velopayments/models/{payee_delta_response2.rb → payee_delta_response_v4.rb} +21 -25
  287. data/lib/velopayments/models/{list_source_account_response_links.rb → payee_delta_response_v4_links.rb} +18 -22
  288. data/lib/velopayments/models/{payee_delta.rb → payee_delta_v3.rb} +24 -23
  289. data/lib/velopayments/models/{payee_delta2.rb → payee_delta_v4.rb} +64 -23
  290. data/lib/velopayments/models/{payee_detail_response2.rb → payee_detail_response_v3.rb} +69 -30
  291. data/lib/velopayments/models/{payee_detail_response.rb → payee_detail_response_v4.rb} +29 -30
  292. data/lib/velopayments/models/payee_details_changed.rb +23 -19
  293. data/lib/velopayments/models/payee_event.rb +23 -19
  294. data/lib/velopayments/models/payee_event_all_of.rb +17 -19
  295. data/lib/velopayments/models/payee_event_all_of_reasons.rb +19 -19
  296. data/lib/velopayments/models/{payee_invitation_status_response.rb → payee_invitation_status_response_v3.rb} +23 -56
  297. data/lib/velopayments/models/{payee_invitation_status_response2.rb → payee_invitation_status_response_v4.rb} +23 -56
  298. data/lib/velopayments/models/payee_payor_ref_v3.rb +17 -21
  299. data/lib/velopayments/models/{payee_payor_ref.rb → payee_payor_ref_v4.rb} +20 -24
  300. data/lib/velopayments/models/payee_type.rb +8 -5
  301. data/lib/velopayments/models/{payee_type2.rb → payee_type_enum.rb} +9 -6
  302. data/lib/velopayments/models/payee_user_self_update_request.rb +15 -19
  303. data/lib/velopayments/models/payment_channel_country.rb +19 -19
  304. data/lib/velopayments/models/payment_channel_rule.rb +37 -23
  305. data/lib/velopayments/models/payment_channel_rules_response.rb +15 -19
  306. data/lib/velopayments/models/payment_delta.rb +19 -19
  307. data/lib/velopayments/models/payment_delta_response.rb +17 -21
  308. data/lib/velopayments/models/payment_delta_response_v1.rb +17 -21
  309. data/lib/velopayments/models/payment_delta_v1.rb +19 -19
  310. data/lib/velopayments/models/payment_event.rb +23 -19
  311. data/lib/velopayments/models/payment_event_all_of.rb +17 -19
  312. data/lib/velopayments/models/payment_event_response.rb +109 -55
  313. data/lib/velopayments/models/payment_event_response_v3.rb +79 -53
  314. data/lib/velopayments/models/payment_instruction_v3.rb +84 -29
  315. data/lib/velopayments/models/payment_rejected_or_returned.rb +29 -19
  316. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +19 -19
  317. data/lib/velopayments/models/payment_response_v3.rb +101 -63
  318. data/lib/velopayments/models/payment_response_v4.rb +121 -64
  319. data/lib/velopayments/models/payment_response_v4_payout.rb +15 -19
  320. data/lib/velopayments/models/payment_status_changed.rb +25 -19
  321. data/lib/velopayments/models/payment_status_changed_all_of.rb +17 -19
  322. data/lib/velopayments/models/payment_v3.rb +158 -56
  323. data/lib/velopayments/models/payor_address.rb +21 -19
  324. data/lib/velopayments/models/payor_address_v2.rb +21 -19
  325. data/lib/velopayments/models/payor_aml_transaction.rb +15 -19
  326. data/lib/velopayments/models/payor_aml_transaction_v3.rb +15 -19
  327. data/lib/velopayments/models/payor_branding_response.rb +20 -20
  328. data/lib/velopayments/models/payor_create_api_key_request.rb +23 -23
  329. data/lib/velopayments/models/payor_create_api_key_response.rb +15 -19
  330. data/lib/velopayments/models/payor_create_application_request.rb +17 -19
  331. data/lib/velopayments/models/payor_email_opt_out_request.rb +17 -19
  332. data/lib/velopayments/models/payor_links_response.rb +15 -19
  333. data/lib/velopayments/models/payor_links_response_links.rb +24 -53
  334. data/lib/velopayments/models/payor_links_response_payors.rb +20 -53
  335. data/lib/velopayments/models/payor_v1.rb +19 -54
  336. data/lib/velopayments/models/payor_v2.rb +45 -58
  337. data/lib/velopayments/models/payout_company_v3.rb +17 -19
  338. data/lib/velopayments/models/payout_individual_v3.rb +17 -19
  339. data/lib/velopayments/models/payout_name_v3.rb +19 -19
  340. data/lib/velopayments/models/payout_payee_v3.rb +17 -19
  341. data/lib/velopayments/models/payout_payor.rb +25 -19
  342. data/lib/velopayments/models/payout_payor_ids.rb +21 -19
  343. data/lib/velopayments/models/payout_principal.rb +19 -19
  344. data/lib/velopayments/models/payout_schedule.rb +27 -20
  345. data/lib/velopayments/models/{payout_schedule2.rb → payout_schedule_v3.rb} +30 -23
  346. data/lib/velopayments/models/payout_summary_audit.rb +27 -21
  347. data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
  348. data/lib/velopayments/models/payout_summary_response_v3.rb +32 -20
  349. data/lib/velopayments/models/ping.rb +21 -19
  350. data/lib/velopayments/models/ping_response.rb +15 -19
  351. data/lib/velopayments/models/post_instruct_fx_info.rb +267 -0
  352. data/lib/velopayments/models/{query_batch_response.rb → query_batch_response_v3.rb} +20 -58
  353. data/lib/velopayments/models/{query_batch_response2.rb → query_batch_response_v4.rb} +20 -58
  354. data/lib/velopayments/models/quote_fx_summary_v3.rb +42 -65
  355. data/lib/velopayments/models/quote_response_v3.rb +15 -19
  356. data/lib/velopayments/models/region_v2.rb +15 -19
  357. data/lib/velopayments/models/register_sms_request.rb +17 -19
  358. data/lib/velopayments/models/rejected_payment_v3.rb +121 -19
  359. data/lib/velopayments/models/resend_token_request.rb +17 -19
  360. data/lib/velopayments/models/reset_password_request.rb +17 -19
  361. data/lib/velopayments/models/role.rb +17 -19
  362. data/lib/velopayments/models/role_update_request.rb +17 -19
  363. data/lib/velopayments/models/{schedule_payout_request.rb → schedule_payout_request_v3.rb} +22 -22
  364. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +17 -19
  365. data/lib/velopayments/models/self_update_password_request.rb +19 -19
  366. data/lib/velopayments/models/set_notifications_request.rb +17 -19
  367. data/lib/velopayments/models/{funding_request_v1.rb → set_notifications_request2.rb} +46 -48
  368. data/lib/velopayments/models/source_account_response_v2.rb +44 -50
  369. data/lib/velopayments/models/source_account_response_v3.rb +66 -53
  370. data/lib/velopayments/models/source_account_summary.rb +49 -20
  371. data/lib/velopayments/models/source_account_summary_v3.rb +49 -20
  372. data/lib/velopayments/models/source_account_v3.rb +26 -19
  373. data/lib/velopayments/models/source_event.rb +21 -19
  374. data/lib/velopayments/models/supported_countries_response.rb +15 -19
  375. data/lib/velopayments/models/supported_countries_response_v2.rb +15 -19
  376. data/lib/velopayments/models/supported_country.rb +22 -22
  377. data/lib/velopayments/models/supported_country_v2.rb +22 -22
  378. data/lib/velopayments/models/supported_currency_response_v2.rb +15 -19
  379. data/lib/velopayments/models/supported_currency_v2.rb +22 -22
  380. data/lib/velopayments/models/{transfer_request2.rb → transfer_request_v2.rb} +24 -22
  381. data/lib/velopayments/models/{transfer_request.rb → transfer_request_v3.rb} +36 -22
  382. data/lib/velopayments/models/transmission_types.rb +21 -19
  383. data/lib/velopayments/models/transmission_types2.rb +21 -19
  384. data/lib/velopayments/models/unregister_mfa_request.rb +17 -19
  385. data/lib/velopayments/models/{update_payee_details_request.rb → update_payee_details_request_v3.rb} +45 -27
  386. data/lib/velopayments/models/{update_payee_details_request2.rb → update_payee_details_request_v4.rb} +50 -28
  387. data/lib/velopayments/models/{update_remote_id_request2.rb → update_remote_id_request_v3.rb} +22 -22
  388. data/lib/velopayments/models/{update_remote_id_request.rb → update_remote_id_request_v4.rb} +22 -22
  389. data/lib/velopayments/models/update_webhook_request.rb +21 -21
  390. data/lib/velopayments/models/user_details_update_request.rb +37 -19
  391. data/lib/velopayments/models/user_info.rb +37 -19
  392. data/lib/velopayments/models/user_response.rb +53 -29
  393. data/lib/velopayments/models/user_status.rb +8 -5
  394. data/lib/velopayments/models/user_type.rb +8 -5
  395. data/lib/velopayments/models/user_type2.rb +8 -5
  396. data/lib/velopayments/models/validate_password_response.rb +21 -21
  397. data/lib/velopayments/models/webhook_response.rb +15 -19
  398. data/lib/velopayments/models/webhooks_response.rb +17 -21
  399. data/lib/velopayments/models/withdraw_payment_request.rb +17 -19
  400. data/lib/velopayments/version.rb +3 -3
  401. data/lib/velopayments.rb +91 -111
  402. data/oa3-config.json +1 -1
  403. data/spec/api/countries_api_spec.rb +41 -6
  404. data/spec/api/currencies_api_spec.rb +5 -3
  405. data/spec/api/funding_api_spec.rb +169 -0
  406. data/spec/api/funding_manager_private_api_spec.rb +4 -4
  407. data/spec/api/login_api_spec.rb +11 -11
  408. data/spec/api/payee_invitation_api_spec.rb +74 -38
  409. data/spec/api/payees_api_spec.rb +76 -42
  410. data/spec/api/payment_audit_service_api_spec.rb +90 -17
  411. data/spec/api/payment_audit_service_deprecated_api_spec.rb +10 -10
  412. data/spec/{models/get_fundings_response_links_spec.rb → api/payor_hierarchy_api_spec.rb} +24 -15
  413. data/spec/api/payors_api_spec.rb +47 -35
  414. data/spec/api/payors_private_api_spec.rb +3 -3
  415. data/spec/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +20 -20
  416. data/spec/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +81 -162
  417. data/spec/api/tokens_api_spec.rb +3 -3
  418. data/spec/api/users_api_spec.rb +45 -19
  419. data/spec/api/webhooks_api_spec.rb +7 -7
  420. data/spec/api_client_spec.rb +4 -2
  421. data/spec/configuration_spec.rb +2 -2
  422. data/spec/spec_helper.rb +2 -2
  423. data/specs/api/countries_api_spec.rb +19 -19
  424. data/specs/api/currencies_api_spec.rb +2 -2
  425. data/specs/api/funding_api_spec.rb +169 -0
  426. data/specs/api/funding_manager_private_api_spec.rb +16 -4
  427. data/specs/api/login_api_spec.rb +8 -7
  428. data/specs/api/payee_invitation_api_spec.rb +55 -39
  429. data/specs/api/payees_api_spec.rb +107 -45
  430. data/specs/api/payment_audit_service_api_spec.rb +29 -85
  431. data/specs/api/payment_audit_service_deprecated_api_spec.rb +10 -10
  432. data/{spec/models/company2_spec.rb → specs/api/payor_hierarchy_api_spec.rb} +23 -20
  433. data/specs/api/payors_api_spec.rb +27 -48
  434. data/specs/api/payors_private_api_spec.rb +4 -4
  435. data/specs/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +51 -24
  436. data/specs/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +36 -208
  437. data/specs/api/tokens_api_spec.rb +4 -4
  438. data/specs/api/users_api_spec.rb +38 -47
  439. data/specs/api/webhooks_api_spec.rb +7 -7
  440. data/velopayments.gemspec +3 -3
  441. metadata +208 -766
  442. data/docs/CreatePayee2.md +0 -38
  443. data/docs/FundingAccountResponse.md +0 -36
  444. data/docs/FundingAccountType.md +0 -15
  445. data/docs/FundingEventType.md +0 -15
  446. data/docs/FundingManagerApi.md +0 -1291
  447. data/docs/FundingRequestV1.md +0 -18
  448. data/docs/GetPayeeListResponseIndividual.md +0 -18
  449. data/docs/GetPayeeListResponseIndividual2.md +0 -18
  450. data/docs/InvitationStatus.md +0 -15
  451. data/docs/InvitationStatus2.md +0 -15
  452. data/docs/KycState.md +0 -15
  453. data/docs/ListFundingAccountsResponse.md +0 -22
  454. data/docs/ListFundingAccountsResponse2.md +0 -22
  455. data/docs/ListSourceAccountResponse.md +0 -22
  456. data/docs/OnboardedStatus.md +0 -15
  457. data/docs/OnboardedStatus2.md +0 -15
  458. data/docs/PagedPayeeInvitationStatusResponse.md +0 -22
  459. data/docs/PagedPayeeInvitationStatusResponse2.md +0 -22
  460. data/docs/PagedPayeeResponse.md +0 -24
  461. data/docs/PagedPayeeResponse2.md +0 -24
  462. data/docs/PayeeDeltaResponse.md +0 -22
  463. data/docs/PayeeDeltaResponse2.md +0 -22
  464. data/docs/PayeeType2.md +0 -15
  465. data/docs/PaymentAuditCurrency.md +0 -15
  466. data/docs/PaymentAuditCurrencyV3.md +0 -15
  467. data/docs/PaymentRails.md +0 -15
  468. data/docs/PayorLogoRequest.md +0 -18
  469. data/docs/PayoutStatus.md +0 -15
  470. data/docs/PayoutStatusV3.md +0 -15
  471. data/docs/PayoutType.md +0 -15
  472. data/docs/ScheduleStatus.md +0 -15
  473. data/docs/ScheduleStatus2.md +0 -15
  474. data/docs/SourceAccountResponse.md +0 -44
  475. data/docs/SourceAccountType.md +0 -15
  476. data/docs/TransmissionType.md +0 -15
  477. data/docs/WatchlistStatus.md +0 -15
  478. data/docs/WatchlistStatus2.md +0 -15
  479. data/lib/velopayments/api/funding_manager_api.rb +0 -1330
  480. data/lib/velopayments/models/funding_account_response.rb +0 -357
  481. data/lib/velopayments/models/funding_account_type.rb +0 -37
  482. data/lib/velopayments/models/funding_event_type.rb +0 -42
  483. data/lib/velopayments/models/invitation_status.rb +0 -38
  484. data/lib/velopayments/models/kyc_state.rb +0 -38
  485. data/lib/velopayments/models/list_funding_accounts_response.rb +0 -241
  486. data/lib/velopayments/models/list_source_account_response.rb +0 -241
  487. data/lib/velopayments/models/ofac_status.rb +0 -38
  488. data/lib/velopayments/models/onboarded_status.rb +0 -39
  489. data/lib/velopayments/models/onboarded_status2.rb +0 -39
  490. data/lib/velopayments/models/payment_audit_currency.rb +0 -38
  491. data/lib/velopayments/models/payment_audit_currency_v3.rb +0 -38
  492. data/lib/velopayments/models/payment_rails.rb +0 -37
  493. data/lib/velopayments/models/payor_logo_request.rb +0 -218
  494. data/lib/velopayments/models/payout_status.rb +0 -44
  495. data/lib/velopayments/models/payout_status_v3.rb +0 -44
  496. data/lib/velopayments/models/payout_type.rb +0 -38
  497. data/lib/velopayments/models/schedule_status.rb +0 -38
  498. data/lib/velopayments/models/schedule_status2.rb +0 -38
  499. data/lib/velopayments/models/source_account_type.rb +0 -37
  500. data/lib/velopayments/models/transmission_type.rb +0 -38
  501. data/lib/velopayments/models/watchlist_status.rb +0 -40
  502. data/lib/velopayments/models/watchlist_status2.rb +0 -40
  503. data/spec/models/accepted_payment_v3_spec.rb +0 -76
  504. data/spec/models/access_token_response_spec.rb +0 -70
  505. data/spec/models/access_token_validation_request_spec.rb +0 -34
  506. data/spec/models/auth_response_spec.rb +0 -64
  507. data/spec/models/auto_top_up_config2_spec.rb +0 -52
  508. data/spec/models/auto_top_up_config_spec.rb +0 -46
  509. data/spec/models/category_spec.rb +0 -28
  510. data/spec/models/challenge2_spec.rb +0 -40
  511. data/spec/models/challenge_spec.rb +0 -40
  512. data/spec/models/company_spec.rb +0 -46
  513. data/spec/models/create_funding_account_request_v2_spec.rb +0 -74
  514. data/spec/models/create_individual2_spec.rb +0 -46
  515. data/spec/models/create_individual_name_spec.rb +0 -52
  516. data/spec/models/create_individual_spec.rb +0 -46
  517. data/spec/models/create_payee2_spec.rb +0 -94
  518. data/spec/models/create_payee_address2_spec.rb +0 -80
  519. data/spec/models/create_payee_address_spec.rb +0 -80
  520. data/spec/models/create_payee_spec.rb +0 -94
  521. data/spec/models/create_payees_csv_request2_spec.rb +0 -214
  522. data/spec/models/create_payees_csv_request_spec.rb +0 -214
  523. data/spec/models/create_payees_csv_response2_spec.rb +0 -40
  524. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +0 -46
  525. data/spec/models/create_payees_csv_response_spec.rb +0 -40
  526. data/spec/models/create_payees_request2_spec.rb +0 -40
  527. data/spec/models/create_payees_request_spec.rb +0 -40
  528. data/spec/models/create_payment_channel2_spec.rb +0 -78
  529. data/spec/models/create_payment_channel_spec.rb +0 -78
  530. data/spec/models/create_payor_link_request_spec.rb +0 -50
  531. data/spec/models/create_payout_request_v3_spec.rb +0 -52
  532. data/spec/models/debit_event_all_of_spec.rb +0 -34
  533. data/spec/models/debit_event_spec.rb +0 -52
  534. data/spec/models/debit_status_changed_all_of_spec.rb +0 -34
  535. data/spec/models/debit_status_changed_spec.rb +0 -58
  536. data/spec/models/error_data_spec.rb +0 -40
  537. data/spec/models/error_response_spec.rb +0 -46
  538. data/spec/models/error_spec.rb +0 -74
  539. data/spec/models/failed_payee2_spec.rb +0 -94
  540. data/spec/models/failed_payee_spec.rb +0 -94
  541. data/spec/models/failed_submission2_spec.rb +0 -40
  542. data/spec/models/failed_submission_spec.rb +0 -40
  543. data/spec/models/funding_account_response2_spec.rb +0 -88
  544. data/spec/models/funding_account_response_spec.rb +0 -88
  545. data/spec/models/funding_account_type_spec.rb +0 -28
  546. data/spec/models/funding_audit_spec.rb +0 -94
  547. data/spec/models/funding_event_spec.rb +0 -52
  548. data/spec/models/funding_event_type_spec.rb +0 -28
  549. data/spec/models/funding_payor_status_audit_response_spec.rb +0 -52
  550. data/spec/models/funding_request_v1_spec.rb +0 -34
  551. data/spec/models/funding_request_v2_spec.rb +0 -34
  552. data/spec/models/funding_request_v3_spec.rb +0 -40
  553. data/spec/models/fx_summary_spec.rb +0 -96
  554. data/spec/models/fx_summary_v3_spec.rb +0 -96
  555. data/spec/models/get_fundings_response_spec.rb +0 -46
  556. data/spec/models/get_payee_list_response2_spec.rb +0 -130
  557. data/spec/models/get_payee_list_response_company2_spec.rb +0 -40
  558. data/spec/models/get_payee_list_response_company_spec.rb +0 -40
  559. data/spec/models/get_payee_list_response_individual2_spec.rb +0 -34
  560. data/spec/models/get_payee_list_response_individual_spec.rb +0 -34
  561. data/spec/models/get_payee_list_response_spec.rb +0 -130
  562. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +0 -58
  563. data/spec/models/get_payments_for_payout_response_v3_spec.rb +0 -52
  564. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +0 -92
  565. data/spec/models/get_payments_for_payout_response_v4_spec.rb +0 -52
  566. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +0 -148
  567. data/spec/models/get_payout_statistics_spec.rb +0 -40
  568. data/spec/models/get_payouts_response_spec.rb +0 -46
  569. data/spec/models/get_payouts_response_v3_links_spec.rb +0 -40
  570. data/spec/models/get_payouts_response_v3_page_spec.rb +0 -58
  571. data/spec/models/get_payouts_response_v3_spec.rb +0 -46
  572. data/spec/models/individual2_spec.rb +0 -46
  573. data/spec/models/individual_name_spec.rb +0 -52
  574. data/spec/models/individual_spec.rb +0 -46
  575. data/spec/models/inline_response400_spec.rb +0 -46
  576. data/spec/models/inline_response401_spec.rb +0 -46
  577. data/spec/models/inline_response403_spec.rb +0 -46
  578. data/spec/models/inline_response404_spec.rb +0 -46
  579. data/spec/models/inline_response409_spec.rb +0 -46
  580. data/spec/models/inline_response412_spec.rb +0 -46
  581. data/spec/models/instruct_payout_request_spec.rb +0 -34
  582. data/spec/models/invitation_status2_spec.rb +0 -28
  583. data/spec/models/invitation_status_spec.rb +0 -28
  584. data/spec/models/invite_payee_request2_spec.rb +0 -34
  585. data/spec/models/invite_payee_request_spec.rb +0 -34
  586. data/spec/models/invite_user_request_spec.rb +0 -102
  587. data/spec/models/kyc_state_spec.rb +0 -28
  588. data/spec/models/link_for_response_spec.rb +0 -40
  589. data/spec/models/list_funding_accounts_response2_spec.rb +0 -46
  590. data/spec/models/list_funding_accounts_response_spec.rb +0 -46
  591. data/spec/models/list_payments_response_v3_page_spec.rb +0 -58
  592. data/spec/models/list_payments_response_v3_spec.rb +0 -46
  593. data/spec/models/list_payments_response_v4_spec.rb +0 -46
  594. data/spec/models/list_source_account_response_links_spec.rb +0 -40
  595. data/spec/models/list_source_account_response_page_spec.rb +0 -58
  596. data/spec/models/list_source_account_response_spec.rb +0 -46
  597. data/spec/models/list_source_account_response_v2_links_spec.rb +0 -40
  598. data/spec/models/list_source_account_response_v2_spec.rb +0 -46
  599. data/spec/models/list_source_account_response_v3_links_spec.rb +0 -40
  600. data/spec/models/list_source_account_response_v3_spec.rb +0 -46
  601. data/spec/models/localisation_details_spec.rb +0 -40
  602. data/spec/models/mfa_details_spec.rb +0 -40
  603. data/spec/models/mfa_type_spec.rb +0 -28
  604. data/spec/models/name2_spec.rb +0 -52
  605. data/spec/models/name_spec.rb +0 -52
  606. data/spec/models/notification_spec.rb +0 -58
  607. data/spec/models/notifications2_spec.rb +0 -34
  608. data/spec/models/notifications_spec.rb +0 -34
  609. data/spec/models/ofac_status_spec.rb +0 -28
  610. data/spec/models/onboarded_status2_spec.rb +0 -28
  611. data/spec/models/onboarded_status_spec.rb +0 -28
  612. data/spec/models/onboarding_status_changed_spec.rb +0 -58
  613. data/spec/models/page_for_response_spec.rb +0 -58
  614. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +0 -46
  615. data/spec/models/paged_payee_invitation_status_response2_spec.rb +0 -46
  616. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +0 -58
  617. data/spec/models/paged_payee_invitation_status_response_spec.rb +0 -46
  618. data/spec/models/paged_payee_response2_spec.rb +0 -52
  619. data/spec/models/paged_payee_response_links_spec.rb +0 -40
  620. data/spec/models/paged_payee_response_page_spec.rb +0 -58
  621. data/spec/models/paged_payee_response_spec.rb +0 -52
  622. data/spec/models/paged_payee_response_summary_spec.rb +0 -58
  623. data/spec/models/paged_payments_response_v3_spec.rb +0 -46
  624. data/spec/models/paged_user_response_links_spec.rb +0 -40
  625. data/spec/models/paged_user_response_page_spec.rb +0 -58
  626. data/spec/models/paged_user_response_spec.rb +0 -46
  627. data/spec/models/password_request_spec.rb +0 -34
  628. data/spec/models/payable_issue2_spec.rb +0 -40
  629. data/spec/models/payable_issue_spec.rb +0 -40
  630. data/spec/models/payable_status_changed_spec.rb +0 -58
  631. data/spec/models/payee_address2_spec.rb +0 -76
  632. data/spec/models/payee_address_spec.rb +0 -76
  633. data/spec/models/payee_delta2_spec.rb +0 -70
  634. data/spec/models/payee_delta_response2_links_spec.rb +0 -40
  635. data/spec/models/payee_delta_response2_spec.rb +0 -46
  636. data/spec/models/payee_delta_response_links_spec.rb +0 -40
  637. data/spec/models/payee_delta_response_page_spec.rb +0 -58
  638. data/spec/models/payee_delta_response_spec.rb +0 -46
  639. data/spec/models/payee_delta_spec.rb +0 -70
  640. data/spec/models/payee_detail_response2_spec.rb +0 -202
  641. data/spec/models/payee_detail_response_spec.rb +0 -202
  642. data/spec/models/payee_details_changed_spec.rb +0 -58
  643. data/spec/models/payee_event_all_of_reasons_spec.rb +0 -40
  644. data/spec/models/payee_event_all_of_spec.rb +0 -40
  645. data/spec/models/payee_event_spec.rb +0 -58
  646. data/spec/models/payee_invitation_status_response2_spec.rb +0 -50
  647. data/spec/models/payee_invitation_status_response_spec.rb +0 -50
  648. data/spec/models/payee_payor_ref_spec.rb +0 -70
  649. data/spec/models/payee_payor_ref_v3_spec.rb +0 -70
  650. data/spec/models/payee_type2_spec.rb +0 -28
  651. data/spec/models/payee_type_spec.rb +0 -28
  652. data/spec/models/payee_user_self_update_request_spec.rb +0 -64
  653. data/spec/models/payment_audit_currency_spec.rb +0 -28
  654. data/spec/models/payment_audit_currency_v3_spec.rb +0 -28
  655. data/spec/models/payment_channel_country_spec.rb +0 -40
  656. data/spec/models/payment_channel_rule_spec.rb +0 -70
  657. data/spec/models/payment_channel_rules_response_spec.rb +0 -34
  658. data/spec/models/payment_delta_response_spec.rb +0 -46
  659. data/spec/models/payment_delta_response_v1_spec.rb +0 -46
  660. data/spec/models/payment_delta_spec.rb +0 -76
  661. data/spec/models/payment_delta_v1_spec.rb +0 -76
  662. data/spec/models/payment_event_all_of_spec.rb +0 -46
  663. data/spec/models/payment_event_response_spec.rb +0 -104
  664. data/spec/models/payment_event_response_v3_spec.rb +0 -104
  665. data/spec/models/payment_event_spec.rb +0 -64
  666. data/spec/models/payment_instruction_v3_spec.rb +0 -82
  667. data/spec/models/payment_rails_spec.rb +0 -28
  668. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +0 -40
  669. data/spec/models/payment_rejected_or_returned_spec.rb +0 -82
  670. data/spec/models/payment_response_v3_spec.rb +0 -252
  671. data/spec/models/payment_response_v4_payout_spec.rb +0 -46
  672. data/spec/models/payment_response_v4_spec.rb +0 -318
  673. data/spec/models/payment_status_changed_all_of_spec.rb +0 -34
  674. data/spec/models/payment_status_changed_spec.rb +0 -70
  675. data/spec/models/payment_v3_spec.rb +0 -116
  676. data/spec/models/payor_address_spec.rb +0 -76
  677. data/spec/models/payor_address_v2_spec.rb +0 -76
  678. data/spec/models/payor_aml_transaction_spec.rb +0 -190
  679. data/spec/models/payor_aml_transaction_v3_spec.rb +0 -178
  680. data/spec/models/payor_branding_response_spec.rb +0 -58
  681. data/spec/models/payor_create_api_key_request_spec.rb +0 -50
  682. data/spec/models/payor_create_api_key_response_spec.rb +0 -40
  683. data/spec/models/payor_create_application_request_spec.rb +0 -40
  684. data/spec/models/payor_email_opt_out_request_spec.rb +0 -34
  685. data/spec/models/payor_links_response_links_spec.rb +0 -56
  686. data/spec/models/payor_links_response_payors_spec.rb +0 -56
  687. data/spec/models/payor_links_response_spec.rb +0 -40
  688. data/spec/models/payor_logo_request_spec.rb +0 -34
  689. data/spec/models/payor_v1_spec.rb +0 -164
  690. data/spec/models/payor_v2_spec.rb +0 -182
  691. data/spec/models/payout_company_v3_spec.rb +0 -34
  692. data/spec/models/payout_individual_v3_spec.rb +0 -34
  693. data/spec/models/payout_name_v3_spec.rb +0 -40
  694. data/spec/models/payout_payee_v3_spec.rb +0 -46
  695. data/spec/models/payout_payor_ids_spec.rb +0 -46
  696. data/spec/models/payout_payor_spec.rb +0 -58
  697. data/spec/models/payout_principal_spec.rb +0 -40
  698. data/spec/models/payout_schedule2_spec.rb +0 -58
  699. data/spec/models/payout_schedule_spec.rb +0 -64
  700. data/spec/models/payout_status_spec.rb +0 -28
  701. data/spec/models/payout_status_v3_spec.rb +0 -28
  702. data/spec/models/payout_summary_audit_spec.rb +0 -130
  703. data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
  704. data/spec/models/payout_summary_response_v3_spec.rb +0 -94
  705. data/spec/models/payout_type_spec.rb +0 -28
  706. data/spec/models/ping_response_spec.rb +0 -40
  707. data/spec/models/ping_spec.rb +0 -46
  708. data/spec/models/query_batch_response2_spec.rb +0 -56
  709. data/spec/models/query_batch_response_spec.rb +0 -56
  710. data/spec/models/quote_fx_summary_v3_spec.rb +0 -102
  711. data/spec/models/quote_response_v3_spec.rb +0 -34
  712. data/spec/models/region_v2_spec.rb +0 -40
  713. data/spec/models/register_sms_request_spec.rb +0 -34
  714. data/spec/models/rejected_payment_v3_spec.rb +0 -94
  715. data/spec/models/resend_token_request_spec.rb +0 -44
  716. data/spec/models/reset_password_request_spec.rb +0 -34
  717. data/spec/models/role_spec.rb +0 -34
  718. data/spec/models/role_update_request_spec.rb +0 -40
  719. data/spec/models/schedule_payout_request_spec.rb +0 -40
  720. data/spec/models/schedule_status2_spec.rb +0 -28
  721. data/spec/models/schedule_status_spec.rb +0 -28
  722. data/spec/models/self_mfa_type_unregister_request_spec.rb +0 -38
  723. data/spec/models/self_update_password_request_spec.rb +0 -40
  724. data/spec/models/set_notifications_request_spec.rb +0 -34
  725. data/spec/models/source_account_response_spec.rb +0 -116
  726. data/spec/models/source_account_response_v2_spec.rb +0 -128
  727. data/spec/models/source_account_response_v3_spec.rb +0 -140
  728. data/spec/models/source_account_summary_spec.rb +0 -46
  729. data/spec/models/source_account_summary_v3_spec.rb +0 -46
  730. data/spec/models/source_account_type_spec.rb +0 -28
  731. data/spec/models/source_account_v3_spec.rb +0 -52
  732. data/spec/models/source_event_spec.rb +0 -46
  733. data/spec/models/supported_countries_response_spec.rb +0 -34
  734. data/spec/models/supported_countries_response_v2_spec.rb +0 -34
  735. data/spec/models/supported_country_spec.rb +0 -40
  736. data/spec/models/supported_country_v2_spec.rb +0 -46
  737. data/spec/models/supported_currency_response_v2_spec.rb +0 -34
  738. data/spec/models/supported_currency_v2_spec.rb +0 -40
  739. data/spec/models/transfer_request2_spec.rb +0 -46
  740. data/spec/models/transfer_request_spec.rb +0 -46
  741. data/spec/models/transmission_type_spec.rb +0 -28
  742. data/spec/models/transmission_types2_spec.rb +0 -46
  743. data/spec/models/transmission_types_spec.rb +0 -46
  744. data/spec/models/unregister_mfa_request_spec.rb +0 -44
  745. data/spec/models/update_payee_details_request2_spec.rb +0 -76
  746. data/spec/models/update_payee_details_request_spec.rb +0 -70
  747. data/spec/models/update_remote_id_request2_spec.rb +0 -40
  748. data/spec/models/update_remote_id_request_spec.rb +0 -40
  749. data/spec/models/update_webhook_request_spec.rb +0 -52
  750. data/spec/models/user_details_update_request_spec.rb +0 -76
  751. data/spec/models/user_info_spec.rb +0 -46
  752. data/spec/models/user_response_spec.rb +0 -140
  753. data/spec/models/user_status_spec.rb +0 -28
  754. data/spec/models/user_type2_spec.rb +0 -28
  755. data/spec/models/user_type_spec.rb +0 -28
  756. data/spec/models/validate_password_response_spec.rb +0 -52
  757. data/spec/models/watchlist_status2_spec.rb +0 -28
  758. data/spec/models/watchlist_status_spec.rb +0 -28
  759. data/spec/models/webhook_response_spec.rb +0 -64
  760. data/spec/models/webhooks_response_spec.rb +0 -46
  761. data/spec/models/withdraw_payment_request_spec.rb +0 -34
@@ -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.22.122
6
+ The version of the OpenAPI document: 2.35.58
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -58,20 +58,6 @@ describe 'PaymentAuditServiceApi' do
58
58
  end
59
59
  end
60
60
 
61
- # unit tests for export_transactions_csvv3
62
- # Export Transactions
63
- # Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
64
- # @param [Hash] opts the optional parameters
65
- # @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
66
- # @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
67
- # @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
68
- # @return [PayorAmlTransactionV3]
69
- describe 'export_transactions_csvv3 test' do
70
- skip "skipping test" do
71
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
72
- end
73
- end
74
-
75
61
  # unit tests for export_transactions_csvv4
76
62
  # Export Transactions
77
63
  # Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
@@ -80,10 +66,10 @@ describe 'PaymentAuditServiceApi' do
80
66
  # @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
81
67
  # @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
82
68
  # @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
83
- # @return [PayorAmlTransactionV4]
69
+ # @return [PayorAmlTransaction]
84
70
  describe 'export_transactions_csvv4 test' do
85
- skip "skipping test" do
86
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
+ skip "skipping broken test" do
72
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
73
  end
88
74
  end
89
75
 
@@ -92,35 +78,14 @@ describe 'PaymentAuditServiceApi' do
92
78
  # <p>Get a list of Fundings for a payor.</p>
93
79
  # @param payor_id The account owner Payor ID
94
80
  # @param [Hash] opts the optional parameters
81
+ # @option opts [String] :source_account_name The source account name
95
82
  # @option opts [Integer] :page Page number. Default is 1.
96
83
  # @option opts [Integer] :page_size The number of results to return in a page
97
84
  # @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
98
85
  # @return [GetFundingsResponse]
99
86
  describe 'get_fundings_v4 test' do
100
- skip "skipping test" do
101
- # it 'should work' do
102
- # payor_id = ENV['PAYOR']
103
- # opts = {
104
- # page: 1, # Integer | Page number. Default is 1.
105
- # page_size: 25, # Integer | The number of results to return in a page
106
- # sort: 'dateTime:desc' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
107
- # }
108
- # res = @api_instance.get_fundings_v4(payor_id, opts)
109
- # expect(res.content.length()).to be >= 1
110
- # expect(@api_instance).to respond_to(:get_fundings_v4)
111
- end
112
- end
113
-
114
- # unit tests for get_payment_details
115
- # Get Payment
116
- # Get the payment with the given id. This contains the payment history.
117
- # @param payment_id Payment Id
118
- # @param [Hash] opts the optional parameters
119
- # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
120
- # @return [PaymentResponseV3]
121
- describe 'get_payment_details test' do
122
- skip "skipping test" do
123
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
87
+ skip "skipping broken test" do
88
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
124
89
  end
125
90
  end
126
91
 
@@ -132,32 +97,8 @@ describe 'PaymentAuditServiceApi' do
132
97
  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
133
98
  # @return [PaymentResponseV4]
134
99
  describe 'get_payment_details_v4 test' do
135
- skip "skipping test" do
136
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
137
- end
138
- end
139
-
140
- # unit tests for get_payments_for_payout
141
- # Get Payments for Payout
142
- # Get List of payments for Payout
143
- # @param payout_id The id (UUID) of the payout.
144
- # @param [Hash] opts the optional parameters
145
- # @option opts [String] :remote_id The remote id of the payees.
146
- # @option opts [String] :status Payment Status
147
- # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
148
- # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
149
- # @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
150
- # @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
151
- # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
152
- # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
153
- # @option opts [Integer] :page Page number. Default is 1.
154
- # @option opts [Integer] :page_size The number of results to return in a page
155
- # @option opts [String] :sort <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p>
156
- # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
157
- # @return [GetPaymentsForPayoutResponseV3]
158
- describe 'get_payments_for_payout test' do
159
- skip "skipping test" do
160
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
100
+ skip "skipping broken test" do
101
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
161
102
  end
162
103
  end
163
104
 
@@ -166,7 +107,9 @@ describe 'PaymentAuditServiceApi' do
166
107
  # Get List of payments for Payout, allowing for RETURNED status
167
108
  # @param payout_id The id (UUID) of the payout.
168
109
  # @param [Hash] opts the optional parameters
110
+ # @option opts [String] :rails_id Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint.
169
111
  # @option opts [String] :remote_id The remote id of the payees.
112
+ # @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
170
113
  # @option opts [String] :status Payment Status
171
114
  # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
172
115
  # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
@@ -174,14 +117,15 @@ describe 'PaymentAuditServiceApi' do
174
117
  # @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
175
118
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
176
119
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
120
+ # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO
177
121
  # @option opts [Integer] :page Page number. Default is 1.
178
122
  # @option opts [Integer] :page_size The number of results to return in a page
179
123
  # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
180
124
  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
181
125
  # @return [GetPaymentsForPayoutResponseV4]
182
126
  describe 'get_payments_for_payout_v4 test' do
183
- skip "skipping test" do
184
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
127
+ skip "skipping broken test" do
128
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
185
129
  end
186
130
  end
187
131
 
@@ -212,10 +156,13 @@ describe 'PaymentAuditServiceApi' do
212
156
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
213
157
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
214
158
  # @option opts [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
159
+ # @option opts [Date] :scheduled_for_date_from Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
160
+ # @option opts [Date] :scheduled_for_date_to Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
161
+ # @option opts [String] :schedule_status Payout Schedule Status
215
162
  # @option opts [Integer] :page Page number. Default is 1.
216
163
  # @option opts [Integer] :page_size The number of results to return in a page
217
- # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
218
- # @return [GetPayoutsResponseV4]
164
+ # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor
165
+ # @return [GetPayoutsResponse]
219
166
  describe 'get_payouts_for_payor_v4 test' do
220
167
  it 'should work' do
221
168
  opts = {
@@ -244,20 +191,10 @@ describe 'PaymentAuditServiceApi' do
244
191
  # @param [Hash] opts the optional parameters
245
192
  # @option opts [Integer] :page Page number. Default is 1.
246
193
  # @option opts [Integer] :page_size The number of results to return in a page
247
- # @return [PaymentDeltaResponseV4]
194
+ # @return [PaymentDeltaResponse]
248
195
  describe 'list_payment_changes_v4 test' do
249
196
  skip "skipping broken test" do
250
- # it 'should work' do
251
- # payor_id = ENV['PAYOR'] # String | The Payor ID to find associated Payments
252
- # updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
253
- # opts = {
254
- # page: 1, # Integer | Page number. Default is 1.
255
- # page_size: 100 # Integer | The number of results to return in a page
256
- # }
257
-
258
- # res = @api_instance.list_payment_changes_v4(payor_id, updated_since, opts)
259
- # expect(res.content.length()).to be >= 1
260
- # expect(@api_instance).to respond_to(:list_payment_changes_v4)
197
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
261
198
  end
262
199
  end
263
200
 
@@ -269,7 +206,9 @@ describe 'PaymentAuditServiceApi' do
269
206
  # @option opts [String] :payor_id The account owner Payor Id. Required for external users.
270
207
  # @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
271
208
  # @option opts [String] :remote_id The remote id of the payees.
209
+ # @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
272
210
  # @option opts [String] :status Payment Status
211
+ # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO
273
212
  # @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
274
213
  # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
275
214
  # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
@@ -280,6 +219,11 @@ describe 'PaymentAuditServiceApi' do
280
219
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
281
220
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
282
221
  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
222
+ # @option opts [String] :rails_id Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint.
223
+ # @option opts [Date] :scheduled_for_date_from Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
224
+ # @option opts [Date] :scheduled_for_date_to Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
225
+ # @option opts [String] :schedule_status Payout Schedule Status
226
+ # @option opts [String] :post_instruct_fx_status The status of the post instruct FX step if one was required for the payment
283
227
  # @option opts [Integer] :page Page number. Default is 1.
284
228
  # @option opts [Integer] :page_size The number of results to return in a page
285
229
  # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
@@ -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.29.128
6
+ The version of the OpenAPI document: 2.35.58
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -42,7 +42,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
42
42
  # @return [PayorAmlTransactionV3]
43
43
  describe 'export_transactions_csvv3 test' do
44
44
  it 'should work' do
45
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
46
46
  end
47
47
  end
48
48
 
@@ -57,7 +57,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
57
57
  # @return [GetFundingsResponse]
58
58
  describe 'get_fundings_v1 test' do
59
59
  it 'should work' do
60
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
60
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
61
61
  end
62
62
  end
63
63
 
@@ -70,7 +70,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
70
70
  # @return [PaymentResponseV3]
71
71
  describe 'get_payment_details_v3 test' do
72
72
  it 'should work' do
73
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
73
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
74
74
  end
75
75
  end
76
76
 
@@ -94,7 +94,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
94
94
  # @return [GetPaymentsForPayoutResponseV3]
95
95
  describe 'get_payments_for_payout_pav3 test' do
96
96
  it 'should work' do
97
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
97
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
98
98
  end
99
99
  end
100
100
 
@@ -106,7 +106,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
106
106
  # @return [GetPayoutStatistics]
107
107
  describe 'get_payout_stats_v1 test' do
108
108
  it 'should work' do
109
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
109
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
110
110
  end
111
111
  end
112
112
 
@@ -125,7 +125,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
125
125
  # @return [GetPayoutsResponseV3]
126
126
  describe 'get_payouts_for_payor_v3 test' do
127
127
  it 'should work' do
128
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
129
129
  end
130
130
  end
131
131
 
@@ -140,7 +140,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
140
140
  # @return [PaymentDeltaResponseV1]
141
141
  describe 'list_payment_changes test' do
142
142
  it 'should work' do
143
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
143
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
144
144
  end
145
145
  end
146
146
 
@@ -170,7 +170,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
170
170
  # @return [ListPaymentsResponseV3]
171
171
  describe 'list_payments_audit_v3 test' do
172
172
  it 'should work' do
173
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
173
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
174
174
  end
175
175
  end
176
176
 
@@ -3,43 +3,46 @@
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.29.128
6
+ The version of the OpenAPI document: 2.35.58
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'spec_helper'
14
14
  require 'json'
15
- require 'date'
16
15
 
17
- # Unit tests for VeloPayments::Company2
16
+ # Unit tests for VeloPayments::PayorHierarchyApi
18
17
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
18
  # Please update as you see appropriate
20
- describe VeloPayments::Company2 do
21
- let(:instance) { VeloPayments::Company2.new }
22
-
23
- describe 'test an instance of Company2' do
24
- it 'should create an instance of Company2' do
25
- expect(instance).to be_instance_of(VeloPayments::Company2)
26
- end
19
+ describe 'PayorHierarchyApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = VeloPayments::PayorHierarchyApi.new
27
23
  end
28
- describe 'test attribute "name"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
24
+
25
+ after do
26
+ # run after each test
32
27
  end
33
28
 
34
- describe 'test attribute "tax_id"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
29
+ describe 'test an instance of PayorHierarchyApi' do
30
+ it 'should create an instance of PayorHierarchyApi' do
31
+ expect(@api_instance).to be_instance_of(VeloPayments::PayorHierarchyApi)
37
32
  end
38
33
  end
39
34
 
40
- describe 'test attribute "operating_name"' do
35
+ # unit tests for payor_links_v1
36
+ # List Payor Links
37
+ # <p>If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy</p>
38
+ # @param [Hash] opts the optional parameters
39
+ # @option opts [String] :descendants_of_payor The Payor ID from which to start the query to show all descendants
40
+ # @option opts [String] :parent_of_payor Query for the parent payor details for this payor id
41
+ # @option opts [String] :fields <p>List of additional Payor fields to include in the response for each Payor</p> <p>The values of payorId and payorName are always included for each Payor by default</p> <p>You can add fields to the response for each payor by including them in the fields parameter separated by commas</p> <p>The supported fields are any combination of: primaryContactEmail,kycState</p>
42
+ # @return [PayorLinksResponse]
43
+ describe 'payor_links_v1 test' do
41
44
  it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
46
  end
44
47
  end
45
48
 
@@ -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.22.122
6
+ The version of the OpenAPI document: 2.35.58
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -58,15 +58,15 @@ describe 'PayorsApi' do
58
58
  end
59
59
  end
60
60
 
61
- # unit tests for get_payor_by_id
61
+ # unit tests for get_payor_by_id_v1
62
62
  # Get Payor
63
- # Get a Single Payor by Id.
63
+ # <p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors
64
64
  # @param payor_id The Payor Id
65
65
  # @param [Hash] opts the optional parameters
66
66
  # @return [PayorV1]
67
- describe 'get_payor_by_id test' do
68
- skip "skipping test" do
69
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
+ describe 'get_payor_by_id_v1 test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
70
70
  end
71
71
  end
72
72
 
@@ -77,48 +77,48 @@ describe 'PayorsApi' do
77
77
  # @param [Hash] opts the optional parameters
78
78
  # @return [PayorV2]
79
79
  describe 'get_payor_by_id_v2 test' do
80
- skip "skipping test" do
81
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ it 'should work' do
81
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
82
82
  end
83
83
  end
84
84
 
85
- # unit tests for payor_add_payor_logo
85
+ # unit tests for payor_add_payor_logo_v1
86
86
  # Add Logo
87
- # Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
87
+ # <p>Add Payor Logo</p> <p>Logo file is used in your branding and emails sent to payees</p>
88
88
  # @param payor_id The Payor Id
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @option opts [File] :logo
91
91
  # @return [nil]
92
- describe 'payor_add_payor_logo test' do
93
- skip "skipping test" do
94
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
+ describe 'payor_add_payor_logo_v1 test' do
93
+ it 'should work' do
94
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
95
95
  end
96
96
  end
97
97
 
98
- # unit tests for payor_create_api_key_request
98
+ # unit tests for payor_create_api_key_v1
99
99
  # Create API Key
100
- # Create an an API key for the given payor Id and application Id
100
+ # <p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p>
101
101
  # @param payor_id The Payor Id
102
102
  # @param application_id Application ID
103
103
  # @param payor_create_api_key_request Details of application API key to create
104
104
  # @param [Hash] opts the optional parameters
105
105
  # @return [PayorCreateApiKeyResponse]
106
- describe 'payor_create_api_key_request test' do
107
- skip "skipping test" do
108
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
106
+ describe 'payor_create_api_key_v1 test' do
107
+ it 'should work' do
108
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
109
109
  end
110
110
  end
111
111
 
112
- # unit tests for payor_create_application_request
112
+ # unit tests for payor_create_application_v1
113
113
  # Create Application
114
- # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
114
+ # <p>Create an application for the given Payor ID.</p> <p>Applications provide a means to group your API Keys</p> <p>For example you might have an SAP application that you wish to integrate with Velo</p> <p>You can create an application and then create one or more API keys for the application</p>
115
115
  # @param payor_id The Payor Id
116
116
  # @param payor_create_application_request Details of application to create
117
117
  # @param [Hash] opts the optional parameters
118
118
  # @return [nil]
119
- describe 'payor_create_application_request test' do
120
- skip "skipping test" do
121
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
119
+ describe 'payor_create_application_v1 test' do
120
+ it 'should work' do
121
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
122
122
  end
123
123
  end
124
124
 
@@ -130,8 +130,8 @@ describe 'PayorsApi' do
130
130
  # @param [Hash] opts the optional parameters
131
131
  # @return [nil]
132
132
  describe 'payor_email_opt_out test' do
133
- skip "skipping test" do
134
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
133
+ it 'should work' do
134
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
135
135
  end
136
136
  end
137
137
 
@@ -142,29 +142,8 @@ describe 'PayorsApi' do
142
142
  # @param [Hash] opts the optional parameters
143
143
  # @return [PayorBrandingResponse]
144
144
  describe 'payor_get_branding test' do
145
- skip "skipping test" do
146
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
147
- end
148
- end
149
-
150
- # unit tests for payor_links
151
- # List Payor Links
152
- # This endpoint allows you to list payor links
153
- # @param [Hash] opts the optional parameters
154
- # @option opts [String] :descendants_of_payor The Payor ID from which to start the query to show all descendants
155
- # @option opts [String] :parent_of_payor Look for the parent payor details for this payor id
156
- # @option opts [String] :fields List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState
157
- # @return [PayorLinksResponse]
158
- describe 'payor_links test' do
159
145
  it 'should work' do
160
- opts = {
161
- descendants_of_payor: ENV['PAYOR'], # String | The Payor ID from which to start the query to show all descendants
162
- parent_of_payor: nil, # String | Look for the parent payor details for this payor id
163
- fields: nil # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState
164
- }
165
- res = @api_instance.payor_links(opts)
166
- expect(res.payors.length()).to be >= 0
167
- expect(@api_instance).to respond_to(:payor_links)
146
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
168
147
  end
169
148
  end
170
149
 
@@ -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.22.122
6
+ The version of the OpenAPI document: 2.35.58
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.1.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -39,8 +39,8 @@ describe 'PayorsPrivateApi' do
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [nil]
41
41
  describe 'create_payor_links test' do
42
- skip "skipping test" do
43
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
42
+ it 'should work' do
43
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
44
44
  end
45
45
  end
46
46