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
data/docs/PaymentAuditServiceApi.md CHANGED
@@ -35,7 +35,7 @@ end
35
35
 
36
36
  api_instance = VeloPayments::PaymentAuditServiceApi.new
37
37
  opts = {
38
- payor_id: TODO, # String | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
38
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
39
39
  start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
40
40
  end_date: Date.parse('2013-10-20'), # Date | End date, inclusive. Format is YYYY-MM-DD
41
41
  include: 'payorOnly' # String | <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
@@ -72,7 +72,7 @@ end
72
72
 
73
73
  | Name | Type | Description | Notes |
74
74
  | ---- | ---- | ----------- | ----- |
75
- | **payor_id** | [**String**](.md) | &lt;p&gt;The Payor ID for whom you wish to run the report.&lt;/p&gt; &lt;p&gt;For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.&lt;/p&gt; | [optional] |
75
+ | **payor_id** | **String** | &lt;p&gt;The Payor ID for whom you wish to run the report.&lt;/p&gt; &lt;p&gt;For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.&lt;/p&gt; | [optional] |
76
76
  | **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
77
77
  | **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
78
78
  | **include** | **String** | &lt;p&gt;Mode to determine whether to include other Payor&#39;s data in the results.&lt;/p&gt; &lt;p&gt;May only be used if payorId is specified.&lt;/p&gt; &lt;p&gt;Can be omitted or set to &#39;payorOnly&#39; or &#39;payorAndDescendants&#39;.&lt;/p&gt; &lt;p&gt;payorOnly: Only include results for the specified Payor. This is the default if &#39;include&#39; is omitted.&lt;/p&gt; &lt;p&gt;payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.&lt;/p&gt; &lt;p&gt;Note when a Payor requests the report and include&#x3D;payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id&lt;/p&gt; | [optional] |
@@ -111,8 +111,9 @@ VeloPayments.configure do |config|
111
111
  end
112
112
 
113
113
  api_instance = VeloPayments::PaymentAuditServiceApi.new
114
- payor_id = TODO # String | The account owner Payor ID
114
+ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
115
115
  opts = {
116
+ source_account_name: 'source_account_name_example', # String | The source account name
116
117
  page: 56, # Integer | Page number. Default is 1.
117
118
  page_size: 56, # Integer | The number of results to return in a page
118
119
  sort: 'sort_example' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
@@ -149,7 +150,8 @@ end
149
150
 
150
151
  | Name | Type | Description | Notes |
151
152
  | ---- | ---- | ----------- | ----- |
152
- | **payor_id** | [**String**](.md) | The account owner Payor ID | |
153
+ | **payor_id** | **String** | The account owner Payor ID | |
154
+ | **source_account_name** | **String** | The source account name | [optional] |
153
155
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
154
156
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
155
157
  | **sort** | **String** | List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount. | [optional] |
@@ -188,7 +190,7 @@ VeloPayments.configure do |config|
188
190
  end
189
191
 
190
192
  api_instance = VeloPayments::PaymentAuditServiceApi.new
191
- payment_id = TODO # String | Payment Id
193
+ payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Payment Id
192
194
  opts = {
193
195
  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
194
196
  }
@@ -224,7 +226,7 @@ end
224
226
 
225
227
  | Name | Type | Description | Notes |
226
228
  | ---- | ---- | ----------- | ----- |
227
- | **payment_id** | [**String**](.md) | Payment Id | |
229
+ | **payment_id** | **String** | Payment Id | |
228
230
  | **sensitive** | **Boolean** | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional] |
229
231
 
230
232
  ### Return type
@@ -261,8 +263,9 @@ VeloPayments.configure do |config|
261
263
  end
262
264
 
263
265
  api_instance = VeloPayments::PaymentAuditServiceApi.new
264
- payout_id = TODO # String | The id (UUID) of the payout.
266
+ payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id (UUID) of the payout.
265
267
  opts = {
268
+ rails_id: 'rails_id_example', # String | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint.
266
269
  remote_id: 'remote_id_example', # String | The remote id of the payees.
267
270
  remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
268
271
  status: 'ACCEPTED', # String | Payment Status
@@ -272,7 +275,7 @@ opts = {
272
275
  payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
273
276
  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
274
277
  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
275
- transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
278
+ transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO
276
279
  page: 56, # Integer | Page number. Default is 1.
277
280
  page_size: 56, # Integer | The number of results to return in a page
278
281
  sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
@@ -310,7 +313,8 @@ end
310
313
 
311
314
  | Name | Type | Description | Notes |
312
315
  | ---- | ---- | ----------- | ----- |
313
- | **payout_id** | [**String**](.md) | The id (UUID) of the payout. | |
316
+ | **payout_id** | **String** | The id (UUID) of the payout. | |
317
+ | **rails_id** | **String** | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the &#39;Get Supported Rails&#39; endpoint. | [optional] |
314
318
  | **remote_id** | **String** | The remote id of the payees. | [optional] |
315
319
  | **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
316
320
  | **status** | **String** | Payment Status | [optional] |
@@ -320,7 +324,7 @@ end
320
324
  | **payment_amount_to** | **Integer** | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] |
321
325
  | **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
322
326
  | **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
323
- | **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE | [optional] |
327
+ | **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO | [optional] |
324
328
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
325
329
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
326
330
  | **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status | [optional] |
@@ -361,7 +365,7 @@ end
361
365
 
362
366
  api_instance = VeloPayments::PaymentAuditServiceApi.new
363
367
  opts = {
364
- payor_id: TODO # String | The account owner Payor ID. Required for external users.
368
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID. Required for external users.
365
369
  }
366
370
 
367
371
  begin
@@ -395,7 +399,7 @@ end
395
399
 
396
400
  | Name | Type | Description | Notes |
397
401
  | ---- | ---- | ----------- | ----- |
398
- | **payor_id** | [**String**](.md) | The account owner Payor ID. Required for external users. | [optional] |
402
+ | **payor_id** | **String** | The account owner Payor ID. Required for external users. | [optional] |
399
403
 
400
404
  ### Return type
401
405
 
@@ -432,15 +436,18 @@ end
432
436
 
433
437
  api_instance = VeloPayments::PaymentAuditServiceApi.new
434
438
  opts = {
435
- payor_id: TODO, # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
439
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
436
440
  payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
437
441
  status: 'ACCEPTED', # String | Payout Status
438
442
  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
439
443
  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
440
444
  from_payor_name: 'from_payor_name_example', # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
445
+ scheduled_for_date_from: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
446
+ scheduled_for_date_to: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
447
+ schedule_status: 'ANY', # String | Payout Schedule Status
441
448
  page: 56, # Integer | Page number. Default is 1.
442
449
  page_size: 56, # Integer | The number of results to return in a page
443
- sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
450
+ sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor
444
451
  }
445
452
 
446
453
  begin
@@ -474,15 +481,18 @@ end
474
481
 
475
482
  | Name | Type | Description | Notes |
476
483
  | ---- | ---- | ----------- | ----- |
477
- | **payor_id** | [**String**](.md) | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] |
484
+ | **payor_id** | **String** | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] |
478
485
  | **payout_memo** | **String** | Payout Memo filter - case insensitive sub-string match | [optional] |
479
486
  | **status** | **String** | Payout Status | [optional] |
480
487
  | **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
481
488
  | **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
482
489
  | **from_payor_name** | **String** | The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional] |
490
+ | **scheduled_for_date_from** | **Date** | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. | [optional] |
491
+ | **scheduled_for_date_to** | **Date** | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. | [optional] |
492
+ | **schedule_status** | **String** | Payout Schedule Status | [optional] |
483
493
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
484
494
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
485
- | **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId | [optional] |
495
+ | **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor | [optional] |
486
496
 
487
497
  ### Return type
488
498
 
@@ -518,7 +528,7 @@ VeloPayments.configure do |config|
518
528
  end
519
529
 
520
530
  api_instance = VeloPayments::PaymentAuditServiceApi.new
521
- payor_id = TODO # String | The Payor ID to find associated Payments
531
+ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payments
522
532
  updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
523
533
  opts = {
524
534
  page: 56, # Integer | Page number. Default is 1.
@@ -556,7 +566,7 @@ end
556
566
 
557
567
  | Name | Type | Description | Notes |
558
568
  | ---- | ---- | ----------- | ----- |
559
- | **payor_id** | [**String**](.md) | The Payor ID to find associated Payments | |
569
+ | **payor_id** | **String** | The Payor ID to find associated Payments | |
560
570
  | **updated_since** | **Time** | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | |
561
571
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
562
572
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 100] |
@@ -596,13 +606,13 @@ end
596
606
 
597
607
  api_instance = VeloPayments::PaymentAuditServiceApi.new
598
608
  opts = {
599
- payee_id: TODO, # String | The UUID of the payee.
600
- payor_id: TODO, # String | The account owner Payor Id. Required for external users.
609
+ payee_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The UUID of the payee.
610
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The account owner Payor Id. Required for external users.
601
611
  payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
602
612
  remote_id: 'remote_id_example', # String | The remote id of the payees.
603
613
  remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
604
614
  status: 'ACCEPTED', # String | Payment Status
605
- transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
615
+ transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO
606
616
  source_account_name: 'source_account_name_example', # String | The source account name filter. This filters via a case insensitive substring match.
607
617
  source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
608
618
  source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
@@ -613,6 +623,11 @@ opts = {
613
623
  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
614
624
  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
615
625
  payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
626
+ rails_id: 'rails_id_example', # String | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint.
627
+ scheduled_for_date_from: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
628
+ scheduled_for_date_to: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
629
+ schedule_status: 'ANY', # String | Payout Schedule Status
630
+ post_instruct_fx_status: 'ANY', # String | The status of the post instruct FX step if one was required for the payment
616
631
  page: 56, # Integer | Page number. Default is 1.
617
632
  page_size: 56, # Integer | The number of results to return in a page
618
633
  sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
@@ -650,13 +665,13 @@ end
650
665
 
651
666
  | Name | Type | Description | Notes |
652
667
  | ---- | ---- | ----------- | ----- |
653
- | **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
654
- | **payor_id** | [**String**](.md) | The account owner Payor Id. Required for external users. | [optional] |
668
+ | **payee_id** | **String** | The UUID of the payee. | [optional] |
669
+ | **payor_id** | **String** | The account owner Payor Id. Required for external users. | [optional] |
655
670
  | **payor_name** | **String** | The payor’s name. This filters via a case insensitive substring match. | [optional] |
656
671
  | **remote_id** | **String** | The remote id of the payees. | [optional] |
657
672
  | **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
658
673
  | **status** | **String** | Payment Status | [optional] |
659
- | **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE | [optional] |
674
+ | **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO | [optional] |
660
675
  | **source_account_name** | **String** | The source account name filter. This filters via a case insensitive substring match. | [optional] |
661
676
  | **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount &gt;&#x3D; sourceAmountFrom | [optional] |
662
677
  | **source_amount_to** | **Integer** | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] |
@@ -667,6 +682,11 @@ end
667
682
  | **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
668
683
  | **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
669
684
  | **payment_memo** | **String** | The payment memo filter. This filters via a case insensitive substring match. | [optional] |
685
+ | **rails_id** | **String** | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the &#39;Get Supported Rails&#39; endpoint. | [optional] |
686
+ | **scheduled_for_date_from** | **Date** | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. | [optional] |
687
+ | **scheduled_for_date_to** | **Date** | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. | [optional] |
688
+ | **schedule_status** | **String** | Payout Schedule Status | [optional] |
689
+ | **post_instruct_fx_status** | **String** | The status of the post instruct FX step if one was required for the payment | [optional] |
670
690
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
671
691
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
672
692
  | **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId | [optional] |
data/docs/PaymentAuditServiceDeprecatedApi.md CHANGED
@@ -35,7 +35,7 @@ end
35
35
 
36
36
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
37
37
  opts = {
38
- payor_id: TODO, # String | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
38
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
39
39
  start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
40
40
  end_date: Date.parse('2013-10-20') # Date | End date, inclusive. Format is YYYY-MM-DD
41
41
  }
@@ -71,7 +71,7 @@ end
71
71
 
72
72
  | Name | Type | Description | Notes |
73
73
  | ---- | ---- | ----------- | ----- |
74
- | **payor_id** | [**String**](.md) | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. | [optional] |
74
+ | **payor_id** | **String** | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. | [optional] |
75
75
  | **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
76
76
  | **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
77
77
 
@@ -109,7 +109,7 @@ VeloPayments.configure do |config|
109
109
  end
110
110
 
111
111
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
112
- payor_id = TODO # String | The account owner Payor ID
112
+ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
113
113
  opts = {
114
114
  page: 56, # Integer | Page number. Default is 1.
115
115
  page_size: 56, # Integer | The number of results to return in a page
@@ -147,7 +147,7 @@ end
147
147
 
148
148
  | Name | Type | Description | Notes |
149
149
  | ---- | ---- | ----------- | ----- |
150
- | **payor_id** | [**String**](.md) | The account owner Payor ID | |
150
+ | **payor_id** | **String** | The account owner Payor ID | |
151
151
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
152
152
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
153
153
  | **sort** | **String** | List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount. | [optional] |
@@ -186,7 +186,7 @@ VeloPayments.configure do |config|
186
186
  end
187
187
 
188
188
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
189
- payment_id = TODO # String | Payment Id
189
+ payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Payment Id
190
190
  opts = {
191
191
  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
192
192
  }
@@ -222,7 +222,7 @@ end
222
222
 
223
223
  | Name | Type | Description | Notes |
224
224
  | ---- | ---- | ----------- | ----- |
225
- | **payment_id** | [**String**](.md) | Payment Id | |
225
+ | **payment_id** | **String** | Payment Id | |
226
226
  | **sensitive** | **Boolean** | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional] |
227
227
 
228
228
  ### Return type
@@ -259,7 +259,7 @@ VeloPayments.configure do |config|
259
259
  end
260
260
 
261
261
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
262
- payout_id = TODO # String | The id (UUID) of the payout.
262
+ payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id (UUID) of the payout.
263
263
  opts = {
264
264
  remote_id: 'remote_id_example', # String | The remote id of the payees.
265
265
  status: 'ACCEPTED', # String | Payment Status
@@ -306,7 +306,7 @@ end
306
306
 
307
307
  | Name | Type | Description | Notes |
308
308
  | ---- | ---- | ----------- | ----- |
309
- | **payout_id** | [**String**](.md) | The id (UUID) of the payout. | |
309
+ | **payout_id** | **String** | The id (UUID) of the payout. | |
310
310
  | **remote_id** | **String** | The remote id of the payees. | [optional] |
311
311
  | **status** | **String** | Payment Status | [optional] |
312
312
  | **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount &gt;&#x3D; sourceAmountFrom | [optional] |
@@ -355,7 +355,7 @@ end
355
355
 
356
356
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
357
357
  opts = {
358
- payor_id: TODO # String | The account owner Payor ID. Required for external users.
358
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID. Required for external users.
359
359
  }
360
360
 
361
361
  begin
@@ -389,7 +389,7 @@ end
389
389
 
390
390
  | Name | Type | Description | Notes |
391
391
  | ---- | ---- | ----------- | ----- |
392
- | **payor_id** | [**String**](.md) | The account owner Payor ID. Required for external users. | [optional] |
392
+ | **payor_id** | **String** | The account owner Payor ID. Required for external users. | [optional] |
393
393
 
394
394
  ### Return type
395
395
 
@@ -425,7 +425,7 @@ VeloPayments.configure do |config|
425
425
  end
426
426
 
427
427
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
428
- payor_id = TODO # String | The account owner Payor ID
428
+ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
429
429
  opts = {
430
430
  payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
431
431
  status: 'ACCEPTED', # String | Payout Status
@@ -467,7 +467,7 @@ end
467
467
 
468
468
  | Name | Type | Description | Notes |
469
469
  | ---- | ---- | ----------- | ----- |
470
- | **payor_id** | [**String**](.md) | The account owner Payor ID | |
470
+ | **payor_id** | **String** | The account owner Payor ID | |
471
471
  | **payout_memo** | **String** | Payout Memo filter - case insensitive sub-string match | [optional] |
472
472
  | **status** | **String** | Payout Status | [optional] |
473
473
  | **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
@@ -510,7 +510,7 @@ VeloPayments.configure do |config|
510
510
  end
511
511
 
512
512
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
513
- payor_id = TODO # String | The Payor ID to find associated Payments
513
+ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payments
514
514
  updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
515
515
  opts = {
516
516
  page: 56, # Integer | Page number. Default is 1.
@@ -548,7 +548,7 @@ end
548
548
 
549
549
  | Name | Type | Description | Notes |
550
550
  | ---- | ---- | ----------- | ----- |
551
- | **payor_id** | [**String**](.md) | The Payor ID to find associated Payments | |
551
+ | **payor_id** | **String** | The Payor ID to find associated Payments | |
552
552
  | **updated_since** | **Time** | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | |
553
553
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
554
554
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 100] |
@@ -588,8 +588,8 @@ end
588
588
 
589
589
  api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
590
590
  opts = {
591
- payee_id: TODO, # String | The UUID of the payee.
592
- payor_id: TODO, # String | The account owner Payor Id. Required for external users.
591
+ payee_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The UUID of the payee.
592
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The account owner Payor Id. Required for external users.
593
593
  payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
594
594
  remote_id: 'remote_id_example', # String | The remote id of the payees.
595
595
  status: 'ACCEPTED', # String | Payment Status
@@ -640,8 +640,8 @@ end
640
640
 
641
641
  | Name | Type | Description | Notes |
642
642
  | ---- | ---- | ----------- | ----- |
643
- | **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
644
- | **payor_id** | [**String**](.md) | The account owner Payor Id. Required for external users. | [optional] |
643
+ | **payee_id** | **String** | The UUID of the payee. | [optional] |
644
+ | **payor_id** | **String** | The account owner Payor Id. Required for external users. | [optional] |
645
645
  | **payor_name** | **String** | The payor’s name. This filters via a case insensitive substring match. | [optional] |
646
646
  | **remote_id** | **String** | The remote id of the payees. | [optional] |
647
647
  | **status** | **String** | Payment Status | [optional] |
data/docs/PaymentChannelRule.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | **max_length** | **Integer** | maximum length of the element data | [optional] |
12
12
  | **validation** | **String** | a regex to validate the element data | |
13
13
  | **display_order** | **Integer** | | [optional] |
14
+ | **description** | **String** | An optional description, or hint, as to how the user should enter the field value. | [optional] |
14
15
 
15
16
  ## Example
16
17
 
@@ -24,7 +25,8 @@ instance = VeloPayments::PaymentChannelRule.new(
24
25
  min_length: 5,
25
26
  max_length: 50,
26
27
  validation: ^[0-9]{6,11}$,
27
- display_order: null
28
+ display_order: null,
29
+ description: The bank branch, account number prefix and account number suffix; with hyphen separators.
28
30
  )
29
31
  ```
30
32
 
data/docs/PaymentDeltaResponse.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional] |
8
- | **links** | [**Array&lt;PagedPayeeResponseLinks&gt;**](PagedPayeeResponseLinks.md) | | [optional] |
7
+ | **page** | [**PagedPayeeInvitationStatusResponseV3Page**](PagedPayeeInvitationStatusResponseV3Page.md) | | [optional] |
8
+ | **links** | [**Array&lt;PagedPayeeResponseV3Links&gt;**](PagedPayeeResponseV3Links.md) | | [optional] |
9
9
  | **content** | [**Array&lt;PaymentDelta&gt;**](PaymentDelta.md) | | [optional] |
10
10
 
11
11
  ## Example
data/docs/PaymentDeltaResponseV1.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional] |
8
- | **links** | [**Array&lt;PagedPayeeResponseLinks&gt;**](PagedPayeeResponseLinks.md) | | [optional] |
7
+ | **page** | [**PagedPayeeInvitationStatusResponseV3Page**](PagedPayeeInvitationStatusResponseV3Page.md) | | [optional] |
8
+ | **links** | [**Array&lt;PagedPayeeResponseV3Links&gt;**](PagedPayeeResponseV3Links.md) | | [optional] |
9
9
  | **content** | [**Array&lt;PaymentDeltaV1&gt;**](PaymentDeltaV1.md) | | [optional] |
10
10
 
11
11
  ## Example
data/docs/PaymentEventResponse.md CHANGED
@@ -6,16 +6,19 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_id** | **String** | The id of the event. | |
8
8
  | **event_date_time** | **Time** | The date/time at which the event occurred. | |
9
- | **event_type** | **String** | The type of the event. | |
10
- | **source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) | | [optional] |
9
+ | **event_type** | **String** | One of the following values: PAYOUT_SUBMITTED, PAYOUT_COMPLETED, PAYOUT_INSTRUCTED_V3, BANK_PAYMENT_REQUESTED, SOURCE_AMOUNT_CONFIRMED, PAYMENT_SUBMITTED, PAYMENT_SUBMITTED_ACCEPTED, PAYMENT_SUBMITTED_REJECTED, PAYMENT_CONFIRMED, PAYMENT_AWAITING_FUNDS, PAYMENT_FUNDED, PAYMENT_UNFUNDED, PAYMENT_FAILED, PAYMENT_TRACKING_DETAILS_UPDATED, ACH_SUBMITTED_TO_ODFI, PAYMENT_ACCEPTED_BY_RAILS, ACH_RETURN_RECEIVED, RETURN_PAYMENT_FUNDING_REQUESTED, PAYOUT_BATCH_EXECUTED, PAYOUT_BATCH_QUOTE_EXPIRED, PAYOUT_BATCH_FUNDED, PAYOUT_BATCH_FUNDS_RETURN_REQUEST, PAYOUT_BATCH_FUNDS_RETURNED, PAYOUT_FUNDS_REQUEST, PAYOUT_FUNDS_GRANTED, PAYOUT_FUNDS_DENIED, PAYOUT_BATCH_QUOTED, PAYOUT_QUOTED, ACH_PAYMENT_RETURN_CANCELLED, RETURN_PAYMENT_CANCELLATION_REQUESTED, PAYOUT_WITHDRAWN, ORCHESTRATED_PAYMENT_BATCH_REQUESTED, ORCHESTRATED_PAYMENT_BATCH_CONFIRMED, ORCHESTRATED_PAYMENT_REQUESTED | |
10
+ | **source_currency** | **String** | ISO-4217 3 character currency code | [optional] |
11
11
  | **source_amount** | **Integer** | The source amount exposed by the event. | [optional] |
12
- | **payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) | | [optional] |
12
+ | **payment_currency** | **String** | ISO-4217 3 character currency code | [optional] |
13
13
  | **payment_amount** | **Integer** | The destination amount exposed by the event. | [optional] |
14
14
  | **account_number** | **String** | The account number attached to the event. | [optional] |
15
15
  | **routing_number** | **String** | The routing number attached to the event. | [optional] |
16
16
  | **iban** | **String** | | [optional] |
17
17
  | **account_name** | **String** | | [optional] |
18
18
  | **principal** | **String** | | [optional] |
19
+ | **scheduled_at** | **Time** | | [optional] |
20
+ | **scheduled_for** | **Time** | | [optional] |
21
+ | **scheduled_by** | **String** | Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application. | [optional] |
19
22
 
20
23
  ## Example
21
24
 
@@ -26,15 +29,18 @@ instance = VeloPayments::PaymentEventResponse.new(
26
29
  event_id: null,
27
30
  event_date_time: null,
28
31
  event_type: null,
29
- source_currency: null,
32
+ source_currency: EUR,
30
33
  source_amount: 1299,
31
- payment_currency: null,
34
+ payment_currency: EUR,
32
35
  payment_amount: 1299,
33
36
  account_number: null,
34
37
  routing_number: null,
35
38
  iban: null,
36
39
  account_name: null,
37
- principal: null
40
+ principal: null,
41
+ scheduled_at: null,
42
+ scheduled_for: null,
43
+ scheduled_by: Aphra Behn
38
44
  )
39
45
  ```
40
46
 
data/docs/PaymentEventResponseV3.md CHANGED
@@ -6,10 +6,10 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_id** | **String** | The id of the event. | |
8
8
  | **event_date_time** | **Time** | The date/time at which the event occurred. | |
9
- | **event_type** | **String** | The type of the event. | |
10
- | **source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional] |
9
+ | **event_type** | **String** | The type of the event. One of the following values: PAYOUT_SUBMITTED, PAYOUT_COMPLETED, PAYOUT_INSTRUCTED_V3, BANK_PAYMENT_REQUESTED, SOURCE_AMOUNT_CONFIRMED, PAYMENT_SUBMITTED, PAYMENT_SUBMITTED_ACCEPTED, PAYMENT_SUBMITTED_REJECTED, PAYMENT_CONFIRMED, PAYMENT_AWAITING_FUNDS, PAYMENT_FUNDED, PAYMENT_UNFUNDED, PAYMENT_FAILED, ACH_SUBMITTED_TO_ODFI, PAYMENT_ACCEPTED_BY_RAILS, ACH_RETURN_RECEIVED, RETURN_PAYMENT_FUNDING_REQUESTED, PAYOUT_BATCH_EXECUTED, PAYOUT_BATCH_QUOTE_EXPIRED, PAYOUT_BATCH_FUNDED, PAYOUT_BATCH_FUNDS_RETURN_REQUEST, PAYOUT_BATCH_FUNDS_RETURNED, PAYOUT_FUNDS_REQUEST, PAYOUT_FUNDS_GRANTED, PAYOUT_FUNDS_DENIED, PAYOUT_BATCH_QUOTED, PAYOUT_QUOTED, ACH_PAYMENT_RETURN_CANCELLED, RETURN_PAYMENT_CANCELLATION_REQUESTED, PAYOUT_WITHDRAWN | |
10
+ | **source_currency** | **String** | ISO 3 character currency code | [optional] |
11
11
  | **source_amount** | **Integer** | The source amount exposed by the event. | [optional] |
12
- | **payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional] |
12
+ | **payment_currency** | **String** | ISO 3 character currency code | [optional] |
13
13
  | **payment_amount** | **Integer** | The destination amount exposed by the event. | [optional] |
14
14
  | **account_number** | **String** | The account number attached to the event. | [optional] |
15
15
  | **routing_number** | **String** | The routing number attached to the event. | [optional] |
data/docs/PaymentInstructionV3.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **remote_id** | **String** | Your identifier for payee | |
7
+ | **remote_id** | **String** | Your identifier for the payee | |
8
8
  | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | |
9
9
  | **amount** | **Integer** | &lt;p&gt;Amount to send to Payee&lt;/p&gt; &lt;p&gt;The maximum payment amount is dependent on the currency&lt;/p&gt; | |
10
10
  | **payment_memo** | **String** | &lt;p&gt;Any value here will override the memo value in the parent payout&lt;/p&gt; &lt;p&gt;This should be the reference field on the statement seen by the payee (but not via ACH)&lt;/p&gt; | [optional] |
11
11
  | **source_account_name** | **String** | Must match a valid source account name belonging to the payor | |
12
12
  | **payor_payment_id** | **String** | A reference identifier for the payor for the given payee payment | [optional] |
13
- | **transmission_type** | [**TransmissionType**](TransmissionType.md) | | [optional] |
13
+ | **transmission_type** | **String** | Optionally choose a specific transmission method for the payment | [optional] |
14
14
  | **remote_system_id** | **String** | &lt;p&gt;The identifier for the remote payments system if not Velo&lt;/p&gt; &lt;p&gt;Should only be used after consultation with Velo Payments&lt;/p&gt; | [optional] |
15
15
  | **payment_metadata** | **String** | &lt;p&gt;Metadata about the payment that may be relevant to the specific rails or remote system making the payout&lt;/p&gt; &lt;p&gt;The structure of the data will be dictated by the requirements of the payment rails&lt;/p&gt; | [optional] |
16
16
 
@@ -26,7 +26,7 @@ instance = VeloPayments::PaymentInstructionV3.new(
26
26
  payment_memo: my memo,
27
27
  source_account_name: MyAccountName,
28
28
  payor_payment_id: 123211321ABSD,
29
- transmission_type: null,
29
+ transmission_type: ACH,
30
30
  remote_system_id: null,
31
31
  payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567
32
32
  )
data/docs/PaymentResponseV3.md CHANGED
@@ -13,14 +13,14 @@
13
13
  | **source_account_name** | **String** | The name of the source account from which the payment was taken | [optional] |
14
14
  | **remote_id** | **String** | The remote id by which the payor refers to the payee. Only populated once payment is confirmed | [optional] |
15
15
  | **source_amount** | **Integer** | The source amount for the payment (amount debited to make the payment) | [optional] |
16
- | **source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional] |
16
+ | **source_currency** | **String** | ISO 3 character currency code | [optional] |
17
17
  | **payment_amount** | **Integer** | The amount which the payee will receive | |
18
- | **payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional] |
18
+ | **payment_currency** | **String** | ISO 3 character currency code | [optional] |
19
19
  | **rate** | **Float** | The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] |
20
20
  | **inverted_rate** | **Float** | The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] |
21
21
  | **submitted_date_time** | **Time** | | |
22
- | **status** | **String** | | |
23
- | **funding_status** | **String** | The funding status of the payment | |
22
+ | **status** | **String** | Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, FAILED, WITHDRAWN | |
23
+ | **funding_status** | **String** | The funding status of the payment. One of the following values: [FUNDED, INSTRUCTED, UNFUNDED | |
24
24
  | **routing_number** | **String** | The routing number for the payment. | [optional] |
25
25
  | **account_number** | **String** | The account number for the account which will receive the payment. | [optional] |
26
26
  | **iban** | **String** | The iban for the payment. | [optional] |
@@ -39,6 +39,7 @@
39
39
  | **return_reason** | **String** | | [optional] |
40
40
  | **rails_payment_id** | **String** | | [optional] |
41
41
  | **rails_batch_id** | **String** | | [optional] |
42
+ | **payment_scheme** | **String** | | [optional] |
42
43
  | **rejection_reason** | **String** | | [optional] |
43
44
 
44
45
  ## Example
@@ -82,6 +83,7 @@ instance = VeloPayments::PaymentResponseV3.new(
82
83
  return_reason: Some Reason Value,
83
84
  rails_payment_id: null,
84
85
  rails_batch_id: null,
86
+ payment_scheme: null,
85
87
  rejection_reason: null
86
88
  )
87
89
  ```
data/docs/PaymentResponseV4.md CHANGED
@@ -15,15 +15,15 @@
15
15
  | **remote_system_id** | **String** | The velo id of the remote system orchestrating the payment. Not populated for normal Velo payments. | [optional] |
16
16
  | **remote_system_payment_id** | **String** | The id of the payment in the remote system. Not populated for normal Velo payments. | [optional] |
17
17
  | **source_amount** | **Integer** | The source amount for the payment (amount debited to make the payment) | [optional] |
18
- | **source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) | | [optional] |
18
+ | **source_currency** | **String** | ISO-4217 3 character currency code | [optional] |
19
19
  | **payment_amount** | **Integer** | The amount which the payee will receive | |
20
- | **payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) | | [optional] |
20
+ | **payment_currency** | **String** | ISO-4217 3 character currency code | [optional] |
21
21
  | **rate** | **Float** | The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] |
22
22
  | **inverted_rate** | **Float** | The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] |
23
23
  | **is_payment_ccy_base_ccy** | **Boolean** | | [optional] |
24
24
  | **submitted_date_time** | **Time** | | |
25
- | **status** | **String** | | |
26
- | **funding_status** | **String** | The funding status of the payment | |
25
+ | **status** | **String** | Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, RETURNED, WITHDRAWN | |
26
+ | **funding_status** | **String** | Current funding status of the payment. One of the following values: FUNDED, INSTRUCTED, UNFUNDED | |
27
27
  | **routing_number** | **String** | The routing number for the payment. | [optional] |
28
28
  | **account_number** | **String** | The account number for the account which will receive the payment. | [optional] |
29
29
  | **iban** | **String** | The iban for the payment. | [optional] |
@@ -37,17 +37,22 @@
37
37
  | **account_name** | **String** | | [optional] |
38
38
  | **rails_id** | **String** | The rails ID. Default value is RAILS ID UNAVAILABLE when not populated. | [default to &#39;RAILS ID UNAVAILABLE&#39;] |
39
39
  | **country_code** | **String** | The country code of the payment channel. | [optional] |
40
+ | **payee_address_country_code** | **String** | The country code of the payee&#39;s address. | [optional] |
40
41
  | **events** | [**Array&lt;PaymentEventResponse&gt;**](PaymentEventResponse.md) | | |
41
42
  | **return_cost** | **Integer** | The return cost if a returned payment. | [optional] |
42
43
  | **return_reason** | **String** | | [optional] |
43
44
  | **rails_payment_id** | **String** | | [optional] |
44
45
  | **rails_batch_id** | **String** | | [optional] |
46
+ | **payment_scheme** | **String** | | [optional] |
45
47
  | **rejection_reason** | **String** | | [optional] |
46
48
  | **withdrawn_reason** | **String** | | [optional] |
47
49
  | **withdrawable** | **Boolean** | | [optional] |
48
- | **transmission_type** | **String** | The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE | [optional] |
50
+ | **auto_withdrawn_reason_code** | **String** | Populated with rejection reason code if the payment was withdrawn automatically at instruct time | [optional] |
51
+ | **transmission_type** | **String** | The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE, GACHO | [optional] |
49
52
  | **payment_tracking_reference** | **String** | | [optional] |
50
53
  | **payment_metadata** | **String** | Metadata for the payment | [optional] |
54
+ | **schedule** | [**PayoutSchedule**](PayoutSchedule.md) | | [optional] |
55
+ | **post_instruct_fx_info** | [**PostInstructFxInfo**](PostInstructFxInfo.md) | | [optional] |
51
56
  | **payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) | | [optional] |
52
57
 
53
58
  ## Example
@@ -67,9 +72,9 @@ instance = VeloPayments::PaymentResponseV4.new(
67
72
  remote_system_id: REMOTE_SYSTEM_ID,
68
73
  remote_system_payment_id: null,
69
74
  source_amount: 12345,
70
- source_currency: null,
75
+ source_currency: EUR,
71
76
  payment_amount: null,
72
- payment_currency: null,
77
+ payment_currency: EUR,
73
78
  rate: null,
74
79
  inverted_rate: null,
75
80
  is_payment_ccy_base_ccy: null,
@@ -89,17 +94,22 @@ instance = VeloPayments::PaymentResponseV4.new(
89
94
  account_name: My Account Name,
90
95
  rails_id: asdf123,
91
96
  country_code: US,
97
+ payee_address_country_code: US,
92
98
  events: null,
93
99
  return_cost: 1232,
94
100
  return_reason: Some Reason Value,
95
101
  rails_payment_id: null,
96
102
  rails_batch_id: null,
103
+ payment_scheme: null,
97
104
  rejection_reason: null,
98
105
  withdrawn_reason: null,
99
106
  withdrawable: null,
107
+ auto_withdrawn_reason_code: null,
100
108
  transmission_type: null,
101
109
  payment_tracking_reference: null,
102
110
  payment_metadata: sample metadata,
111
+ schedule: null,
112
+ post_instruct_fx_info: null,
103
113
  payout: null
104
114
  )
105
115
  ```