velopayments 2.26.124.beta1 → 2.35.58.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (751) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile.lock +72 -0
  3. data/Makefile +8 -18
  4. data/README.md +125 -133
  5. data/credentials +1 -0
  6. data/docs/AcceptedPaymentV3.md +16 -14
  7. data/docs/AuthResponse.md +1 -1
  8. data/docs/{AutoTopUpConfig.md → AutoTopUpConfigV2.md} +2 -2
  9. data/docs/{AutoTopUpConfig2.md → AutoTopUpConfigV3.md} +2 -2
  10. data/docs/{Challenge.md → ChallengeV3.md} +2 -2
  11. data/docs/{Challenge2.md → ChallengeV4.md} +4 -4
  12. data/docs/{Company2.md → CompanyV3.md} +2 -2
  13. data/docs/{Company.md → CompanyV4.md} +2 -2
  14. data/docs/CreateFundingAccountRequestV2.md +4 -4
  15. data/docs/{CreateIndividual.md → CreateIndividualV3.md} +3 -3
  16. data/docs/{CreateIndividualName.md → CreateIndividualV3Name.md} +2 -2
  17. data/docs/{CreateIndividual2.md → CreateIndividualV4.md} +3 -3
  18. data/docs/{CreatePayeeAddress.md → CreatePayeeAddressV3.md} +2 -2
  19. data/docs/{PayeeAddress2.md → CreatePayeeAddressV4.md} +3 -3
  20. data/docs/{CreatePayee.md → CreatePayeeV3.md} +8 -8
  21. data/docs/CreatePayeeV4.md +34 -0
  22. data/docs/CreatePayeesCSVRequestV3.md +74 -0
  23. data/docs/CreatePayeesCSVRequestV4.md +74 -0
  24. data/docs/{CreatePayeesCSVResponse.md → CreatePayeesCSVResponseV3.md} +3 -3
  25. data/docs/{CreatePayeesCSVResponseRejectedCsvRows.md → CreatePayeesCSVResponseV3RejectedCsvRows.md} +2 -2
  26. data/docs/{CreatePayeesCSVResponse2.md → CreatePayeesCSVResponseV4.md} +3 -3
  27. data/docs/{CreatePayeesRequest2.md → CreatePayeesRequestV3.md} +3 -3
  28. data/docs/{CreatePayeesRequest.md → CreatePayeesRequestV4.md} +3 -3
  29. data/docs/{CreatePaymentChannel.md → CreatePaymentChannelV3.md} +6 -6
  30. data/docs/{CreatePaymentChannel2.md → CreatePaymentChannelV4.md} +6 -6
  31. data/docs/{FailedPayee.md → FailedPayeeV3.md} +8 -8
  32. data/docs/{FailedPayee2.md → FailedPayeeV4.md} +9 -9
  33. data/docs/{FailedSubmission.md → FailedSubmissionV3.md} +3 -3
  34. data/docs/{FailedSubmission2.md → FailedSubmissionV4.md} +3 -3
  35. data/docs/{FundingAccountResponse2.md → FundingAccountResponseV2.md} +4 -4
  36. data/docs/FundingApi.md +459 -0
  37. data/docs/FundingAudit.md +3 -3
  38. data/docs/FundingEvent.md +1 -1
  39. data/docs/FundingManagerPrivateApi.md +2 -2
  40. data/docs/FundingResponse.md +44 -0
  41. data/docs/FxSummary.md +6 -6
  42. data/docs/FxSummaryV3.md +4 -4
  43. data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md} +2 -2
  44. data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md} +2 -2
  45. data/docs/GetPayeeListResponseIndividualV3.md +18 -0
  46. data/docs/GetPayeeListResponseIndividualV4.md +18 -0
  47. data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md} +8 -8
  48. data/docs/{GetPayeeListResponse2.md → GetPayeeListResponseV4.md} +9 -9
  49. data/docs/GetPaymentsForPayoutResponseV3Summary.md +1 -1
  50. data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
  51. data/docs/GetPaymentsForPayoutResponseV4Summary.md +5 -3
  52. data/docs/GetPayoutsResponse.md +2 -2
  53. data/docs/{Individual.md → IndividualV3.md} +3 -3
  54. data/docs/{IndividualName.md → IndividualV3Name.md} +2 -2
  55. data/docs/{Individual2.md → IndividualV4.md} +3 -3
  56. data/docs/InstructPayoutRequestV3.md +18 -0
  57. data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
  58. data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
  59. data/docs/InviteUserRequest.md +5 -3
  60. data/docs/ListFundingAccountsResponseV2.md +22 -0
  61. data/docs/{ListSourceAccountResponseLinks.md → ListFundingAccountsResponseV2Links.md} +2 -2
  62. data/docs/{ListSourceAccountResponsePage.md → ListFundingAccountsResponseV2Page.md} +2 -2
  63. data/docs/LoginApi.md +1 -1
  64. data/docs/{Name.md → NameV3.md} +2 -2
  65. data/docs/{Name2.md → NameV4.md} +2 -2
  66. data/docs/Notification.md +2 -2
  67. data/docs/NotificationSource.md +94 -0
  68. data/docs/{Notifications.md → NotificationsV2.md} +2 -2
  69. data/docs/{Notifications2.md → NotificationsV3.md} +2 -2
  70. data/docs/PagedPayeeInvitationStatusResponseV3.md +22 -0
  71. data/docs/{PagedPayeeInvitationStatusResponsePage.md → PagedPayeeInvitationStatusResponseV3Page.md} +2 -2
  72. data/docs/PagedPayeeInvitationStatusResponseV4.md +22 -0
  73. data/docs/PagedPayeeResponseV3.md +24 -0
  74. data/docs/{PagedPayeeResponseLinks.md → PagedPayeeResponseV3Links.md} +2 -2
  75. data/docs/{PagedPayeeResponsePage.md → PagedPayeeResponseV3Page.md} +2 -2
  76. data/docs/{PagedPayeeResponseSummary.md → PagedPayeeResponseV3Summary.md} +2 -2
  77. data/docs/PagedPayeeResponseV4.md +24 -0
  78. data/docs/PagedPaymentsResponseV3.md +2 -2
  79. data/docs/{PayableIssue.md → PayableIssueV3.md} +2 -2
  80. data/docs/{PayableIssue2.md → PayableIssueV4.md} +2 -2
  81. data/docs/{CreatePayeeAddress2.md → PayeeAddressV3.md} +3 -3
  82. data/docs/{PayeeAddress.md → PayeeAddressV4.md} +2 -2
  83. data/docs/PayeeDeltaResponseV3.md +22 -0
  84. data/docs/{PayeeDeltaResponseLinks.md → PayeeDeltaResponseV3Links.md} +2 -2
  85. data/docs/{PayeeDeltaResponsePage.md → PayeeDeltaResponseV3Page.md} +2 -2
  86. data/docs/PayeeDeltaResponseV4.md +22 -0
  87. data/docs/{PayeeDeltaResponse2Links.md → PayeeDeltaResponseV4Links.md} +2 -2
  88. data/docs/{PayeeDelta.md → PayeeDeltaV3.md} +3 -3
  89. data/docs/{PayeeDelta2.md → PayeeDeltaV4.md} +4 -4
  90. data/docs/{PayeeDetailResponse2.md → PayeeDetailResponseV3.md} +11 -11
  91. data/docs/{PayeeDetailResponse.md → PayeeDetailResponseV4.md} +10 -10
  92. data/docs/PayeeInvitationApi.md +127 -127
  93. data/docs/{PayeeInvitationStatusResponse.md → PayeeInvitationStatusResponseV3.md} +3 -3
  94. data/docs/{PayeeInvitationStatusResponse2.md → PayeeInvitationStatusResponseV4.md} +3 -3
  95. data/docs/PayeePayorRefV3.md +2 -2
  96. data/docs/{PayeePayorRef.md → PayeePayorRefV4.md} +4 -4
  97. data/docs/{PayoutStatus.md → PayeeTypeEnum.md} +2 -2
  98. data/docs/PayeesApi.md +91 -91
  99. data/docs/PaymentAuditServiceApi.md +44 -24
  100. data/docs/PaymentAuditServiceDeprecatedApi.md +18 -18
  101. data/docs/PaymentChannelRule.md +3 -1
  102. data/docs/PaymentDeltaResponse.md +2 -2
  103. data/docs/PaymentDeltaResponseV1.md +2 -2
  104. data/docs/PaymentEventResponse.md +12 -6
  105. data/docs/PaymentEventResponseV3.md +3 -3
  106. data/docs/PaymentInstructionV3.md +3 -3
  107. data/docs/PaymentResponseV3.md +6 -4
  108. data/docs/PaymentResponseV4.md +17 -7
  109. data/docs/PaymentV3.md +25 -21
  110. data/docs/PayorBrandingResponse.md +3 -3
  111. data/docs/PayorCreateApiKeyRequest.md +2 -2
  112. data/docs/PayorHierarchyApi.md +83 -0
  113. data/docs/PayorLinksResponseLinks.md +1 -1
  114. data/docs/PayorLinksResponsePayors.md +1 -1
  115. data/docs/PayorV1.md +2 -2
  116. data/docs/PayorV2.md +13 -5
  117. data/docs/PayorsApi.md +57 -133
  118. data/docs/PayoutSchedule.md +28 -0
  119. data/docs/PayoutScheduleV3.md +26 -0
  120. data/docs/PayoutSummaryAudit.md +5 -3
  121. data/docs/PayoutSummaryAuditV3.md +1 -1
  122. data/docs/PayoutSummaryResponseV3.md +12 -10
  123. data/docs/{PayoutServiceApi.md → PayoutsApi.md} +194 -48
  124. data/docs/PingResponse.md +20 -0
  125. data/docs/PostInstructFxInfo.md +24 -0
  126. data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md} +4 -4
  127. data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md} +4 -4
  128. data/docs/QuoteFxSummaryV3.md +15 -15
  129. data/docs/RejectedPaymentV3.md +16 -16
  130. data/docs/SchedulePayoutRequestV3.md +20 -0
  131. data/docs/SetNotificationsRequest2.md +18 -0
  132. data/docs/SourceAccountResponseV2.md +2 -2
  133. data/docs/SourceAccountResponseV3.md +4 -4
  134. data/docs/SourceAccountSummary.md +2 -2
  135. data/docs/SourceAccountSummaryV3.md +1 -1
  136. data/docs/SourceAccountV3.md +5 -5
  137. data/docs/SourceAccountsApi.md +603 -0
  138. data/docs/TokensApi.md +2 -2
  139. data/docs/{TransferRequest.md → TransferRequestV2.md} +2 -2
  140. data/docs/{TransferRequest2.md → TransferRequestV3.md} +3 -3
  141. data/docs/{UpdatePayeeDetailsRequest.md → UpdatePayeeDetailsRequestV3.md} +7 -7
  142. data/docs/UpdatePayeeDetailsRequestV4.md +32 -0
  143. data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
  144. data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
  145. data/docs/UserResponse.md +4 -0
  146. data/docs/UsersApi.md +24 -22
  147. data/docs/WebhooksApi.md +74 -6
  148. data/docs/WebhooksResponse.md +2 -2
  149. data/lib/velopayments/api/countries_api.rb +2 -2
  150. data/lib/velopayments/api/currencies_api.rb +2 -2
  151. data/lib/velopayments/api/funding_api.rb +481 -0
  152. data/lib/velopayments/api/funding_manager_private_api.rb +6 -3
  153. data/lib/velopayments/api/login_api.rb +13 -7
  154. data/lib/velopayments/api/payee_invitation_api.rb +124 -112
  155. data/lib/velopayments/api/payees_api.rb +98 -86
  156. data/lib/velopayments/api/payment_audit_service_api.rb +62 -20
  157. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +12 -12
  158. data/{spec/models/create_webhook_request_spec.rb → lib/velopayments/api/payor_hierarchy_api.rb} +67 -37
  159. data/lib/velopayments/api/payors_api.rb +57 -111
  160. data/lib/velopayments/api/payors_private_api.rb +6 -3
  161. data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +189 -43
  162. data/lib/velopayments/api/source_accounts_api.rb +632 -0
  163. data/lib/velopayments/api/tokens_api.rb +6 -3
  164. data/lib/velopayments/api/users_api.rb +48 -15
  165. data/lib/velopayments/api/webhooks_api.rb +71 -6
  166. data/lib/velopayments/api_client.rb +8 -6
  167. data/lib/velopayments/api_error.rb +3 -2
  168. data/lib/velopayments/configuration.rb +33 -13
  169. data/lib/velopayments/models/accepted_payment_v3.rb +193 -23
  170. data/lib/velopayments/models/access_token_response.rb +15 -19
  171. data/lib/velopayments/models/access_token_validation_request.rb +17 -19
  172. data/lib/velopayments/models/auth_response.rb +19 -19
  173. data/lib/velopayments/models/{auto_top_up_config.rb → auto_top_up_config_v2.rb} +20 -22
  174. data/lib/velopayments/models/{auto_top_up_config2.rb → auto_top_up_config_v3.rb} +20 -22
  175. data/lib/velopayments/models/category.rb +8 -5
  176. data/lib/velopayments/models/{challenge2.rb → challenge_v3.rb} +22 -22
  177. data/lib/velopayments/models/{challenge.rb → challenge_v4.rb} +24 -22
  178. data/lib/velopayments/models/{company.rb → company_v3.rb} +20 -22
  179. data/lib/velopayments/models/{company2.rb → company_v4.rb} +20 -22
  180. data/lib/velopayments/models/create_funding_account_request_v2.rb +55 -37
  181. data/lib/velopayments/models/{create_individual.rb → create_individual_v3.rb} +29 -25
  182. data/lib/velopayments/models/{individual_name.rb → create_individual_v3_name.rb} +34 -26
  183. data/lib/velopayments/models/{create_individual2.rb → create_individual_v4.rb} +29 -25
  184. data/lib/velopayments/models/{create_payee_address2.rb → create_payee_address_v3.rb} +37 -51
  185. data/lib/velopayments/models/{create_payee_address.rb → create_payee_address_v4.rb} +49 -52
  186. data/lib/velopayments/models/{create_payee.rb → create_payee_v3.rb} +33 -28
  187. data/lib/velopayments/models/{create_payee2.rb → create_payee_v4.rb} +55 -50
  188. data/lib/velopayments/models/create_payees_csv_request_v3.rb +1277 -0
  189. data/lib/velopayments/models/create_payees_csv_request_v4.rb +1277 -0
  190. data/lib/velopayments/models/{create_payees_csv_response.rb → create_payees_csv_response_v3.rb} +19 -23
  191. data/lib/velopayments/models/{create_payees_csv_response_rejected_csv_rows.rb → create_payees_csv_response_v3_rejected_csv_rows.rb} +18 -22
  192. data/lib/velopayments/models/{create_payees_csv_response2.rb → create_payees_csv_response_v4.rb} +19 -23
  193. data/lib/velopayments/models/{create_payees_request.rb → create_payees_request_v3.rb} +23 -23
  194. data/lib/velopayments/models/{create_payees_request2.rb → create_payees_request_v4.rb} +23 -23
  195. data/lib/velopayments/models/{create_payment_channel.rb → create_payment_channel_v3.rb} +104 -67
  196. data/lib/velopayments/models/{create_payment_channel2.rb → create_payment_channel_v4.rb} +104 -67
  197. data/lib/velopayments/models/create_payor_link_request.rb +21 -19
  198. data/lib/velopayments/models/create_payout_request_v3.rb +22 -20
  199. data/lib/velopayments/models/create_webhook_request.rb +28 -22
  200. data/lib/velopayments/models/debit_event.rb +23 -19
  201. data/lib/velopayments/models/debit_event_all_of.rb +17 -19
  202. data/lib/velopayments/models/debit_status_changed.rb +25 -19
  203. data/lib/velopayments/models/debit_status_changed_all_of.rb +17 -19
  204. data/lib/velopayments/models/error.rb +15 -19
  205. data/lib/velopayments/models/error_data.rb +15 -19
  206. data/lib/velopayments/models/error_response.rb +20 -20
  207. data/lib/velopayments/models/{failed_payee.rb → failed_payee_v3.rb} +25 -28
  208. data/lib/velopayments/models/{failed_payee2.rb → failed_payee_v4.rb} +26 -29
  209. data/lib/velopayments/models/{failed_submission.rb → failed_submission_v3.rb} +19 -23
  210. data/lib/velopayments/models/{failed_submission2.rb → failed_submission_v4.rb} +19 -23
  211. data/lib/velopayments/models/{funding_account_response2.rb → funding_account_response_v2.rb} +43 -28
  212. data/lib/velopayments/models/funding_audit.rb +18 -77
  213. data/lib/velopayments/models/funding_event.rb +17 -20
  214. data/lib/velopayments/models/funding_payor_status_audit_response.rb +22 -22
  215. data/lib/velopayments/models/funding_request_v2.rb +17 -19
  216. data/lib/velopayments/models/funding_request_v3.rb +19 -19
  217. data/lib/velopayments/models/{source_account_response.rb → funding_response.rb} +178 -138
  218. data/lib/velopayments/models/fx_summary.rb +87 -61
  219. data/lib/velopayments/models/fx_summary_v3.rb +87 -61
  220. data/lib/velopayments/models/get_fundings_response.rb +15 -19
  221. data/lib/velopayments/models/get_fundings_response_links.rb +15 -19
  222. data/lib/velopayments/models/{get_payee_list_response_company.rb → get_payee_list_response_company_v3.rb} +24 -24
  223. data/lib/velopayments/models/{get_payee_list_response_company2.rb → get_payee_list_response_company_v4.rb} +24 -24
  224. data/lib/velopayments/models/{get_payee_list_response_individual.rb → get_payee_list_response_individual_v3.rb} +19 -23
  225. data/lib/velopayments/models/{get_payee_list_response_individual2.rb → get_payee_list_response_individual_v4.rb} +19 -23
  226. data/lib/velopayments/models/{get_payee_list_response.rb → get_payee_list_response_v3.rb} +66 -27
  227. data/lib/velopayments/models/{get_payee_list_response2.rb → get_payee_list_response_v4.rb} +67 -28
  228. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +15 -19
  229. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +15 -19
  230. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +16 -54
  231. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +17 -21
  232. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +32 -25
  233. data/lib/velopayments/models/get_payout_statistics.rb +19 -19
  234. data/lib/velopayments/models/get_payouts_response.rb +17 -21
  235. data/lib/velopayments/models/get_payouts_response_v3.rb +15 -19
  236. data/lib/velopayments/models/get_payouts_response_v3_links.rb +15 -19
  237. data/lib/velopayments/models/get_payouts_response_v3_page.rb +15 -19
  238. data/lib/velopayments/models/{individual.rb → individual_v3.rb} +29 -25
  239. data/lib/velopayments/models/{create_individual_name.rb → individual_v3_name.rb} +34 -26
  240. data/lib/velopayments/models/{individual2.rb → individual_v4.rb} +29 -25
  241. data/lib/velopayments/models/inline_response400.rb +15 -19
  242. data/lib/velopayments/models/inline_response401.rb +15 -19
  243. data/lib/velopayments/models/inline_response403.rb +15 -19
  244. data/lib/velopayments/models/inline_response404.rb +15 -19
  245. data/lib/velopayments/models/inline_response409.rb +15 -19
  246. data/lib/velopayments/models/inline_response412.rb +15 -19
  247. data/lib/velopayments/models/instruct_payout_request_v3.rb +215 -0
  248. data/lib/velopayments/models/{invite_payee_request.rb → invite_payee_request_v3.rb} +20 -22
  249. data/lib/velopayments/models/{invite_payee_request2.rb → invite_payee_request_v4.rb} +20 -22
  250. data/lib/velopayments/models/invite_user_request.rb +62 -26
  251. data/lib/velopayments/models/link_for_response.rb +15 -19
  252. data/lib/velopayments/models/{list_funding_accounts_response2.rb → list_funding_accounts_response_v2.rb} +21 -25
  253. data/lib/velopayments/models/{payee_delta_response_links.rb → list_funding_accounts_response_v2_links.rb} +18 -22
  254. data/lib/velopayments/models/{paged_payee_response_page.rb → list_funding_accounts_response_v2_page.rb} +18 -22
  255. data/lib/velopayments/models/list_payments_response_v3.rb +15 -19
  256. data/lib/velopayments/models/list_payments_response_v3_page.rb +15 -19
  257. data/lib/velopayments/models/list_payments_response_v4.rb +15 -19
  258. data/lib/velopayments/models/list_source_account_response_v2.rb +15 -19
  259. data/lib/velopayments/models/list_source_account_response_v2_links.rb +15 -19
  260. data/lib/velopayments/models/list_source_account_response_v3.rb +15 -19
  261. data/lib/velopayments/models/list_source_account_response_v3_links.rb +15 -19
  262. data/lib/velopayments/models/localisation_details.rb +15 -19
  263. data/lib/velopayments/models/mfa_details.rb +37 -19
  264. data/lib/velopayments/models/mfa_type.rb +8 -5
  265. data/lib/velopayments/models/{name.rb → name_v3.rb} +42 -30
  266. data/lib/velopayments/models/{name2.rb → name_v4.rb} +42 -30
  267. data/lib/velopayments/models/notification.rb +24 -21
  268. data/lib/velopayments/models/{funding_event_type.rb → notification_source.rb} +48 -24
  269. data/lib/velopayments/models/{notifications.rb → notifications_v2.rb} +18 -22
  270. data/lib/velopayments/models/{notifications2.rb → notifications_v3.rb} +18 -22
  271. data/lib/velopayments/models/onboarding_status_changed.rb +23 -19
  272. data/lib/velopayments/models/page_for_response.rb +15 -19
  273. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +15 -19
  274. data/lib/velopayments/models/{paged_payee_invitation_status_response.rb → paged_payee_invitation_status_response_v3.rb} +21 -25
  275. data/lib/velopayments/models/{paged_payee_invitation_status_response_page.rb → paged_payee_invitation_status_response_v3_page.rb} +18 -22
  276. data/lib/velopayments/models/{paged_payee_invitation_status_response2.rb → paged_payee_invitation_status_response_v4.rb} +21 -25
  277. data/lib/velopayments/models/{paged_payee_response.rb → paged_payee_response_v3.rb} +22 -26
  278. data/lib/velopayments/models/{paged_payee_response_links.rb → paged_payee_response_v3_links.rb} +18 -22
  279. data/lib/velopayments/models/{payee_delta_response_page.rb → paged_payee_response_v3_page.rb} +18 -22
  280. data/lib/velopayments/models/{paged_payee_response_summary.rb → paged_payee_response_v3_summary.rb} +18 -22
  281. data/lib/velopayments/models/{paged_payee_response2.rb → paged_payee_response_v4.rb} +22 -26
  282. data/lib/velopayments/models/paged_payments_response_v3.rb +17 -21
  283. data/lib/velopayments/models/paged_user_response.rb +15 -19
  284. data/lib/velopayments/models/paged_user_response_links.rb +15 -19
  285. data/lib/velopayments/models/paged_user_response_page.rb +15 -19
  286. data/lib/velopayments/models/password_request.rb +17 -19
  287. data/lib/velopayments/models/{payable_issue.rb → payable_issue_v3.rb} +22 -22
  288. data/lib/velopayments/models/{payable_issue2.rb → payable_issue_v4.rb} +22 -22
  289. data/lib/velopayments/models/payable_status_changed.rb +23 -19
  290. data/lib/velopayments/models/{payee_address2.rb → payee_address_v3.rb} +41 -27
  291. data/lib/velopayments/models/{payee_address.rb → payee_address_v4.rb} +24 -22
  292. data/lib/velopayments/models/{payee_delta_response.rb → payee_delta_response_v3.rb} +21 -25
  293. data/lib/velopayments/models/{payee_delta_response2_links.rb → payee_delta_response_v3_links.rb} +18 -22
  294. data/lib/velopayments/models/{list_source_account_response_page.rb → payee_delta_response_v3_page.rb} +18 -22
  295. data/lib/velopayments/models/{payee_delta_response2.rb → payee_delta_response_v4.rb} +21 -25
  296. data/lib/velopayments/models/{list_source_account_response_links.rb → payee_delta_response_v4_links.rb} +18 -22
  297. data/lib/velopayments/models/{payee_delta.rb → payee_delta_v3.rb} +24 -23
  298. data/lib/velopayments/models/{payee_delta2.rb → payee_delta_v4.rb} +64 -23
  299. data/lib/velopayments/models/{payee_detail_response2.rb → payee_detail_response_v3.rb} +69 -30
  300. data/lib/velopayments/models/{payee_detail_response.rb → payee_detail_response_v4.rb} +29 -30
  301. data/lib/velopayments/models/payee_details_changed.rb +23 -19
  302. data/lib/velopayments/models/payee_event.rb +23 -19
  303. data/lib/velopayments/models/payee_event_all_of.rb +17 -19
  304. data/lib/velopayments/models/payee_event_all_of_reasons.rb +19 -19
  305. data/lib/velopayments/models/{payee_invitation_status_response.rb → payee_invitation_status_response_v3.rb} +23 -56
  306. data/lib/velopayments/models/{payee_invitation_status_response2.rb → payee_invitation_status_response_v4.rb} +23 -56
  307. data/lib/velopayments/models/payee_payor_ref_v3.rb +17 -21
  308. data/lib/velopayments/models/{payee_payor_ref.rb → payee_payor_ref_v4.rb} +20 -24
  309. data/lib/velopayments/models/payee_type.rb +10 -7
  310. data/lib/velopayments/models/{payment_rails.rb → payee_type_enum.rb} +11 -8
  311. data/lib/velopayments/models/payee_user_self_update_request.rb +15 -19
  312. data/lib/velopayments/models/payment_channel_country.rb +19 -19
  313. data/lib/velopayments/models/payment_channel_rule.rb +37 -23
  314. data/lib/velopayments/models/payment_channel_rules_response.rb +15 -19
  315. data/lib/velopayments/models/payment_delta.rb +19 -19
  316. data/lib/velopayments/models/payment_delta_response.rb +17 -21
  317. data/lib/velopayments/models/payment_delta_response_v1.rb +17 -21
  318. data/lib/velopayments/models/payment_delta_v1.rb +19 -19
  319. data/lib/velopayments/models/payment_event.rb +23 -19
  320. data/lib/velopayments/models/payment_event_all_of.rb +17 -19
  321. data/lib/velopayments/models/payment_event_response.rb +109 -55
  322. data/lib/velopayments/models/payment_event_response_v3.rb +79 -53
  323. data/lib/velopayments/models/payment_instruction_v3.rb +84 -29
  324. data/lib/velopayments/models/payment_rejected_or_returned.rb +29 -19
  325. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +19 -19
  326. data/lib/velopayments/models/payment_response_v3.rb +101 -63
  327. data/lib/velopayments/models/payment_response_v4.rb +139 -63
  328. data/lib/velopayments/models/payment_response_v4_payout.rb +15 -19
  329. data/lib/velopayments/models/payment_status_changed.rb +25 -19
  330. data/lib/velopayments/models/payment_status_changed_all_of.rb +17 -19
  331. data/lib/velopayments/models/payment_v3.rb +167 -55
  332. data/lib/velopayments/models/payor_address.rb +21 -19
  333. data/lib/velopayments/models/payor_address_v2.rb +21 -19
  334. data/lib/velopayments/models/payor_aml_transaction.rb +15 -19
  335. data/lib/velopayments/models/payor_aml_transaction_v3.rb +15 -19
  336. data/lib/velopayments/models/payor_branding_response.rb +20 -20
  337. data/lib/velopayments/models/payor_create_api_key_request.rb +23 -23
  338. data/lib/velopayments/models/payor_create_api_key_response.rb +15 -19
  339. data/lib/velopayments/models/payor_create_application_request.rb +17 -19
  340. data/lib/velopayments/models/payor_email_opt_out_request.rb +17 -19
  341. data/lib/velopayments/models/payor_links_response.rb +15 -19
  342. data/lib/velopayments/models/payor_links_response_links.rb +24 -53
  343. data/lib/velopayments/models/payor_links_response_payors.rb +20 -53
  344. data/lib/velopayments/models/payor_v1.rb +19 -54
  345. data/lib/velopayments/models/payor_v2.rb +65 -58
  346. data/lib/velopayments/models/payout_company_v3.rb +17 -19
  347. data/lib/velopayments/models/payout_individual_v3.rb +17 -19
  348. data/lib/velopayments/models/payout_name_v3.rb +19 -19
  349. data/lib/velopayments/models/payout_payee_v3.rb +17 -19
  350. data/lib/velopayments/models/payout_payor.rb +25 -19
  351. data/lib/velopayments/models/payout_payor_ids.rb +21 -19
  352. data/lib/velopayments/models/payout_principal.rb +19 -19
  353. data/lib/velopayments/models/payout_schedule.rb +298 -0
  354. data/lib/velopayments/models/payout_schedule_v3.rb +288 -0
  355. data/lib/velopayments/models/payout_summary_audit.rb +40 -25
  356. data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
  357. data/lib/velopayments/models/payout_summary_response_v3.rb +44 -23
  358. data/lib/velopayments/models/ping.rb +21 -19
  359. data/lib/velopayments/models/ping_response.rb +223 -0
  360. data/lib/velopayments/models/post_instruct_fx_info.rb +267 -0
  361. data/lib/velopayments/models/{query_batch_response.rb → query_batch_response_v3.rb} +20 -58
  362. data/lib/velopayments/models/{query_batch_response2.rb → query_batch_response_v4.rb} +20 -58
  363. data/lib/velopayments/models/quote_fx_summary_v3.rb +42 -65
  364. data/lib/velopayments/models/quote_response_v3.rb +15 -19
  365. data/lib/velopayments/models/region_v2.rb +15 -19
  366. data/lib/velopayments/models/register_sms_request.rb +17 -19
  367. data/lib/velopayments/models/rejected_payment_v3.rb +121 -19
  368. data/lib/velopayments/models/resend_token_request.rb +17 -19
  369. data/lib/velopayments/models/reset_password_request.rb +17 -19
  370. data/lib/velopayments/models/role.rb +17 -19
  371. data/lib/velopayments/models/role_update_request.rb +17 -19
  372. data/lib/velopayments/models/{funding_request_v1.rb → schedule_payout_request_v3.rb} +46 -59
  373. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +17 -19
  374. data/lib/velopayments/models/self_update_password_request.rb +19 -19
  375. data/lib/velopayments/models/set_notifications_request.rb +17 -19
  376. data/lib/velopayments/models/set_notifications_request2.rb +250 -0
  377. data/lib/velopayments/models/source_account_response_v2.rb +44 -50
  378. data/lib/velopayments/models/source_account_response_v3.rb +66 -53
  379. data/lib/velopayments/models/source_account_summary.rb +49 -20
  380. data/lib/velopayments/models/source_account_summary_v3.rb +49 -20
  381. data/lib/velopayments/models/source_account_v3.rb +26 -19
  382. data/lib/velopayments/models/source_event.rb +21 -19
  383. data/lib/velopayments/models/supported_countries_response.rb +15 -19
  384. data/lib/velopayments/models/supported_countries_response_v2.rb +15 -19
  385. data/lib/velopayments/models/supported_country.rb +22 -22
  386. data/lib/velopayments/models/supported_country_v2.rb +22 -22
  387. data/lib/velopayments/models/supported_currency_response_v2.rb +15 -19
  388. data/lib/velopayments/models/supported_currency_v2.rb +22 -22
  389. data/lib/velopayments/models/{transfer_request2.rb → transfer_request_v2.rb} +24 -22
  390. data/lib/velopayments/models/{transfer_request.rb → transfer_request_v3.rb} +36 -22
  391. data/lib/velopayments/models/transmission_types.rb +21 -19
  392. data/lib/velopayments/models/transmission_types2.rb +21 -19
  393. data/lib/velopayments/models/unregister_mfa_request.rb +17 -19
  394. data/lib/velopayments/models/{update_payee_details_request.rb → update_payee_details_request_v3.rb} +45 -27
  395. data/lib/velopayments/models/{update_payee_details_request2.rb → update_payee_details_request_v4.rb} +81 -32
  396. data/lib/velopayments/models/{update_remote_id_request2.rb → update_remote_id_request_v3.rb} +22 -22
  397. data/lib/velopayments/models/{update_remote_id_request.rb → update_remote_id_request_v4.rb} +22 -22
  398. data/lib/velopayments/models/update_webhook_request.rb +21 -21
  399. data/lib/velopayments/models/user_details_update_request.rb +37 -19
  400. data/lib/velopayments/models/user_info.rb +37 -19
  401. data/lib/velopayments/models/user_response.rb +108 -28
  402. data/lib/velopayments/models/user_status.rb +8 -5
  403. data/lib/velopayments/models/user_type.rb +8 -5
  404. data/lib/velopayments/models/user_type2.rb +8 -5
  405. data/lib/velopayments/models/validate_password_response.rb +21 -21
  406. data/lib/velopayments/models/webhook_response.rb +15 -19
  407. data/lib/velopayments/models/webhooks_response.rb +17 -21
  408. data/lib/velopayments/models/withdraw_payment_request.rb +17 -19
  409. data/lib/velopayments/version.rb +3 -3
  410. data/lib/velopayments.rb +93 -102
  411. data/oa3-config.json +1 -1
  412. data/spec/api/countries_api_spec.rb +41 -6
  413. data/spec/api/currencies_api_spec.rb +5 -3
  414. data/spec/api/funding_api_spec.rb +169 -0
  415. data/spec/api/funding_manager_private_api_spec.rb +4 -4
  416. data/spec/api/login_api_spec.rb +11 -11
  417. data/spec/api/payee_invitation_api_spec.rb +74 -38
  418. data/spec/api/payees_api_spec.rb +77 -43
  419. data/spec/api/payment_audit_service_api_spec.rb +97 -18
  420. data/spec/api/payment_audit_service_deprecated_api_spec.rb +10 -10
  421. data/spec/{models/get_fundings_response_links_spec.rb → api/payor_hierarchy_api_spec.rb} +24 -15
  422. data/spec/api/payors_api_spec.rb +47 -35
  423. data/spec/api/payors_private_api_spec.rb +3 -3
  424. data/spec/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +43 -17
  425. data/spec/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +81 -162
  426. data/spec/api/tokens_api_spec.rb +3 -3
  427. data/spec/api/users_api_spec.rb +46 -19
  428. data/spec/api/webhooks_api_spec.rb +16 -6
  429. data/spec/api_client_spec.rb +6 -4
  430. data/spec/configuration_spec.rb +2 -2
  431. data/spec/spec_helper.rb +2 -2
  432. data/specs/api/countries_api_spec.rb +19 -19
  433. data/specs/api/currencies_api_spec.rb +2 -2
  434. data/specs/api/funding_api_spec.rb +169 -0
  435. data/specs/api/funding_manager_private_api_spec.rb +16 -4
  436. data/specs/api/login_api_spec.rb +8 -7
  437. data/specs/api/payee_invitation_api_spec.rb +55 -39
  438. data/specs/api/payees_api_spec.rb +107 -45
  439. data/specs/api/payment_audit_service_api_spec.rb +29 -85
  440. data/specs/api/payment_audit_service_deprecated_api_spec.rb +177 -0
  441. data/{spec/models/company2_spec.rb → specs/api/payor_hierarchy_api_spec.rb} +23 -20
  442. data/specs/api/payors_api_spec.rb +27 -48
  443. data/specs/api/payors_private_api_spec.rb +4 -4
  444. data/specs/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +51 -24
  445. data/specs/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +36 -208
  446. data/specs/api/tokens_api_spec.rb +4 -4
  447. data/specs/api/users_api_spec.rb +38 -47
  448. data/{spec/models/failed_payee_spec.rb → specs/api/webhooks_api_spec.rb} +53 -51
  449. data/velopayments.gemspec +3 -3
  450. metadata +213 -724
  451. data/docs/CreatePayee2.md +0 -38
  452. data/docs/FundingAccountResponse.md +0 -36
  453. data/docs/FundingAccountType.md +0 -15
  454. data/docs/FundingEventType.md +0 -15
  455. data/docs/FundingManagerApi.md +0 -1291
  456. data/docs/FundingRequestV1.md +0 -18
  457. data/docs/GetPayeeListResponseIndividual.md +0 -18
  458. data/docs/GetPayeeListResponseIndividual2.md +0 -18
  459. data/docs/InvitationStatus.md +0 -15
  460. data/docs/InvitationStatus2.md +0 -15
  461. data/docs/KycState.md +0 -15
  462. data/docs/ListFundingAccountsResponse.md +0 -22
  463. data/docs/ListFundingAccountsResponse2.md +0 -22
  464. data/docs/ListSourceAccountResponse.md +0 -22
  465. data/docs/OfacStatus.md +0 -15
  466. data/docs/OnboardedStatus.md +0 -15
  467. data/docs/OnboardedStatus2.md +0 -15
  468. data/docs/PagedPayeeInvitationStatusResponse.md +0 -22
  469. data/docs/PagedPayeeInvitationStatusResponse2.md +0 -22
  470. data/docs/PagedPayeeResponse.md +0 -24
  471. data/docs/PagedPayeeResponse2.md +0 -24
  472. data/docs/PayeeDeltaResponse.md +0 -22
  473. data/docs/PayeeDeltaResponse2.md +0 -22
  474. data/docs/PaymentAuditCurrency.md +0 -15
  475. data/docs/PaymentAuditCurrencyV3.md +0 -15
  476. data/docs/PaymentRails.md +0 -15
  477. data/docs/PayoutStatusV3.md +0 -15
  478. data/docs/PayoutType.md +0 -15
  479. data/docs/SourceAccountResponse.md +0 -44
  480. data/docs/SourceAccountType.md +0 -15
  481. data/docs/TransmissionType.md +0 -15
  482. data/docs/UpdatePayeeDetailsRequest2.md +0 -30
  483. data/docs/WatchlistStatus.md +0 -15
  484. data/docs/WatchlistStatus2.md +0 -15
  485. data/lib/velopayments/api/funding_manager_api.rb +0 -1312
  486. data/lib/velopayments/models/funding_account_response.rb +0 -357
  487. data/lib/velopayments/models/funding_account_type.rb +0 -37
  488. data/lib/velopayments/models/invitation_status.rb +0 -38
  489. data/lib/velopayments/models/invitation_status2.rb +0 -38
  490. data/lib/velopayments/models/kyc_state.rb +0 -38
  491. data/lib/velopayments/models/list_funding_accounts_response.rb +0 -241
  492. data/lib/velopayments/models/list_source_account_response.rb +0 -241
  493. data/lib/velopayments/models/ofac_status.rb +0 -38
  494. data/lib/velopayments/models/onboarded_status.rb +0 -39
  495. data/lib/velopayments/models/onboarded_status2.rb +0 -39
  496. data/lib/velopayments/models/payment_audit_currency.rb +0 -38
  497. data/lib/velopayments/models/payment_audit_currency_v3.rb +0 -38
  498. data/lib/velopayments/models/payout_status.rb +0 -44
  499. data/lib/velopayments/models/payout_status_v3.rb +0 -44
  500. data/lib/velopayments/models/payout_type.rb +0 -38
  501. data/lib/velopayments/models/source_account_type.rb +0 -37
  502. data/lib/velopayments/models/transmission_type.rb +0 -38
  503. data/lib/velopayments/models/watchlist_status.rb +0 -40
  504. data/lib/velopayments/models/watchlist_status2.rb +0 -40
  505. data/spec/models/accepted_payment_v3_spec.rb +0 -76
  506. data/spec/models/access_token_response_spec.rb +0 -70
  507. data/spec/models/access_token_validation_request_spec.rb +0 -34
  508. data/spec/models/auth_response_spec.rb +0 -64
  509. data/spec/models/auto_top_up_config2_spec.rb +0 -52
  510. data/spec/models/auto_top_up_config_spec.rb +0 -46
  511. data/spec/models/category_spec.rb +0 -28
  512. data/spec/models/challenge2_spec.rb +0 -40
  513. data/spec/models/challenge_spec.rb +0 -40
  514. data/spec/models/company_spec.rb +0 -46
  515. data/spec/models/create_funding_account_request_v2_spec.rb +0 -74
  516. data/spec/models/create_individual2_spec.rb +0 -46
  517. data/spec/models/create_individual_name_spec.rb +0 -52
  518. data/spec/models/create_individual_spec.rb +0 -46
  519. data/spec/models/create_payee2_spec.rb +0 -94
  520. data/spec/models/create_payee_address2_spec.rb +0 -80
  521. data/spec/models/create_payee_address_spec.rb +0 -80
  522. data/spec/models/create_payee_spec.rb +0 -94
  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_submission2_spec.rb +0 -40
  541. data/spec/models/failed_submission_spec.rb +0 -40
  542. data/spec/models/funding_account_response2_spec.rb +0 -88
  543. data/spec/models/funding_account_response_spec.rb +0 -88
  544. data/spec/models/funding_account_type_spec.rb +0 -28
  545. data/spec/models/funding_audit_spec.rb +0 -94
  546. data/spec/models/funding_event_spec.rb +0 -52
  547. data/spec/models/funding_event_type_spec.rb +0 -28
  548. data/spec/models/funding_payor_status_audit_response_spec.rb +0 -52
  549. data/spec/models/funding_request_v1_spec.rb +0 -34
  550. data/spec/models/funding_request_v2_spec.rb +0 -34
  551. data/spec/models/funding_request_v3_spec.rb +0 -40
  552. data/spec/models/fx_summary_spec.rb +0 -96
  553. data/spec/models/fx_summary_v3_spec.rb +0 -96
  554. data/spec/models/get_fundings_response_spec.rb +0 -46
  555. data/spec/models/get_payee_list_response2_spec.rb +0 -130
  556. data/spec/models/get_payee_list_response_company2_spec.rb +0 -40
  557. data/spec/models/get_payee_list_response_company_spec.rb +0 -40
  558. data/spec/models/get_payee_list_response_individual2_spec.rb +0 -34
  559. data/spec/models/get_payee_list_response_individual_spec.rb +0 -34
  560. data/spec/models/get_payee_list_response_spec.rb +0 -130
  561. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +0 -58
  562. data/spec/models/get_payments_for_payout_response_v3_spec.rb +0 -52
  563. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +0 -92
  564. data/spec/models/get_payments_for_payout_response_v4_spec.rb +0 -52
  565. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +0 -142
  566. data/spec/models/get_payout_statistics_spec.rb +0 -40
  567. data/spec/models/get_payouts_response_spec.rb +0 -46
  568. data/spec/models/get_payouts_response_v3_links_spec.rb +0 -40
  569. data/spec/models/get_payouts_response_v3_page_spec.rb +0 -58
  570. data/spec/models/get_payouts_response_v3_spec.rb +0 -46
  571. data/spec/models/individual2_spec.rb +0 -46
  572. data/spec/models/individual_name_spec.rb +0 -52
  573. data/spec/models/individual_spec.rb +0 -46
  574. data/spec/models/inline_response400_spec.rb +0 -46
  575. data/spec/models/inline_response401_spec.rb +0 -46
  576. data/spec/models/inline_response403_spec.rb +0 -46
  577. data/spec/models/inline_response404_spec.rb +0 -46
  578. data/spec/models/inline_response409_spec.rb +0 -46
  579. data/spec/models/inline_response412_spec.rb +0 -46
  580. data/spec/models/invitation_status2_spec.rb +0 -28
  581. data/spec/models/invitation_status_spec.rb +0 -28
  582. data/spec/models/invite_payee_request2_spec.rb +0 -34
  583. data/spec/models/invite_payee_request_spec.rb +0 -34
  584. data/spec/models/invite_user_request_spec.rb +0 -92
  585. data/spec/models/kyc_state_spec.rb +0 -28
  586. data/spec/models/link_for_response_spec.rb +0 -40
  587. data/spec/models/list_funding_accounts_response2_spec.rb +0 -46
  588. data/spec/models/list_funding_accounts_response_spec.rb +0 -46
  589. data/spec/models/list_payments_response_v3_page_spec.rb +0 -58
  590. data/spec/models/list_payments_response_v3_spec.rb +0 -46
  591. data/spec/models/list_payments_response_v4_spec.rb +0 -46
  592. data/spec/models/list_source_account_response_links_spec.rb +0 -40
  593. data/spec/models/list_source_account_response_page_spec.rb +0 -58
  594. data/spec/models/list_source_account_response_spec.rb +0 -46
  595. data/spec/models/list_source_account_response_v2_links_spec.rb +0 -40
  596. data/spec/models/list_source_account_response_v2_spec.rb +0 -46
  597. data/spec/models/list_source_account_response_v3_links_spec.rb +0 -40
  598. data/spec/models/list_source_account_response_v3_spec.rb +0 -46
  599. data/spec/models/localisation_details_spec.rb +0 -40
  600. data/spec/models/mfa_details_spec.rb +0 -40
  601. data/spec/models/mfa_type_spec.rb +0 -28
  602. data/spec/models/name2_spec.rb +0 -52
  603. data/spec/models/name_spec.rb +0 -52
  604. data/spec/models/notification_spec.rb +0 -58
  605. data/spec/models/notifications2_spec.rb +0 -34
  606. data/spec/models/notifications_spec.rb +0 -34
  607. data/spec/models/ofac_status_spec.rb +0 -28
  608. data/spec/models/onboarded_status2_spec.rb +0 -28
  609. data/spec/models/onboarded_status_spec.rb +0 -28
  610. data/spec/models/onboarding_status_changed_spec.rb +0 -58
  611. data/spec/models/page_for_response_spec.rb +0 -58
  612. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +0 -46
  613. data/spec/models/paged_payee_invitation_status_response2_spec.rb +0 -46
  614. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +0 -58
  615. data/spec/models/paged_payee_invitation_status_response_spec.rb +0 -46
  616. data/spec/models/paged_payee_response2_spec.rb +0 -52
  617. data/spec/models/paged_payee_response_links_spec.rb +0 -40
  618. data/spec/models/paged_payee_response_page_spec.rb +0 -58
  619. data/spec/models/paged_payee_response_spec.rb +0 -52
  620. data/spec/models/paged_payee_response_summary_spec.rb +0 -58
  621. data/spec/models/paged_payments_response_v3_spec.rb +0 -46
  622. data/spec/models/paged_user_response_links_spec.rb +0 -40
  623. data/spec/models/paged_user_response_page_spec.rb +0 -58
  624. data/spec/models/paged_user_response_spec.rb +0 -46
  625. data/spec/models/password_request_spec.rb +0 -34
  626. data/spec/models/payable_issue2_spec.rb +0 -40
  627. data/spec/models/payable_issue_spec.rb +0 -40
  628. data/spec/models/payable_status_changed_spec.rb +0 -58
  629. data/spec/models/payee_address2_spec.rb +0 -76
  630. data/spec/models/payee_address_spec.rb +0 -76
  631. data/spec/models/payee_delta2_spec.rb +0 -70
  632. data/spec/models/payee_delta_response2_links_spec.rb +0 -40
  633. data/spec/models/payee_delta_response2_spec.rb +0 -46
  634. data/spec/models/payee_delta_response_links_spec.rb +0 -40
  635. data/spec/models/payee_delta_response_page_spec.rb +0 -58
  636. data/spec/models/payee_delta_response_spec.rb +0 -46
  637. data/spec/models/payee_delta_spec.rb +0 -70
  638. data/spec/models/payee_detail_response2_spec.rb +0 -202
  639. data/spec/models/payee_detail_response_spec.rb +0 -202
  640. data/spec/models/payee_details_changed_spec.rb +0 -58
  641. data/spec/models/payee_event_all_of_reasons_spec.rb +0 -40
  642. data/spec/models/payee_event_all_of_spec.rb +0 -40
  643. data/spec/models/payee_event_spec.rb +0 -58
  644. data/spec/models/payee_invitation_status_response2_spec.rb +0 -50
  645. data/spec/models/payee_invitation_status_response_spec.rb +0 -50
  646. data/spec/models/payee_payor_ref_spec.rb +0 -70
  647. data/spec/models/payee_payor_ref_v3_spec.rb +0 -70
  648. data/spec/models/payee_type_spec.rb +0 -28
  649. data/spec/models/payee_user_self_update_request_spec.rb +0 -64
  650. data/spec/models/payment_audit_currency_spec.rb +0 -28
  651. data/spec/models/payment_audit_currency_v3_spec.rb +0 -28
  652. data/spec/models/payment_channel_country_spec.rb +0 -40
  653. data/spec/models/payment_channel_rule_spec.rb +0 -70
  654. data/spec/models/payment_channel_rules_response_spec.rb +0 -34
  655. data/spec/models/payment_delta_response_spec.rb +0 -46
  656. data/spec/models/payment_delta_response_v1_spec.rb +0 -46
  657. data/spec/models/payment_delta_spec.rb +0 -76
  658. data/spec/models/payment_delta_v1_spec.rb +0 -76
  659. data/spec/models/payment_event_all_of_spec.rb +0 -46
  660. data/spec/models/payment_event_response_spec.rb +0 -104
  661. data/spec/models/payment_event_response_v3_spec.rb +0 -104
  662. data/spec/models/payment_event_spec.rb +0 -64
  663. data/spec/models/payment_instruction_v3_spec.rb +0 -82
  664. data/spec/models/payment_rails_spec.rb +0 -28
  665. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +0 -40
  666. data/spec/models/payment_rejected_or_returned_spec.rb +0 -82
  667. data/spec/models/payment_response_v3_spec.rb +0 -252
  668. data/spec/models/payment_response_v4_payout_spec.rb +0 -46
  669. data/spec/models/payment_response_v4_spec.rb +0 -306
  670. data/spec/models/payment_status_changed_all_of_spec.rb +0 -34
  671. data/spec/models/payment_status_changed_spec.rb +0 -70
  672. data/spec/models/payment_v3_spec.rb +0 -110
  673. data/spec/models/payor_address_spec.rb +0 -76
  674. data/spec/models/payor_address_v2_spec.rb +0 -76
  675. data/spec/models/payor_aml_transaction_spec.rb +0 -190
  676. data/spec/models/payor_aml_transaction_v3_spec.rb +0 -178
  677. data/spec/models/payor_branding_response_spec.rb +0 -58
  678. data/spec/models/payor_create_api_key_request_spec.rb +0 -50
  679. data/spec/models/payor_create_api_key_response_spec.rb +0 -40
  680. data/spec/models/payor_create_application_request_spec.rb +0 -40
  681. data/spec/models/payor_email_opt_out_request_spec.rb +0 -34
  682. data/spec/models/payor_links_response_links_spec.rb +0 -56
  683. data/spec/models/payor_links_response_payors_spec.rb +0 -56
  684. data/spec/models/payor_links_response_spec.rb +0 -40
  685. data/spec/models/payor_v1_spec.rb +0 -164
  686. data/spec/models/payor_v2_spec.rb +0 -170
  687. data/spec/models/payout_company_v3_spec.rb +0 -34
  688. data/spec/models/payout_individual_v3_spec.rb +0 -34
  689. data/spec/models/payout_name_v3_spec.rb +0 -40
  690. data/spec/models/payout_payee_v3_spec.rb +0 -46
  691. data/spec/models/payout_payor_ids_spec.rb +0 -46
  692. data/spec/models/payout_payor_spec.rb +0 -58
  693. data/spec/models/payout_principal_spec.rb +0 -40
  694. data/spec/models/payout_status_spec.rb +0 -28
  695. data/spec/models/payout_status_v3_spec.rb +0 -28
  696. data/spec/models/payout_summary_audit_spec.rb +0 -124
  697. data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
  698. data/spec/models/payout_summary_response_v3_spec.rb +0 -88
  699. data/spec/models/payout_type_spec.rb +0 -28
  700. data/spec/models/ping_spec.rb +0 -46
  701. data/spec/models/query_batch_response2_spec.rb +0 -56
  702. data/spec/models/query_batch_response_spec.rb +0 -56
  703. data/spec/models/quote_fx_summary_v3_spec.rb +0 -102
  704. data/spec/models/quote_response_v3_spec.rb +0 -34
  705. data/spec/models/region_v2_spec.rb +0 -40
  706. data/spec/models/register_sms_request_spec.rb +0 -34
  707. data/spec/models/rejected_payment_v3_spec.rb +0 -94
  708. data/spec/models/resend_token_request_spec.rb +0 -44
  709. data/spec/models/reset_password_request_spec.rb +0 -34
  710. data/spec/models/role_spec.rb +0 -34
  711. data/spec/models/role_update_request_spec.rb +0 -40
  712. data/spec/models/self_mfa_type_unregister_request_spec.rb +0 -38
  713. data/spec/models/self_update_password_request_spec.rb +0 -40
  714. data/spec/models/set_notifications_request_spec.rb +0 -34
  715. data/spec/models/source_account_response_spec.rb +0 -116
  716. data/spec/models/source_account_response_v2_spec.rb +0 -128
  717. data/spec/models/source_account_response_v3_spec.rb +0 -140
  718. data/spec/models/source_account_summary_spec.rb +0 -46
  719. data/spec/models/source_account_summary_v3_spec.rb +0 -46
  720. data/spec/models/source_account_type_spec.rb +0 -28
  721. data/spec/models/source_account_v3_spec.rb +0 -52
  722. data/spec/models/source_event_spec.rb +0 -46
  723. data/spec/models/supported_countries_response_spec.rb +0 -34
  724. data/spec/models/supported_countries_response_v2_spec.rb +0 -34
  725. data/spec/models/supported_country_spec.rb +0 -40
  726. data/spec/models/supported_country_v2_spec.rb +0 -46
  727. data/spec/models/supported_currency_response_v2_spec.rb +0 -34
  728. data/spec/models/supported_currency_v2_spec.rb +0 -40
  729. data/spec/models/transfer_request2_spec.rb +0 -46
  730. data/spec/models/transfer_request_spec.rb +0 -46
  731. data/spec/models/transmission_type_spec.rb +0 -28
  732. data/spec/models/transmission_types2_spec.rb +0 -46
  733. data/spec/models/transmission_types_spec.rb +0 -46
  734. data/spec/models/unregister_mfa_request_spec.rb +0 -44
  735. data/spec/models/update_payee_details_request2_spec.rb +0 -70
  736. data/spec/models/update_payee_details_request_spec.rb +0 -70
  737. data/spec/models/update_remote_id_request2_spec.rb +0 -40
  738. data/spec/models/update_remote_id_request_spec.rb +0 -40
  739. data/spec/models/update_webhook_request_spec.rb +0 -52
  740. data/spec/models/user_details_update_request_spec.rb +0 -76
  741. data/spec/models/user_info_spec.rb +0 -46
  742. data/spec/models/user_response_spec.rb +0 -124
  743. data/spec/models/user_status_spec.rb +0 -28
  744. data/spec/models/user_type2_spec.rb +0 -28
  745. data/spec/models/user_type_spec.rb +0 -28
  746. data/spec/models/validate_password_response_spec.rb +0 -52
  747. data/spec/models/watchlist_status2_spec.rb +0 -28
  748. data/spec/models/watchlist_status_spec.rb +0 -28
  749. data/spec/models/webhook_response_spec.rb +0 -64
  750. data/spec/models/webhooks_response_spec.rb +0 -46
  751. data/spec/models/withdraw_payment_request_spec.rb +0 -34
@@ -1,100 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::PayoutSummaryAuditV3
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::PayoutSummaryAuditV3 do
21
- let(:instance) { VeloPayments::PayoutSummaryAuditV3.new }
22
-
23
- describe 'test an instance of PayoutSummaryAuditV3' do
24
- it 'should create an instance of PayoutSummaryAuditV3' do
25
- expect(instance).to be_instance_of(VeloPayments::PayoutSummaryAuditV3)
26
- end
27
- end
28
- describe 'test attribute "payout_id"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "payor_id"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "status"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "submitted_date_time"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- describe 'test attribute "instructed_date_time"' do
53
- it 'should work' do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- describe 'test attribute "withdrawn_date_time"' do
59
- it 'should work' do
60
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
61
- end
62
- end
63
-
64
- describe 'test attribute "total_payments"' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- describe 'test attribute "total_incomplete_payments"' do
71
- it 'should work' do
72
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
73
- end
74
- end
75
-
76
- describe 'test attribute "total_failed_payments"' do
77
- it 'should work' do
78
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
- end
80
- end
81
-
82
- describe 'test attribute "source_account_summary"' do
83
- it 'should work' do
84
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
85
- end
86
- end
87
-
88
- describe 'test attribute "fx_summaries"' do
89
- it 'should work' do
90
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
91
- end
92
- end
93
-
94
- describe 'test attribute "payout_memo"' do
95
- it 'should work' do
96
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
97
- end
98
- end
99
-
100
- end
@@ -1,88 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::PayoutSummaryResponseV3
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::PayoutSummaryResponseV3 do
21
- let(:instance) { VeloPayments::PayoutSummaryResponseV3.new }
22
-
23
- describe 'test an instance of PayoutSummaryResponseV3' do
24
- it 'should create an instance of PayoutSummaryResponseV3' do
25
- expect(instance).to be_instance_of(VeloPayments::PayoutSummaryResponseV3)
26
- end
27
- end
28
- describe 'test attribute "payout_id"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "status"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "payments_submitted"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "payments_accepted"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- describe 'test attribute "payments_rejected"' do
53
- it 'should work' do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- describe 'test attribute "payments_withdrawn"' do
59
- it 'should work' do
60
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
61
- end
62
- end
63
-
64
- describe 'test attribute "fx_summaries"' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- describe 'test attribute "accounts"' do
71
- it 'should work' do
72
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
73
- end
74
- end
75
-
76
- describe 'test attribute "accepted_payments"' do
77
- it 'should work' do
78
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
- end
80
- end
81
-
82
- describe 'test attribute "rejected_payments"' do
83
- it 'should work' do
84
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
85
- end
86
- end
87
-
88
- end
@@ -1,28 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::PayoutType
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::PayoutType do
21
- let(:instance) { VeloPayments::PayoutType.new }
22
-
23
- describe 'test an instance of PayoutType' do
24
- it 'should create an instance of PayoutType' do
25
- expect(instance).to be_instance_of(VeloPayments::PayoutType)
26
- end
27
- end
28
- end
@@ -1,46 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::Ping
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::Ping do
21
- let(:instance) { VeloPayments::Ping.new }
22
-
23
- describe 'test an instance of Ping' do
24
- it 'should create an instance of Ping' do
25
- expect(instance).to be_instance_of(VeloPayments::Ping)
26
- end
27
- end
28
- describe 'test attribute "source_type"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "event_id"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "created_at"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- end
@@ -1,56 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::QueryBatchResponse2
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::QueryBatchResponse2 do
21
- let(:instance) { VeloPayments::QueryBatchResponse2.new }
22
-
23
- describe 'test an instance of QueryBatchResponse2' do
24
- it 'should create an instance of QueryBatchResponse2' do
25
- expect(instance).to be_instance_of(VeloPayments::QueryBatchResponse2)
26
- end
27
- end
28
- describe 'test attribute "status"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["SUBMITTED", "ACCEPTED"])
32
- # validator.allowable_values.each do |value|
33
- # expect { instance.status = value }.not_to raise_error
34
- # end
35
- end
36
- end
37
-
38
- describe 'test attribute "failure_count"' do
39
- it 'should work' do
40
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
41
- end
42
- end
43
-
44
- describe 'test attribute "pending_count"' do
45
- it 'should work' do
46
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
47
- end
48
- end
49
-
50
- describe 'test attribute "failures"' do
51
- it 'should work' do
52
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
53
- end
54
- end
55
-
56
- end
@@ -1,56 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::QueryBatchResponse
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::QueryBatchResponse do
21
- let(:instance) { VeloPayments::QueryBatchResponse.new }
22
-
23
- describe 'test an instance of QueryBatchResponse' do
24
- it 'should create an instance of QueryBatchResponse' do
25
- expect(instance).to be_instance_of(VeloPayments::QueryBatchResponse)
26
- end
27
- end
28
- describe 'test attribute "status"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["SUBMITTED", "ACCEPTED"])
32
- # validator.allowable_values.each do |value|
33
- # expect { instance.status = value }.not_to raise_error
34
- # end
35
- end
36
- end
37
-
38
- describe 'test attribute "failure_count"' do
39
- it 'should work' do
40
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
41
- end
42
- end
43
-
44
- describe 'test attribute "pending_count"' do
45
- it 'should work' do
46
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
47
- end
48
- end
49
-
50
- describe 'test attribute "failures"' do
51
- it 'should work' do
52
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
53
- end
54
- end
55
-
56
- end
@@ -1,102 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::QuoteFxSummaryV3
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::QuoteFxSummaryV3 do
21
- let(:instance) { VeloPayments::QuoteFxSummaryV3.new }
22
-
23
- describe 'test an instance of QuoteFxSummaryV3' do
24
- it 'should create an instance of QuoteFxSummaryV3' do
25
- expect(instance).to be_instance_of(VeloPayments::QuoteFxSummaryV3)
26
- end
27
- end
28
- describe 'test attribute "rate"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "inverted_rate"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "creation_time"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "expiry_time"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- describe 'test attribute "quote_id"' do
53
- it 'should work' do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- describe 'test attribute "total_source_amount"' do
59
- it 'should work' do
60
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
61
- end
62
- end
63
-
64
- describe 'test attribute "total_payment_amount"' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- describe 'test attribute "source_currency"' do
71
- it 'should work' do
72
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
73
- end
74
- end
75
-
76
- describe 'test attribute "payment_currency"' do
77
- it 'should work' do
78
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
- end
80
- end
81
-
82
- describe 'test attribute "funding_status"' do
83
- it 'should work' do
84
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
85
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["UNFUNDED", "INSTRUCTED", "FUNDED"])
86
- # validator.allowable_values.each do |value|
87
- # expect { instance.funding_status = value }.not_to raise_error
88
- # end
89
- end
90
- end
91
-
92
- describe 'test attribute "status"' do
93
- it 'should work' do
94
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED", "REJECTED"])
96
- # validator.allowable_values.each do |value|
97
- # expect { instance.status = value }.not_to raise_error
98
- # end
99
- end
100
- end
101
-
102
- end
@@ -1,34 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::QuoteResponseV3
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::QuoteResponseV3 do
21
- let(:instance) { VeloPayments::QuoteResponseV3.new }
22
-
23
- describe 'test an instance of QuoteResponseV3' do
24
- it 'should create an instance of QuoteResponseV3' do
25
- expect(instance).to be_instance_of(VeloPayments::QuoteResponseV3)
26
- end
27
- end
28
- describe 'test attribute "fx_summaries"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- end
@@ -1,40 +0,0 @@
1
- =begin
2
- #Velo Payments APIs
3
-
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
-
6
- The version of the OpenAPI document: 2.26.124
7
-
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for VeloPayments::RegionV2
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe VeloPayments::RegionV2 do
21
- let(:instance) { VeloPayments::RegionV2.new }
22
-
23
- describe 'test an instance of RegionV2' do
24
- it 'should create an instance of RegionV2' do
25
- expect(instance).to be_instance_of(VeloPayments::RegionV2)
26
- end
27
- 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
32
- end
33
-
34
- describe 'test attribute "abbreviation"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- end