velopayments 2.35.58 → 2.37.150.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 (336) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +50 -11
  4. data/docs/{PayorAddress.md → AddressV4.md} +3 -3
  5. data/docs/CommonLinkObject.md +20 -0
  6. data/docs/CommonPageObject.md +26 -0
  7. data/docs/CreateFundingAccountRequestV2.md +2 -2
  8. data/docs/CreatePaymentChannelRequestV4.md +30 -0
  9. data/docs/CreateTransactionRequest.md +24 -0
  10. data/docs/CreateTransactionResponse.md +20 -0
  11. data/docs/FundingAccountResponseV2.md +3 -3
  12. data/docs/FundingApi.md +2 -2
  13. data/docs/FundingAudit.md +8 -2
  14. data/docs/FundingEvent.md +6 -8
  15. data/docs/FundingEvent2.md +24 -0
  16. data/docs/FundingManagerPrivateApi.md +1 -1
  17. data/docs/FundingResponse.md +7 -3
  18. data/docs/GetPayeeListResponseV4.md +2 -0
  19. data/docs/InstructPayoutRequestV3.md +4 -2
  20. data/docs/ListFundingAccountsResponseV2.md +1 -1
  21. data/docs/NotificationSource.md +3 -0
  22. data/docs/PageResourceTransactions.md +22 -0
  23. data/docs/PayeeDetailResponseV4.md +4 -0
  24. data/docs/PayeePaymentChannelsApi.md +522 -0
  25. data/docs/PayeesApi.md +2 -2
  26. data/docs/PaymentAuditServiceApi.md +7 -1
  27. data/docs/PaymentChannelOrderRequestV4.md +18 -0
  28. data/docs/PaymentChannelResponseV4.md +56 -0
  29. data/docs/PaymentChannelSummaryV4.md +32 -0
  30. data/docs/PaymentChannelsResponseV4.md +20 -0
  31. data/docs/PaymentInstructionV3.md +4 -2
  32. data/docs/PaymentResponseV4.md +10 -0
  33. data/docs/PaymentV3.md +4 -2
  34. data/docs/PayorCreateApiKeyRequest.md +3 -3
  35. data/docs/PayorFundingDetected.md +46 -0
  36. data/docs/PayorFundingDetectedAllOf.md +40 -0
  37. data/docs/PayorToPaymentChannelMappingV4.md +20 -0
  38. data/docs/PayorV2.md +19 -19
  39. data/docs/PayorsApi.md +14 -84
  40. data/docs/PayoutsApi.md +2 -2
  41. data/docs/SourceAccountResponseV3.md +3 -1
  42. data/docs/TransactionResponse.md +36 -0
  43. data/docs/TransactionsApi.md +229 -0
  44. data/docs/UpdatePayeeDetailsRequestV3.md +3 -1
  45. data/docs/UpdatePaymentChannelRequestV4.md +30 -0
  46. data/docs/WebhooksResponse.md +2 -2
  47. data/lib/velopayments/api/countries_api.rb +2 -2
  48. data/lib/velopayments/api/currencies_api.rb +2 -2
  49. data/lib/velopayments/api/funding_api.rb +5 -5
  50. data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
  51. data/lib/velopayments/api/login_api.rb +2 -2
  52. data/lib/velopayments/api/payee_invitation_api.rb +2 -2
  53. data/lib/velopayments/api/payee_payment_channels_api.rb +538 -0
  54. data/lib/velopayments/api/payees_api.rb +6 -2
  55. data/lib/velopayments/api/payment_audit_service_api.rb +12 -3
  56. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +2 -2
  57. data/lib/velopayments/api/payor_hierarchy_api.rb +2 -2
  58. data/lib/velopayments/api/payors_api.rb +16 -79
  59. data/lib/velopayments/api/payors_private_api.rb +2 -2
  60. data/lib/velopayments/api/payouts_api.rb +2 -6
  61. data/lib/velopayments/api/source_accounts_api.rb +2 -2
  62. data/lib/velopayments/api/tokens_api.rb +2 -2
  63. data/lib/velopayments/api/transactions_api.rb +229 -0
  64. data/lib/velopayments/api/users_api.rb +2 -2
  65. data/lib/velopayments/api/webhooks_api.rb +2 -2
  66. data/lib/velopayments/api_client.rb +2 -2
  67. data/lib/velopayments/api_error.rb +2 -2
  68. data/lib/velopayments/configuration.rb +2 -2
  69. data/lib/velopayments/models/accepted_payment_v3.rb +2 -2
  70. data/lib/velopayments/models/access_token_response.rb +2 -2
  71. data/lib/velopayments/models/access_token_validation_request.rb +2 -2
  72. data/lib/velopayments/models/{payor_address.rb → address_v4.rb} +92 -80
  73. data/lib/velopayments/models/auth_response.rb +2 -2
  74. data/lib/velopayments/models/auto_top_up_config_v2.rb +2 -2
  75. data/lib/velopayments/models/auto_top_up_config_v3.rb +2 -2
  76. data/lib/velopayments/models/category.rb +4 -3
  77. data/lib/velopayments/models/challenge_v3.rb +2 -2
  78. data/lib/velopayments/models/challenge_v4.rb +2 -2
  79. data/lib/velopayments/models/{list_funding_accounts_response_v2_links.rb → common_link_object.rb} +7 -5
  80. data/lib/velopayments/models/common_page_object.rb +250 -0
  81. data/lib/velopayments/models/company_v3.rb +2 -2
  82. data/lib/velopayments/models/company_v4.rb +2 -2
  83. data/lib/velopayments/models/create_funding_account_request_v2.rb +34 -27
  84. data/lib/velopayments/models/create_individual_v3.rb +2 -2
  85. data/lib/velopayments/models/create_individual_v3_name.rb +2 -2
  86. data/lib/velopayments/models/create_individual_v4.rb +2 -2
  87. data/lib/velopayments/models/create_payee_address_v3.rb +2 -2
  88. data/lib/velopayments/models/create_payee_address_v4.rb +2 -2
  89. data/lib/velopayments/models/create_payee_v3.rb +2 -2
  90. data/lib/velopayments/models/create_payee_v4.rb +2 -2
  91. data/lib/velopayments/models/create_payees_csv_request_v3.rb +2 -2
  92. data/lib/velopayments/models/create_payees_csv_request_v4.rb +2 -2
  93. data/lib/velopayments/models/create_payees_csv_response_v3.rb +2 -2
  94. data/lib/velopayments/models/create_payees_csv_response_v3_rejected_csv_rows.rb +2 -2
  95. data/lib/velopayments/models/create_payees_csv_response_v4.rb +2 -2
  96. data/lib/velopayments/models/create_payees_request_v3.rb +2 -2
  97. data/lib/velopayments/models/create_payees_request_v4.rb +2 -2
  98. data/lib/velopayments/models/create_payment_channel_request_v4.rb +472 -0
  99. data/lib/velopayments/models/create_payment_channel_v3.rb +2 -2
  100. data/lib/velopayments/models/create_payment_channel_v4.rb +2 -2
  101. data/lib/velopayments/models/create_payor_link_request.rb +2 -2
  102. data/lib/velopayments/models/create_payout_request_v3.rb +2 -2
  103. data/lib/velopayments/models/create_transaction_request.rb +324 -0
  104. data/lib/velopayments/models/create_transaction_response.rb +239 -0
  105. data/lib/velopayments/models/create_webhook_request.rb +2 -2
  106. data/lib/velopayments/models/debit_event.rb +2 -2
  107. data/lib/velopayments/models/debit_event_all_of.rb +2 -2
  108. data/lib/velopayments/models/debit_status_changed.rb +2 -2
  109. data/lib/velopayments/models/debit_status_changed_all_of.rb +2 -2
  110. data/lib/velopayments/models/error.rb +2 -2
  111. data/lib/velopayments/models/error_data.rb +2 -2
  112. data/lib/velopayments/models/error_response.rb +2 -2
  113. data/lib/velopayments/models/failed_payee_v3.rb +2 -2
  114. data/lib/velopayments/models/failed_payee_v4.rb +2 -2
  115. data/lib/velopayments/models/failed_submission_v3.rb +2 -2
  116. data/lib/velopayments/models/failed_submission_v4.rb +2 -2
  117. data/lib/velopayments/models/funding_account_response_v2.rb +25 -25
  118. data/lib/velopayments/models/funding_audit.rb +37 -7
  119. data/lib/velopayments/models/funding_event.rb +50 -28
  120. data/lib/velopayments/models/funding_event2.rb +242 -0
  121. data/lib/velopayments/models/funding_payor_status_audit_response.rb +2 -2
  122. data/lib/velopayments/models/funding_request_v2.rb +2 -2
  123. data/lib/velopayments/models/funding_request_v3.rb +2 -2
  124. data/lib/velopayments/models/funding_response.rb +35 -14
  125. data/lib/velopayments/models/fx_summary.rb +2 -2
  126. data/lib/velopayments/models/fx_summary_v3.rb +2 -2
  127. data/lib/velopayments/models/get_fundings_response.rb +2 -2
  128. data/lib/velopayments/models/get_fundings_response_links.rb +2 -2
  129. data/lib/velopayments/models/get_payee_list_response_company_v3.rb +2 -2
  130. data/lib/velopayments/models/get_payee_list_response_company_v4.rb +2 -2
  131. data/lib/velopayments/models/get_payee_list_response_individual_v3.rb +2 -2
  132. data/lib/velopayments/models/get_payee_list_response_individual_v4.rb +2 -2
  133. data/lib/velopayments/models/get_payee_list_response_v3.rb +2 -2
  134. data/lib/velopayments/models/get_payee_list_response_v4.rb +13 -3
  135. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +2 -2
  136. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +2 -2
  137. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +2 -2
  138. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +2 -2
  139. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +2 -2
  140. data/lib/velopayments/models/get_payout_statistics.rb +2 -2
  141. data/lib/velopayments/models/get_payouts_response.rb +2 -2
  142. data/lib/velopayments/models/get_payouts_response_v3.rb +2 -2
  143. data/lib/velopayments/models/get_payouts_response_v3_links.rb +2 -2
  144. data/lib/velopayments/models/get_payouts_response_v3_page.rb +2 -2
  145. data/lib/velopayments/models/individual_v3.rb +2 -2
  146. data/lib/velopayments/models/individual_v3_name.rb +2 -2
  147. data/lib/velopayments/models/individual_v4.rb +2 -2
  148. data/lib/velopayments/models/inline_response400.rb +2 -2
  149. data/lib/velopayments/models/inline_response401.rb +2 -2
  150. data/lib/velopayments/models/inline_response403.rb +2 -2
  151. data/lib/velopayments/models/inline_response404.rb +2 -2
  152. data/lib/velopayments/models/inline_response409.rb +2 -2
  153. data/lib/velopayments/models/inline_response412.rb +2 -2
  154. data/lib/velopayments/models/instruct_payout_request_v3.rb +19 -7
  155. data/lib/velopayments/models/invite_payee_request_v3.rb +2 -2
  156. data/lib/velopayments/models/invite_payee_request_v4.rb +2 -2
  157. data/lib/velopayments/models/invite_user_request.rb +2 -2
  158. data/lib/velopayments/models/link_for_response.rb +2 -2
  159. data/lib/velopayments/models/list_funding_accounts_response_v2.rb +3 -3
  160. data/lib/velopayments/models/list_funding_accounts_response_v2_page.rb +2 -2
  161. data/lib/velopayments/models/list_payments_response_v3.rb +2 -2
  162. data/lib/velopayments/models/list_payments_response_v3_page.rb +2 -2
  163. data/lib/velopayments/models/list_payments_response_v4.rb +2 -2
  164. data/lib/velopayments/models/list_source_account_response_v2.rb +2 -2
  165. data/lib/velopayments/models/list_source_account_response_v2_links.rb +2 -2
  166. data/lib/velopayments/models/list_source_account_response_v3.rb +2 -2
  167. data/lib/velopayments/models/list_source_account_response_v3_links.rb +2 -2
  168. data/lib/velopayments/models/localisation_details.rb +2 -2
  169. data/lib/velopayments/models/mfa_details.rb +2 -2
  170. data/lib/velopayments/models/mfa_type.rb +2 -2
  171. data/lib/velopayments/models/name_v3.rb +2 -2
  172. data/lib/velopayments/models/name_v4.rb +2 -2
  173. data/lib/velopayments/models/notification.rb +2 -2
  174. data/lib/velopayments/models/notification_source.rb +4 -2
  175. data/lib/velopayments/models/notifications_v2.rb +2 -2
  176. data/lib/velopayments/models/notifications_v3.rb +2 -2
  177. data/lib/velopayments/models/onboarding_status_changed.rb +2 -2
  178. data/lib/velopayments/models/page_for_response.rb +2 -2
  179. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +2 -2
  180. data/lib/velopayments/models/page_resource_transactions.rb +236 -0
  181. data/lib/velopayments/models/paged_payee_invitation_status_response_v3.rb +2 -2
  182. data/lib/velopayments/models/paged_payee_invitation_status_response_v3_page.rb +2 -2
  183. data/lib/velopayments/models/paged_payee_invitation_status_response_v4.rb +2 -2
  184. data/lib/velopayments/models/paged_payee_response_v3.rb +2 -2
  185. data/lib/velopayments/models/paged_payee_response_v3_links.rb +2 -2
  186. data/lib/velopayments/models/paged_payee_response_v3_page.rb +2 -2
  187. data/lib/velopayments/models/paged_payee_response_v3_summary.rb +2 -2
  188. data/lib/velopayments/models/paged_payee_response_v4.rb +2 -2
  189. data/lib/velopayments/models/paged_payments_response_v3.rb +2 -2
  190. data/lib/velopayments/models/paged_user_response.rb +2 -2
  191. data/lib/velopayments/models/paged_user_response_links.rb +2 -2
  192. data/lib/velopayments/models/paged_user_response_page.rb +2 -2
  193. data/lib/velopayments/models/password_request.rb +12 -12
  194. data/lib/velopayments/models/payable_issue_v3.rb +2 -2
  195. data/lib/velopayments/models/payable_issue_v4.rb +2 -2
  196. data/lib/velopayments/models/payable_status_changed.rb +2 -2
  197. data/lib/velopayments/models/payee_address_v3.rb +2 -2
  198. data/lib/velopayments/models/payee_address_v4.rb +2 -2
  199. data/lib/velopayments/models/payee_delta_response_v3.rb +2 -2
  200. data/lib/velopayments/models/payee_delta_response_v3_links.rb +2 -2
  201. data/lib/velopayments/models/payee_delta_response_v3_page.rb +2 -2
  202. data/lib/velopayments/models/payee_delta_response_v4.rb +2 -2
  203. data/lib/velopayments/models/payee_delta_response_v4_links.rb +2 -2
  204. data/lib/velopayments/models/payee_delta_v3.rb +2 -2
  205. data/lib/velopayments/models/payee_delta_v4.rb +2 -2
  206. data/lib/velopayments/models/payee_detail_response_v3.rb +2 -2
  207. data/lib/velopayments/models/payee_detail_response_v4.rb +26 -3
  208. data/lib/velopayments/models/payee_details_changed.rb +2 -2
  209. data/lib/velopayments/models/payee_event.rb +2 -2
  210. data/lib/velopayments/models/payee_event_all_of.rb +2 -2
  211. data/lib/velopayments/models/payee_event_all_of_reasons.rb +2 -2
  212. data/lib/velopayments/models/payee_invitation_status_response_v3.rb +2 -2
  213. data/lib/velopayments/models/payee_invitation_status_response_v4.rb +2 -2
  214. data/lib/velopayments/models/payee_payor_ref_v3.rb +2 -2
  215. data/lib/velopayments/models/payee_payor_ref_v4.rb +2 -2
  216. data/lib/velopayments/models/payee_type.rb +2 -2
  217. data/lib/velopayments/models/payee_type_enum.rb +2 -2
  218. data/lib/velopayments/models/payee_user_self_update_request.rb +2 -2
  219. data/lib/velopayments/models/payment_channel_country.rb +2 -2
  220. data/lib/velopayments/models/{transmission_types.rb → payment_channel_order_request_v4.rb} +19 -51
  221. data/lib/velopayments/models/payment_channel_response_v4.rb +607 -0
  222. data/lib/velopayments/models/payment_channel_rule.rb +2 -2
  223. data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
  224. data/lib/velopayments/models/payment_channel_summary_v4.rb +396 -0
  225. data/lib/velopayments/models/payment_channels_response_v4.rb +227 -0
  226. data/lib/velopayments/models/payment_delta.rb +2 -2
  227. data/lib/velopayments/models/payment_delta_response.rb +2 -2
  228. data/lib/velopayments/models/payment_delta_response_v1.rb +2 -2
  229. data/lib/velopayments/models/payment_delta_v1.rb +2 -2
  230. data/lib/velopayments/models/payment_event.rb +2 -2
  231. data/lib/velopayments/models/payment_event_all_of.rb +2 -2
  232. data/lib/velopayments/models/payment_event_response.rb +2 -2
  233. data/lib/velopayments/models/payment_event_response_v3.rb +2 -2
  234. data/lib/velopayments/models/payment_instruction_v3.rb +19 -50
  235. data/lib/velopayments/models/payment_rejected_or_returned.rb +2 -2
  236. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +2 -2
  237. data/lib/velopayments/models/payment_response_v3.rb +2 -2
  238. data/lib/velopayments/models/payment_response_v4.rb +50 -3
  239. data/lib/velopayments/models/payment_response_v4_payout.rb +2 -2
  240. data/lib/velopayments/models/payment_status_changed.rb +2 -2
  241. data/lib/velopayments/models/payment_status_changed_all_of.rb +2 -2
  242. data/lib/velopayments/models/payment_v3.rb +17 -7
  243. data/lib/velopayments/models/payor_address_v2.rb +32 -17
  244. data/lib/velopayments/models/payor_aml_transaction.rb +2 -2
  245. data/lib/velopayments/models/payor_aml_transaction_v3.rb +2 -2
  246. data/lib/velopayments/models/payor_branding_response.rb +2 -5
  247. data/lib/velopayments/models/payor_create_api_key_request.rb +2 -2
  248. data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
  249. data/lib/velopayments/models/payor_create_application_request.rb +2 -2
  250. data/lib/velopayments/models/payor_email_opt_out_request.rb +2 -2
  251. data/lib/velopayments/models/payor_funding_detected.rb +399 -0
  252. data/lib/velopayments/models/payor_funding_detected_all_of.rb +339 -0
  253. data/lib/velopayments/models/payor_links_response.rb +2 -2
  254. data/lib/velopayments/models/payor_links_response_links.rb +2 -2
  255. data/lib/velopayments/models/payor_links_response_payors.rb +2 -2
  256. data/lib/velopayments/models/{transmission_types2.rb → payor_to_payment_channel_mapping_v4.rb} +18 -51
  257. data/lib/velopayments/models/payor_v2.rb +26 -20
  258. data/lib/velopayments/models/payout_company_v3.rb +2 -2
  259. data/lib/velopayments/models/payout_individual_v3.rb +2 -2
  260. data/lib/velopayments/models/payout_name_v3.rb +2 -2
  261. data/lib/velopayments/models/payout_payee_v3.rb +2 -2
  262. data/lib/velopayments/models/payout_payor.rb +2 -2
  263. data/lib/velopayments/models/payout_payor_ids.rb +2 -2
  264. data/lib/velopayments/models/payout_principal.rb +2 -2
  265. data/lib/velopayments/models/payout_schedule.rb +2 -2
  266. data/lib/velopayments/models/payout_schedule_v3.rb +2 -2
  267. data/lib/velopayments/models/payout_summary_audit.rb +2 -2
  268. data/lib/velopayments/models/payout_summary_audit_v3.rb +2 -2
  269. data/lib/velopayments/models/payout_summary_response_v3.rb +2 -2
  270. data/lib/velopayments/models/ping.rb +2 -2
  271. data/lib/velopayments/models/ping_response.rb +2 -2
  272. data/lib/velopayments/models/post_instruct_fx_info.rb +2 -2
  273. data/lib/velopayments/models/query_batch_response_v3.rb +2 -2
  274. data/lib/velopayments/models/query_batch_response_v4.rb +2 -2
  275. data/lib/velopayments/models/quote_fx_summary_v3.rb +2 -2
  276. data/lib/velopayments/models/quote_response_v3.rb +2 -2
  277. data/lib/velopayments/models/region_v2.rb +2 -2
  278. data/lib/velopayments/models/register_sms_request.rb +2 -2
  279. data/lib/velopayments/models/rejected_payment_v3.rb +2 -2
  280. data/lib/velopayments/models/resend_token_request.rb +2 -2
  281. data/lib/velopayments/models/reset_password_request.rb +2 -2
  282. data/lib/velopayments/models/role.rb +2 -2
  283. data/lib/velopayments/models/role_update_request.rb +2 -2
  284. data/lib/velopayments/models/schedule_payout_request_v3.rb +2 -2
  285. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +2 -2
  286. data/lib/velopayments/models/self_update_password_request.rb +22 -22
  287. data/lib/velopayments/models/set_notifications_request.rb +2 -2
  288. data/lib/velopayments/models/set_notifications_request2.rb +2 -2
  289. data/lib/velopayments/models/source_account_response_v2.rb +2 -2
  290. data/lib/velopayments/models/source_account_response_v3.rb +18 -6
  291. data/lib/velopayments/models/source_account_summary.rb +2 -2
  292. data/lib/velopayments/models/source_account_summary_v3.rb +2 -2
  293. data/lib/velopayments/models/source_account_v3.rb +2 -2
  294. data/lib/velopayments/models/source_event.rb +2 -2
  295. data/lib/velopayments/models/supported_countries_response.rb +2 -2
  296. data/lib/velopayments/models/supported_countries_response_v2.rb +2 -2
  297. data/lib/velopayments/models/supported_country.rb +2 -2
  298. data/lib/velopayments/models/supported_country_v2.rb +2 -2
  299. data/lib/velopayments/models/supported_currency_response_v2.rb +2 -2
  300. data/lib/velopayments/models/supported_currency_v2.rb +2 -2
  301. data/lib/velopayments/models/{payor_v1.rb → transaction_response.rb} +143 -181
  302. data/lib/velopayments/models/transfer_request_v2.rb +2 -2
  303. data/lib/velopayments/models/transfer_request_v3.rb +2 -2
  304. data/lib/velopayments/models/unregister_mfa_request.rb +2 -2
  305. data/lib/velopayments/models/update_payee_details_request_v3.rb +38 -7
  306. data/lib/velopayments/models/update_payee_details_request_v4.rb +2 -2
  307. data/lib/velopayments/models/update_payment_channel_request_v4.rb +472 -0
  308. data/lib/velopayments/models/update_remote_id_request_v3.rb +2 -2
  309. data/lib/velopayments/models/update_remote_id_request_v4.rb +2 -2
  310. data/lib/velopayments/models/update_webhook_request.rb +2 -2
  311. data/lib/velopayments/models/user_details_update_request.rb +2 -2
  312. data/lib/velopayments/models/user_info.rb +2 -2
  313. data/lib/velopayments/models/user_response.rb +4 -4
  314. data/lib/velopayments/models/user_status.rb +2 -2
  315. data/lib/velopayments/models/user_type.rb +2 -2
  316. data/lib/velopayments/models/user_type2.rb +2 -2
  317. data/lib/velopayments/models/validate_password_response.rb +2 -2
  318. data/lib/velopayments/models/webhook_response.rb +2 -2
  319. data/lib/velopayments/models/webhooks_response.rb +4 -4
  320. data/lib/velopayments/models/withdraw_payment_request.rb +2 -2
  321. data/lib/velopayments/version.rb +3 -3
  322. data/lib/velopayments.rb +21 -7
  323. data/oa3-config.json +1 -1
  324. data/spec/api/payee_payment_channels_api_spec.rb +132 -0
  325. data/spec/api/transactions_api_spec.rb +75 -0
  326. data/spec/api_client_spec.rb +2 -2
  327. data/spec/configuration_spec.rb +2 -2
  328. data/spec/spec_helper.rb +2 -2
  329. data/specs/api/payee_payment_channels_api_spec.rb +132 -0
  330. data/specs/api/transactions_api_spec.rb +75 -0
  331. data/velopayments.gemspec +2 -2
  332. metadata +48 -14
  333. data/docs/ListFundingAccountsResponseV2Links.md +0 -20
  334. data/docs/PayorV1.md +0 -60
  335. data/docs/TransmissionTypes.md +0 -22
  336. data/docs/TransmissionTypes2.md +0 -22
@@ -0,0 +1,22 @@
1
+ # VeloPayments::PageResourceTransactions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<LinkForResponse>**](LinkForResponse.md) | | [optional] |
8
+ | **page** | [**PageForResponse**](PageForResponse.md) | | [optional] |
9
+ | **content** | [**Array<TransactionResponse>**](TransactionResponse.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'velopayments'
15
+
16
+ instance = VeloPayments::PageResourceTransactions.new(
17
+ links: null,
18
+ page: null,
19
+ content: null
20
+ )
21
+ ```
22
+
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **payee_id** | **String** | | [optional][readonly] |
8
8
  | **payor_refs** | [**Array<PayeePayorRefV4>**](PayeePayorRefV4.md) | | [optional][readonly] |
9
+ | **payment_channels** | [**Array<PaymentChannelSummaryV4>**](PaymentChannelSummaryV4.md) | A list of the Payee's payment channels in their preferred order | [optional][readonly] |
9
10
  | **email** | **String** | | [optional] |
10
11
  | **onboarded_status** | **String** | Payee onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED | [optional] |
11
12
  | **watchlist_status** | **String** | Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED | [optional] |
@@ -23,6 +24,7 @@
23
24
  | **individual** | [**IndividualV4**](IndividualV4.md) | | [optional] |
24
25
  | **company** | [**CompanyV4**](CompanyV4.md) | | [optional] |
25
26
  | **cellphone_number** | **String** | | [optional] |
27
+ | **managed_by_payor_id** | **String** | The id of the payor if the payee is managed | [optional] |
26
28
  | **watchlist_status_updated_timestamp** | **String** | | [optional][readonly] |
27
29
  | **grace_period_end_date** | **Date** | | [optional][readonly] |
28
30
  | **enhanced_kyc_completed** | **Boolean** | | [optional] |
@@ -42,6 +44,7 @@ require 'velopayments'
42
44
  instance = VeloPayments::PayeeDetailResponseV4.new(
43
45
  payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
44
46
  payor_refs: null,
47
+ payment_channels: null,
45
48
  email: bob@example.com,
46
49
  onboarded_status: null,
47
50
  watchlist_status: null,
@@ -59,6 +62,7 @@ instance = VeloPayments::PayeeDetailResponseV4.new(
59
62
  individual: null,
60
63
  company: null,
61
64
  cellphone_number: 1234567890,
65
+ managed_by_payor_id: a2967711-df07-41e5-b5ea-0f563088911c,
62
66
  watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
63
67
  grace_period_end_date: Sun Jan 20 00:00:00 UTC 2019,
64
68
  enhanced_kyc_completed: null,
@@ -0,0 +1,522 @@
1
+ # VeloPayments::PayeePaymentChannelsApi
2
+
3
+ All URIs are relative to *https://api.sandbox.velopayments.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_payment_channel_v4**](PayeePaymentChannelsApi.md#create_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/ | Create Payment Channel |
8
+ | [**delete_payment_channel_v4**](PayeePaymentChannelsApi.md#delete_payment_channel_v4) | **DELETE** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Delete Payment Channel |
9
+ | [**enable_payment_channel_v4**](PayeePaymentChannelsApi.md#enable_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}/enable | Enable Payment Channel |
10
+ | [**get_payment_channel_v4**](PayeePaymentChannelsApi.md#get_payment_channel_v4) | **GET** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Get Payment Channel Details |
11
+ | [**get_payment_channels_v4**](PayeePaymentChannelsApi.md#get_payment_channels_v4) | **GET** /v4/payees/{payeeId}/paymentChannels/ | Get All Payment Channels Details |
12
+ | [**update_payment_channel_order_v4**](PayeePaymentChannelsApi.md#update_payment_channel_order_v4) | **PUT** /v4/payees/{payeeId}/paymentChannels/order | Update Payees preferred Payment Channel order |
13
+ | [**update_payment_channel_v4**](PayeePaymentChannelsApi.md#update_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Update Payment Channel |
14
+
15
+
16
+ ## create_payment_channel_v4
17
+
18
+ > create_payment_channel_v4(payee_id, create_payment_channel_request_v4)
19
+
20
+ Create Payment Channel
21
+
22
+ <p>Create a payment channel</p>
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ require 'time'
28
+ require 'velopayments'
29
+ # setup authorization
30
+ VeloPayments.configure do |config|
31
+ # Configure OAuth2 access token for authorization: OAuth2
32
+ config.access_token = 'YOUR ACCESS TOKEN'
33
+ end
34
+
35
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
36
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
37
+ create_payment_channel_request_v4 = VeloPayments::CreatePaymentChannelRequestV4.new # CreatePaymentChannelRequestV4 | Post payment channel to update
38
+
39
+ begin
40
+ # Create Payment Channel
41
+ api_instance.create_payment_channel_v4(payee_id, create_payment_channel_request_v4)
42
+ rescue VeloPayments::ApiError => e
43
+ puts "Error when calling PayeePaymentChannelsApi->create_payment_channel_v4: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the create_payment_channel_v4_with_http_info variant
48
+
49
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
50
+
51
+ > <Array(nil, Integer, Hash)> create_payment_channel_v4_with_http_info(payee_id, create_payment_channel_request_v4)
52
+
53
+ ```ruby
54
+ begin
55
+ # Create Payment Channel
56
+ data, status_code, headers = api_instance.create_payment_channel_v4_with_http_info(payee_id, create_payment_channel_request_v4)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => nil
60
+ rescue VeloPayments::ApiError => e
61
+ puts "Error when calling PayeePaymentChannelsApi->create_payment_channel_v4_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **payee_id** | **String** | The UUID of the payee. | |
70
+ | **create_payment_channel_request_v4** | [**CreatePaymentChannelRequestV4**](CreatePaymentChannelRequestV4.md) | Post payment channel to update | |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ [OAuth2](../README.md#OAuth2)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+ ## delete_payment_channel_v4
87
+
88
+ > delete_payment_channel_v4(payee_id, payment_channel_id)
89
+
90
+ Delete Payment Channel
91
+
92
+ <p>Delete a payees payment channel</p>
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'velopayments'
99
+ # setup authorization
100
+ VeloPayments.configure do |config|
101
+ # Configure OAuth2 access token for authorization: OAuth2
102
+ config.access_token = 'YOUR ACCESS TOKEN'
103
+ end
104
+
105
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
106
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
107
+ payment_channel_id = '70faaff7-2c32-4b44-b27f-f0b6c484e6f3' # String | The UUID of the payment channel.
108
+
109
+ begin
110
+ # Delete Payment Channel
111
+ api_instance.delete_payment_channel_v4(payee_id, payment_channel_id)
112
+ rescue VeloPayments::ApiError => e
113
+ puts "Error when calling PayeePaymentChannelsApi->delete_payment_channel_v4: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the delete_payment_channel_v4_with_http_info variant
118
+
119
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
120
+
121
+ > <Array(nil, Integer, Hash)> delete_payment_channel_v4_with_http_info(payee_id, payment_channel_id)
122
+
123
+ ```ruby
124
+ begin
125
+ # Delete Payment Channel
126
+ data, status_code, headers = api_instance.delete_payment_channel_v4_with_http_info(payee_id, payment_channel_id)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => nil
130
+ rescue VeloPayments::ApiError => e
131
+ puts "Error when calling PayeePaymentChannelsApi->delete_payment_channel_v4_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **payee_id** | **String** | The UUID of the payee. | |
140
+ | **payment_channel_id** | **String** | The UUID of the payment channel. | |
141
+
142
+ ### Return type
143
+
144
+ nil (empty response body)
145
+
146
+ ### Authorization
147
+
148
+ [OAuth2](../README.md#OAuth2)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## enable_payment_channel_v4
157
+
158
+ > enable_payment_channel_v4(payee_id, payment_channel_id)
159
+
160
+ Enable Payment Channel
161
+
162
+ <p>Enable a payment channel for a payee</p>
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'velopayments'
169
+ # setup authorization
170
+ VeloPayments.configure do |config|
171
+ # Configure OAuth2 access token for authorization: OAuth2
172
+ config.access_token = 'YOUR ACCESS TOKEN'
173
+ end
174
+
175
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
176
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
177
+ payment_channel_id = '70faaff7-2c32-4b44-b27f-f0b6c484e6f3' # String | The UUID of the payment channel.
178
+
179
+ begin
180
+ # Enable Payment Channel
181
+ api_instance.enable_payment_channel_v4(payee_id, payment_channel_id)
182
+ rescue VeloPayments::ApiError => e
183
+ puts "Error when calling PayeePaymentChannelsApi->enable_payment_channel_v4: #{e}"
184
+ end
185
+ ```
186
+
187
+ #### Using the enable_payment_channel_v4_with_http_info variant
188
+
189
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
190
+
191
+ > <Array(nil, Integer, Hash)> enable_payment_channel_v4_with_http_info(payee_id, payment_channel_id)
192
+
193
+ ```ruby
194
+ begin
195
+ # Enable Payment Channel
196
+ data, status_code, headers = api_instance.enable_payment_channel_v4_with_http_info(payee_id, payment_channel_id)
197
+ p status_code # => 2xx
198
+ p headers # => { ... }
199
+ p data # => nil
200
+ rescue VeloPayments::ApiError => e
201
+ puts "Error when calling PayeePaymentChannelsApi->enable_payment_channel_v4_with_http_info: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ | Name | Type | Description | Notes |
208
+ | ---- | ---- | ----------- | ----- |
209
+ | **payee_id** | **String** | The UUID of the payee. | |
210
+ | **payment_channel_id** | **String** | The UUID of the payment channel. | |
211
+
212
+ ### Return type
213
+
214
+ nil (empty response body)
215
+
216
+ ### Authorization
217
+
218
+ [OAuth2](../README.md#OAuth2)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: application/json
224
+
225
+
226
+ ## get_payment_channel_v4
227
+
228
+ > <PaymentChannelResponseV4> get_payment_channel_v4(payee_id, payment_channel_id, opts)
229
+
230
+ Get Payment Channel Details
231
+
232
+ <p>Get the payment channel details for the payee</p>
233
+
234
+ ### Examples
235
+
236
+ ```ruby
237
+ require 'time'
238
+ require 'velopayments'
239
+ # setup authorization
240
+ VeloPayments.configure do |config|
241
+ # Configure OAuth2 access token for authorization: OAuth2
242
+ config.access_token = 'YOUR ACCESS TOKEN'
243
+ end
244
+
245
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
246
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
247
+ payment_channel_id = '70faaff7-2c32-4b44-b27f-f0b6c484e6f3' # String | The UUID of the payment channel.
248
+ opts = {
249
+ payable: true, # Boolean | payable if true only return the payment channel if the payee is payable
250
+ sensitive: true # Boolean | <p>Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked.</p> <p>If set to true, and you have permission, the PII values will be returned as their original unmasked values.</p>
251
+ }
252
+
253
+ begin
254
+ # Get Payment Channel Details
255
+ result = api_instance.get_payment_channel_v4(payee_id, payment_channel_id, opts)
256
+ p result
257
+ rescue VeloPayments::ApiError => e
258
+ puts "Error when calling PayeePaymentChannelsApi->get_payment_channel_v4: #{e}"
259
+ end
260
+ ```
261
+
262
+ #### Using the get_payment_channel_v4_with_http_info variant
263
+
264
+ This returns an Array which contains the response data, status code and headers.
265
+
266
+ > <Array(<PaymentChannelResponseV4>, Integer, Hash)> get_payment_channel_v4_with_http_info(payee_id, payment_channel_id, opts)
267
+
268
+ ```ruby
269
+ begin
270
+ # Get Payment Channel Details
271
+ data, status_code, headers = api_instance.get_payment_channel_v4_with_http_info(payee_id, payment_channel_id, opts)
272
+ p status_code # => 2xx
273
+ p headers # => { ... }
274
+ p data # => <PaymentChannelResponseV4>
275
+ rescue VeloPayments::ApiError => e
276
+ puts "Error when calling PayeePaymentChannelsApi->get_payment_channel_v4_with_http_info: #{e}"
277
+ end
278
+ ```
279
+
280
+ ### Parameters
281
+
282
+ | Name | Type | Description | Notes |
283
+ | ---- | ---- | ----------- | ----- |
284
+ | **payee_id** | **String** | The UUID of the payee. | |
285
+ | **payment_channel_id** | **String** | The UUID of the payment channel. | |
286
+ | **payable** | **Boolean** | payable if true only return the payment channel if the payee is payable | [optional] |
287
+ | **sensitive** | **Boolean** | &lt;p&gt;Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked.&lt;/p&gt; &lt;p&gt;If set to true, and you have permission, the PII values will be returned as their original unmasked values.&lt;/p&gt; | [optional] |
288
+
289
+ ### Return type
290
+
291
+ [**PaymentChannelResponseV4**](PaymentChannelResponseV4.md)
292
+
293
+ ### Authorization
294
+
295
+ [OAuth2](../README.md#OAuth2)
296
+
297
+ ### HTTP request headers
298
+
299
+ - **Content-Type**: Not defined
300
+ - **Accept**: application/json
301
+
302
+
303
+ ## get_payment_channels_v4
304
+
305
+ > <PaymentChannelsResponseV4> get_payment_channels_v4(payee_id, opts)
306
+
307
+ Get All Payment Channels Details
308
+
309
+ <p>Get all payment channels details for a payee</p>
310
+
311
+ ### Examples
312
+
313
+ ```ruby
314
+ require 'time'
315
+ require 'velopayments'
316
+ # setup authorization
317
+ VeloPayments.configure do |config|
318
+ # Configure OAuth2 access token for authorization: OAuth2
319
+ config.access_token = 'YOUR ACCESS TOKEN'
320
+ end
321
+
322
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
323
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
324
+ opts = {
325
+ payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | <p>(UUID) the id of the Payor.</p> <p>If specified the payment channels are filtered to those mapped to this payor.</p>
326
+ payable: true, # Boolean | payable if true only return the payment channel if the payee is payable
327
+ sensitive: true, # Boolean | <p>Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked.</p> <p>If set to true, and you have permission, the PII values will be returned as their original unmasked values.</p>
328
+ ignore_payor_invite_status: true # Boolean | payable if true only return the payment channel if the payee is payable
329
+ }
330
+
331
+ begin
332
+ # Get All Payment Channels Details
333
+ result = api_instance.get_payment_channels_v4(payee_id, opts)
334
+ p result
335
+ rescue VeloPayments::ApiError => e
336
+ puts "Error when calling PayeePaymentChannelsApi->get_payment_channels_v4: #{e}"
337
+ end
338
+ ```
339
+
340
+ #### Using the get_payment_channels_v4_with_http_info variant
341
+
342
+ This returns an Array which contains the response data, status code and headers.
343
+
344
+ > <Array(<PaymentChannelsResponseV4>, Integer, Hash)> get_payment_channels_v4_with_http_info(payee_id, opts)
345
+
346
+ ```ruby
347
+ begin
348
+ # Get All Payment Channels Details
349
+ data, status_code, headers = api_instance.get_payment_channels_v4_with_http_info(payee_id, opts)
350
+ p status_code # => 2xx
351
+ p headers # => { ... }
352
+ p data # => <PaymentChannelsResponseV4>
353
+ rescue VeloPayments::ApiError => e
354
+ puts "Error when calling PayeePaymentChannelsApi->get_payment_channels_v4_with_http_info: #{e}"
355
+ end
356
+ ```
357
+
358
+ ### Parameters
359
+
360
+ | Name | Type | Description | Notes |
361
+ | ---- | ---- | ----------- | ----- |
362
+ | **payee_id** | **String** | The UUID of the payee. | |
363
+ | **payor_id** | **String** | &lt;p&gt;(UUID) the id of the Payor.&lt;/p&gt; &lt;p&gt;If specified the payment channels are filtered to those mapped to this payor.&lt;/p&gt; | [optional] |
364
+ | **payable** | **Boolean** | payable if true only return the payment channel if the payee is payable | [optional] |
365
+ | **sensitive** | **Boolean** | &lt;p&gt;Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked.&lt;/p&gt; &lt;p&gt;If set to true, and you have permission, the PII values will be returned as their original unmasked values.&lt;/p&gt; | [optional] |
366
+ | **ignore_payor_invite_status** | **Boolean** | payable if true only return the payment channel if the payee is payable | [optional] |
367
+
368
+ ### Return type
369
+
370
+ [**PaymentChannelsResponseV4**](PaymentChannelsResponseV4.md)
371
+
372
+ ### Authorization
373
+
374
+ [OAuth2](../README.md#OAuth2)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: Not defined
379
+ - **Accept**: application/json
380
+
381
+
382
+ ## update_payment_channel_order_v4
383
+
384
+ > update_payment_channel_order_v4(payee_id, payment_channel_order_request_v4)
385
+
386
+ Update Payees preferred Payment Channel order
387
+
388
+ <p>Update the Payee's preferred order of payment channels by passing in just the payment channel ids. When payments are made to the payee then in the absence of any other rules (e.g. matching on currency) the first payment channel in this list will be chosen. </p>
389
+
390
+ ### Examples
391
+
392
+ ```ruby
393
+ require 'time'
394
+ require 'velopayments'
395
+ # setup authorization
396
+ VeloPayments.configure do |config|
397
+ # Configure OAuth2 access token for authorization: OAuth2
398
+ config.access_token = 'YOUR ACCESS TOKEN'
399
+ end
400
+
401
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
402
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
403
+ payment_channel_order_request_v4 = VeloPayments::PaymentChannelOrderRequestV4.new({payment_channel_ids: ['70faaff7-2c32-4b44-b27f-f0b6c484e6f3']}) # PaymentChannelOrderRequestV4 | Put the payment channel ids in the preferred order
404
+
405
+ begin
406
+ # Update Payees preferred Payment Channel order
407
+ api_instance.update_payment_channel_order_v4(payee_id, payment_channel_order_request_v4)
408
+ rescue VeloPayments::ApiError => e
409
+ puts "Error when calling PayeePaymentChannelsApi->update_payment_channel_order_v4: #{e}"
410
+ end
411
+ ```
412
+
413
+ #### Using the update_payment_channel_order_v4_with_http_info variant
414
+
415
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
416
+
417
+ > <Array(nil, Integer, Hash)> update_payment_channel_order_v4_with_http_info(payee_id, payment_channel_order_request_v4)
418
+
419
+ ```ruby
420
+ begin
421
+ # Update Payees preferred Payment Channel order
422
+ data, status_code, headers = api_instance.update_payment_channel_order_v4_with_http_info(payee_id, payment_channel_order_request_v4)
423
+ p status_code # => 2xx
424
+ p headers # => { ... }
425
+ p data # => nil
426
+ rescue VeloPayments::ApiError => e
427
+ puts "Error when calling PayeePaymentChannelsApi->update_payment_channel_order_v4_with_http_info: #{e}"
428
+ end
429
+ ```
430
+
431
+ ### Parameters
432
+
433
+ | Name | Type | Description | Notes |
434
+ | ---- | ---- | ----------- | ----- |
435
+ | **payee_id** | **String** | The UUID of the payee. | |
436
+ | **payment_channel_order_request_v4** | [**PaymentChannelOrderRequestV4**](PaymentChannelOrderRequestV4.md) | Put the payment channel ids in the preferred order | |
437
+
438
+ ### Return type
439
+
440
+ nil (empty response body)
441
+
442
+ ### Authorization
443
+
444
+ [OAuth2](../README.md#OAuth2)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: application/json
449
+ - **Accept**: application/json
450
+
451
+
452
+ ## update_payment_channel_v4
453
+
454
+ > update_payment_channel_v4(payee_id, payment_channel_id, update_payment_channel_request_v4)
455
+
456
+ Update Payment Channel
457
+
458
+ <p>Update the details of the payment channel. Note payment channels are immutable. The current payment channel will be logically deleted as part of this call and replaced with new one with the correct details; this endpoint will return a Location header with a link to the new payment channel upon success. Updating a currently disabled payment channel will result in a new, fully enabled, payment channel.</p>
459
+
460
+ ### Examples
461
+
462
+ ```ruby
463
+ require 'time'
464
+ require 'velopayments'
465
+ # setup authorization
466
+ VeloPayments.configure do |config|
467
+ # Configure OAuth2 access token for authorization: OAuth2
468
+ config.access_token = 'YOUR ACCESS TOKEN'
469
+ end
470
+
471
+ api_instance = VeloPayments::PayeePaymentChannelsApi.new
472
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
473
+ payment_channel_id = '70faaff7-2c32-4b44-b27f-f0b6c484e6f3' # String | The UUID of the payment channel.
474
+ update_payment_channel_request_v4 = VeloPayments::UpdatePaymentChannelRequestV4.new # UpdatePaymentChannelRequestV4 | Post payment channel to update
475
+
476
+ begin
477
+ # Update Payment Channel
478
+ api_instance.update_payment_channel_v4(payee_id, payment_channel_id, update_payment_channel_request_v4)
479
+ rescue VeloPayments::ApiError => e
480
+ puts "Error when calling PayeePaymentChannelsApi->update_payment_channel_v4: #{e}"
481
+ end
482
+ ```
483
+
484
+ #### Using the update_payment_channel_v4_with_http_info variant
485
+
486
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
487
+
488
+ > <Array(nil, Integer, Hash)> update_payment_channel_v4_with_http_info(payee_id, payment_channel_id, update_payment_channel_request_v4)
489
+
490
+ ```ruby
491
+ begin
492
+ # Update Payment Channel
493
+ data, status_code, headers = api_instance.update_payment_channel_v4_with_http_info(payee_id, payment_channel_id, update_payment_channel_request_v4)
494
+ p status_code # => 2xx
495
+ p headers # => { ... }
496
+ p data # => nil
497
+ rescue VeloPayments::ApiError => e
498
+ puts "Error when calling PayeePaymentChannelsApi->update_payment_channel_v4_with_http_info: #{e}"
499
+ end
500
+ ```
501
+
502
+ ### Parameters
503
+
504
+ | Name | Type | Description | Notes |
505
+ | ---- | ---- | ----------- | ----- |
506
+ | **payee_id** | **String** | The UUID of the payee. | |
507
+ | **payment_channel_id** | **String** | The UUID of the payment channel. | |
508
+ | **update_payment_channel_request_v4** | [**UpdatePaymentChannelRequestV4**](UpdatePaymentChannelRequestV4.md) | Post payment channel to update | |
509
+
510
+ ### Return type
511
+
512
+ nil (empty response body)
513
+
514
+ ### Authorization
515
+
516
+ [OAuth2](../README.md#OAuth2)
517
+
518
+ ### HTTP request headers
519
+
520
+ - **Content-Type**: application/json
521
+ - **Accept**: application/json
522
+
data/docs/PayeesApi.md CHANGED
@@ -83,7 +83,7 @@ nil (empty response body)
83
83
  ### HTTP request headers
84
84
 
85
85
  - **Content-Type**: Not defined
86
- - **Accept**: Not defined
86
+ - **Accept**: application/json
87
87
 
88
88
 
89
89
  ## delete_payee_by_id_v4
@@ -151,7 +151,7 @@ nil (empty response body)
151
151
  ### HTTP request headers
152
152
 
153
153
  - **Content-Type**: Not defined
154
- - **Accept**: Not defined
154
+ - **Accept**: application/json
155
155
 
156
156
 
157
157
  ## get_payee_by_id_v3
@@ -88,7 +88,7 @@ end
88
88
  ### HTTP request headers
89
89
 
90
90
  - **Content-Type**: Not defined
91
- - **Accept**: application/csv
91
+ - **Accept**: application/csv, application/json
92
92
 
93
93
 
94
94
  ## get_fundings_v4
@@ -623,11 +623,14 @@ opts = {
623
623
  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
624
624
  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
625
625
  payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
626
+ payor_payment_id: 'payor_payment_id_example', # String | Payor's Id of the Payment
626
627
  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
628
  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
629
  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
630
  schedule_status: 'ANY', # String | Payout Schedule Status
630
631
  post_instruct_fx_status: 'ANY', # String | The status of the post instruct FX step if one was required for the payment
632
+ transaction_reference: 'transaction_reference_example', # String | Query for all payments associated with a specific transaction reference
633
+ transaction_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Query for all payments associated with a specific transaction id
631
634
  page: 56, # Integer | Page number. Default is 1.
632
635
  page_size: 56, # Integer | The number of results to return in a page
633
636
  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
@@ -682,11 +685,14 @@ end
682
685
  | **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
683
686
  | **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
684
687
  | **payment_memo** | **String** | The payment memo filter. This filters via a case insensitive substring match. | [optional] |
688
+ | **payor_payment_id** | **String** | Payor&#39;s Id of the Payment | [optional] |
685
689
  | **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
690
  | **scheduled_for_date_from** | **Date** | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. | [optional] |
687
691
  | **scheduled_for_date_to** | **Date** | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. | [optional] |
688
692
  | **schedule_status** | **String** | Payout Schedule Status | [optional] |
689
693
  | **post_instruct_fx_status** | **String** | The status of the post instruct FX step if one was required for the payment | [optional] |
694
+ | **transaction_reference** | **String** | Query for all payments associated with a specific transaction reference | [optional] |
695
+ | **transaction_id** | **String** | Query for all payments associated with a specific transaction id | [optional] |
690
696
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
691
697
  | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
692
698
  | **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] |
@@ -0,0 +1,18 @@
1
+ # VeloPayments::PaymentChannelOrderRequestV4
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payment_channel_ids** | **Array&lt;String&gt;** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'velopayments'
13
+
14
+ instance = VeloPayments::PaymentChannelOrderRequestV4.new(
15
+ payment_channel_ids: null
16
+ )
17
+ ```
18
+