velopayments 2.18.113 → 2.23.78.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.
- checksums.yaml +4 -4
- data/Dockerfile +7 -0
- data/Gemfile +1 -1
- data/Makefile +8 -12
- data/README.md +161 -74
- data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +3 -3
- data/docs/AutoTopUpConfig2.md +23 -0
- data/docs/Challenge.md +2 -2
- data/docs/Challenge2.md +19 -0
- data/docs/Company.md +21 -0
- data/docs/Company2.md +21 -0
- data/docs/CompanyResponse.md +2 -2
- data/docs/CompanyV1.md +3 -3
- data/docs/CountriesApi.md +21 -31
- data/docs/CreateFundingAccountRequestV2.md +29 -0
- data/docs/CreateIndividual.md +2 -2
- data/docs/CreateIndividual2.md +3 -3
- data/docs/CreateIndividual2Name.md +23 -0
- data/docs/CreatePayee.md +4 -4
- data/docs/CreatePayee2.md +7 -7
- data/docs/CreatePayeesCSVRequest.md +22 -22
- data/docs/CreatePayeesCSVRequest2.md +23 -23
- data/docs/CreatePayeesCSVResponse.md +2 -2
- data/docs/CreatePayeesCSVResponse2.md +2 -2
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
- data/docs/CreatePayeesRequest.md +1 -1
- data/docs/CreatePayeesRequest2.md +1 -1
- data/docs/CreatePaymentChannel.md +6 -6
- data/docs/CreatePaymentChannel2.md +6 -6
- data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +6 -6
- data/docs/CreateWebhookRequest.md +23 -0
- data/docs/CurrenciesApi.md +7 -12
- data/docs/FailedSubmission.md +2 -2
- data/docs/FailedSubmission2.md +19 -0
- data/docs/FundingAccountResponse.md +15 -7
- data/docs/FundingAccountResponse2.md +35 -0
- data/docs/FundingAccountType.md +16 -0
- data/docs/FundingAudit.md +5 -5
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerApi.md +337 -36
- data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +9 -9
- data/docs/FundingPayorStatusAuditResponse.md +2 -2
- data/docs/FundingRequestV3.md +19 -0
- data/docs/FxSummaryV3.md +1 -1
- data/docs/FxSummaryV4.md +1 -1
- data/docs/GetFundingsResponse.md +2 -2
- data/docs/GetFundingsResponseLinks.md +19 -0
- data/docs/GetPayeeListResponse.md +49 -0
- data/docs/GetPayeeListResponseCompany.md +19 -0
- data/docs/GetPayeeListResponseIndividual.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
- data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
- data/docs/GetPayoutsResponseV4.md +1 -1
- data/docs/Individual.md +21 -0
- data/docs/Individual2.md +21 -0
- data/docs/IndividualV1.md +2 -2
- data/docs/IndividualV1Name.md +4 -4
- data/docs/InlineResponse400.md +19 -0
- data/docs/InlineResponse400Errors.md +23 -0
- data/docs/InlineResponse401.md +19 -0
- data/docs/InlineResponse401Errors.md +23 -0
- data/docs/InlineResponse403.md +19 -0
- data/docs/InlineResponse403Errors.md +23 -0
- data/docs/InlineResponse404.md +19 -0
- data/docs/InlineResponse404Errors.md +23 -0
- data/docs/InlineResponse409.md +19 -0
- data/docs/InlineResponse409Errors.md +23 -0
- data/docs/InlineResponse412.md +19 -0
- data/docs/InlineResponse412Errors.md +23 -0
- data/docs/InvitationStatus2.md +16 -0
- data/docs/InvitePayeeRequest.md +1 -1
- data/docs/InvitePayeeRequest2.md +17 -0
- data/docs/InviteUserRequest.md +2 -2
- data/docs/{TokenType.md → Language2.md} +2 -2
- data/docs/ListFundingAccountsResponse2.md +21 -0
- data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
- data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
- data/docs/ListPaymentsResponseV4.md +1 -1
- data/docs/ListSourceAccountResponseV2.md +1 -1
- data/docs/ListSourceAccountResponseV2Links.md +19 -0
- data/docs/ListSourceAccountResponseV3.md +21 -0
- data/docs/ListSourceAccountResponseV3Links.md +19 -0
- data/docs/{PaymentStatus.md → LocationType.md} +2 -2
- data/docs/LoginApi.md +6 -2
- data/docs/MarketingOptIn.md +2 -2
- data/docs/Name.md +23 -0
- data/docs/Notifications2.md +17 -0
- data/docs/{MFAStatus.md → OfacStatus2.md} +2 -2
- data/docs/OnboardedStatus2.md +16 -0
- data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
- data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
- data/docs/{PagedResponsePage.md → PagedPayeeInvitationStatusResponsePage.md} +2 -2
- data/docs/PagedPayeeResponse2.md +1 -1
- data/docs/PagedPayeeResponse2Summary.md +5 -5
- data/docs/PagedPayeeResponsePage.md +5 -5
- data/docs/PagedPayeeResponseSummary.md +5 -5
- data/docs/PagedPaymentsResponseV3.md +21 -0
- data/docs/Payee.md +11 -11
- data/docs/{PayeeResponse2.md → Payee2.md} +22 -20
- data/docs/PayeeAddress2.md +31 -0
- data/docs/PayeeDelta.md +1 -1
- data/docs/PayeeDelta2.md +29 -0
- data/docs/PayeeDeltaResponse2.md +21 -0
- data/docs/PayeeDeltaResponse2Links.md +19 -0
- data/docs/PayeeDetailResponse.md +73 -0
- data/docs/PayeeDetailResponse2.md +73 -0
- data/docs/PayeeInvitationApi.md +405 -60
- data/docs/PayeeInvitationStatus.md +1 -1
- data/docs/PayeeInvitationStatusResponse.md +3 -3
- data/docs/PayeeInvitationStatusResponse2.md +21 -0
- data/docs/PayeePaymentChannel.md +8 -8
- data/docs/PayeePaymentChannel2.md +29 -0
- data/docs/PayeePayorRef.md +1 -1
- data/docs/PayeePayorRef2.md +6 -2
- data/docs/PayeePayorRefV2.md +25 -0
- data/docs/PayeePayorRefV3.md +25 -0
- data/docs/PayeeResponse.md +11 -11
- data/docs/PayeeResponseV2.md +73 -0
- data/docs/{OTPType.md → PayeeType2.md} +2 -2
- data/docs/PayeeUserSelfUpdateRequest.md +27 -0
- data/docs/PayeesApi.md +753 -59
- data/docs/PaymentAuditServiceApi.md +271 -39
- data/docs/PaymentChannelCountry.md +3 -3
- data/docs/PaymentChannelRule.md +11 -11
- data/docs/PaymentDelta.md +1 -1
- data/docs/PaymentDeltaResponse.md +1 -1
- data/docs/PaymentDeltaResponseV4.md +21 -0
- data/docs/PaymentDeltaV4.md +31 -0
- data/docs/PaymentEventResponseV3.md +1 -1
- data/docs/PaymentEventResponseV4.md +1 -1
- data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +7 -5
- data/docs/PaymentResponseV3.md +1 -1
- data/docs/PaymentResponseV4.md +7 -1
- data/docs/PaymentV3.md +37 -0
- data/docs/PayorV1.md +3 -1
- data/docs/PayorV2.md +5 -1
- data/docs/PayorsApi.md +14 -14
- data/docs/{CurrencyType.md → PayoutCompanyV3.md} +3 -3
- data/docs/{GenerateOTPRequest.md → PayoutIndividualV3.md} +3 -3
- data/docs/PayoutNameV3.md +19 -0
- data/docs/PayoutPayeeV3.md +21 -0
- data/docs/PayoutServiceApi.md +393 -0
- data/docs/PayoutSummaryAuditV4.md +4 -2
- data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
- data/docs/PingResponse.md +19 -0
- data/docs/QueryBatchResponse2.md +23 -0
- data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +6 -6
- data/docs/QuoteResponseV3.md +17 -0
- data/docs/{Region.md → RegionV2.md} +2 -2
- data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +3 -3
- data/docs/ResendTokenRequest.md +1 -1
- data/docs/RoleUpdateRequest.md +19 -0
- data/docs/SourceAccountResponse.md +3 -1
- data/docs/SourceAccountResponseV2.md +4 -2
- data/docs/SourceAccountResponseV3.md +47 -0
- data/docs/SourceAccountType.md +16 -0
- data/docs/{SourceAccount.md → SourceAccountV3.md} +3 -3
- data/docs/{SupportedCountriesResponse2.md → SupportedCountriesResponseV2.md} +2 -2
- data/docs/SupportedCountry.md +2 -2
- data/docs/SupportedCountryV2.md +3 -3
- data/docs/SupportedCurrencyResponseV2.md +17 -0
- data/docs/SupportedCurrencyV2.md +19 -0
- data/docs/TokensApi.md +0 -498
- data/docs/TransferRequest2.md +21 -0
- data/docs/TransmissionType.md +16 -0
- data/docs/TransmissionTypes.md +21 -0
- data/docs/TransmissionTypes2.md +21 -0
- data/docs/UnregisterMFARequest.md +1 -1
- data/docs/UpdatePayeeDetailsRequest.md +29 -0
- data/docs/UpdatePayeeDetailsRequest2.md +29 -0
- data/docs/UpdateRemoteIdRequest.md +2 -2
- data/docs/UpdateWebhookRequest.md +21 -0
- data/docs/UserDetailsUpdateRequest.md +31 -0
- data/docs/UserResponse.md +1 -1
- data/docs/UsersApi.md +170 -60
- data/docs/WatchlistStatus2.md +16 -0
- data/docs/WebhookResponse.md +25 -0
- data/docs/WebhooksApi.md +280 -0
- data/docs/WebhooksResponse.md +21 -0
- data/docs/WithdrawPaymentRequest.md +17 -0
- data/lib/velopayments.rb +102 -42
- data/lib/velopayments/api/countries_api.rb +40 -37
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +536 -78
- data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +15 -14
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +531 -116
- data/lib/velopayments/api/payees_api.rb +945 -73
- data/lib/velopayments/api/payment_audit_service_api.rb +448 -82
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +506 -0
- data/lib/velopayments/api/tokens_api.rb +6 -698
- data/lib/velopayments/api/users_api.rb +280 -118
- data/lib/velopayments/api/webhooks_api.rb +350 -0
- data/lib/velopayments/api_client.rb +47 -44
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +35 -8
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +36 -10
- data/lib/velopayments/models/access_token_response.rb +21 -7
- data/lib/velopayments/models/access_token_validation_request.rb +21 -7
- data/lib/velopayments/models/auth_response.rb +21 -7
- data/lib/velopayments/models/auto_top_up_config.rb +23 -7
- data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
- data/lib/velopayments/models/challenge.rb +21 -7
- data/lib/velopayments/models/challenge2.rb +285 -0
- data/lib/velopayments/models/company.rb +312 -0
- data/lib/velopayments/models/company2.rb +312 -0
- data/lib/velopayments/models/company_response.rb +22 -7
- data/lib/velopayments/models/company_v1.rb +28 -12
- data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
- data/lib/velopayments/models/create_individual.rb +21 -7
- data/lib/velopayments/models/create_individual2.rb +22 -8
- data/lib/velopayments/models/create_individual2_name.rb +351 -0
- data/lib/velopayments/models/create_payee.rb +24 -8
- data/lib/velopayments/models/create_payee2.rb +27 -11
- data/lib/velopayments/models/create_payee_address.rb +26 -7
- data/lib/velopayments/models/create_payee_address2.rb +26 -7
- data/lib/velopayments/models/create_payees_csv_request.rb +21 -7
- data/lib/velopayments/models/create_payees_csv_request2.rb +35 -15
- data/lib/velopayments/models/create_payees_csv_response.rb +22 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +22 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +228 -0
- data/lib/velopayments/models/create_payees_request.rb +21 -7
- data/lib/velopayments/models/create_payees_request2.rb +21 -7
- data/lib/velopayments/models/create_payment_channel.rb +21 -7
- data/lib/velopayments/models/create_payment_channel2.rb +21 -7
- data/lib/velopayments/models/create_payor_link_request.rb +21 -7
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +40 -11
- data/lib/velopayments/models/create_webhook_request.rb +315 -0
- data/lib/velopayments/models/error.rb +23 -9
- data/lib/velopayments/models/error_response.rb +23 -7
- data/lib/velopayments/models/failed_submission.rb +22 -8
- data/lib/velopayments/models/failed_submission2.rb +219 -0
- data/lib/velopayments/models/funding_account_response.rb +116 -11
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +117 -96
- data/lib/velopayments/models/{token_type.rb → funding_account_type.rb} +8 -9
- data/lib/velopayments/models/funding_audit.rb +34 -18
- data/lib/velopayments/models/funding_event.rb +22 -8
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +58 -8
- data/lib/velopayments/models/funding_request_v1.rb +21 -7
- data/lib/velopayments/models/funding_request_v2.rb +21 -7
- data/lib/velopayments/models/funding_request_v3.rb +259 -0
- data/lib/velopayments/models/fx_summary_v3.rb +22 -8
- data/lib/velopayments/models/fx_summary_v4.rb +22 -8
- data/lib/velopayments/models/get_fundings_response.rb +22 -15
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +40 -19
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +100 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +25 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +21 -7
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +21 -7
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +24 -10
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +22 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +36 -12
- data/lib/velopayments/models/get_payout_statistics.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v4.rb +22 -8
- data/lib/velopayments/models/individual.rb +264 -0
- data/lib/velopayments/models/individual2.rb +264 -0
- data/lib/velopayments/models/individual_response.rb +21 -7
- data/lib/velopayments/models/individual_v1.rb +45 -7
- data/lib/velopayments/models/individual_v1_name.rb +21 -7
- data/lib/velopayments/models/inline_response400.rb +225 -0
- data/lib/velopayments/models/inline_response400_errors.rb +240 -0
- data/lib/velopayments/models/inline_response401.rb +225 -0
- data/lib/velopayments/models/inline_response401_errors.rb +240 -0
- data/lib/velopayments/models/inline_response403.rb +225 -0
- data/lib/velopayments/models/inline_response403_errors.rb +240 -0
- data/lib/velopayments/models/inline_response404.rb +225 -0
- data/lib/velopayments/models/inline_response404_errors.rb +240 -0
- data/lib/velopayments/models/inline_response409.rb +225 -0
- data/lib/velopayments/models/inline_response409_errors.rb +240 -0
- data/lib/velopayments/models/inline_response412.rb +225 -0
- data/lib/velopayments/models/inline_response412_errors.rb +240 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/{payment_status.rb → invitation_status2.rb} +8 -12
- data/lib/velopayments/models/invitation_status_response.rb +21 -7
- data/lib/velopayments/models/invite_payee_request.rb +21 -7
- data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +36 -28
- data/lib/velopayments/models/invite_user_request.rb +34 -17
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/language.rb +3 -2
- data/lib/velopayments/models/language2.rb +46 -0
- data/lib/velopayments/models/link_for_response.rb +21 -7
- data/lib/velopayments/models/list_funding_accounts_response.rb +21 -7
- data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +25 -11
- data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +24 -10
- data/lib/velopayments/models/list_payments_response_v4.rb +22 -8
- data/lib/velopayments/models/list_source_account_response.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_links.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_page.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_v2.rb +22 -8
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
- data/lib/velopayments/models/location_type.rb +40 -0
- data/lib/velopayments/models/marketing_opt_in.rb +22 -8
- data/lib/velopayments/models/mfa_details.rb +22 -7
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +333 -0
- data/lib/velopayments/models/notifications.rb +21 -7
- data/lib/velopayments/models/{paged_response.rb → notifications2.rb} +31 -28
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/{otp_type.rb → ofac_status2.rb} +9 -6
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +39 -0
- data/lib/velopayments/models/page_for_response.rb +21 -7
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +21 -7
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +22 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +233 -0
- data/lib/velopayments/models/{paged_response_page.rb → paged_payee_invitation_status_response_page.rb} +24 -10
- data/lib/velopayments/models/paged_payee_response.rb +21 -7
- data/lib/velopayments/models/paged_payee_response2.rb +22 -8
- data/lib/velopayments/models/paged_payee_response2_summary.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_links.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_page.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_summary.rb +21 -7
- data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
- data/lib/velopayments/models/paged_user_response.rb +21 -7
- data/lib/velopayments/models/paged_user_response_links.rb +21 -7
- data/lib/velopayments/models/paged_user_response_page.rb +21 -7
- data/lib/velopayments/models/password_request.rb +21 -7
- data/lib/velopayments/models/payee.rb +29 -9
- data/lib/velopayments/models/payee2.rb +460 -0
- data/lib/velopayments/models/payee_address.rb +26 -7
- data/lib/velopayments/models/payee_address2.rb +497 -0
- data/lib/velopayments/models/payee_delta.rb +22 -7
- data/lib/velopayments/models/payee_delta2.rb +303 -0
- data/lib/velopayments/models/payee_delta_response.rb +21 -7
- data/lib/velopayments/models/payee_delta_response2.rb +233 -0
- data/lib/velopayments/models/payee_delta_response2_links.rb +219 -0
- data/lib/velopayments/models/payee_delta_response_links.rb +21 -7
- data/lib/velopayments/models/payee_delta_response_page.rb +21 -7
- data/lib/velopayments/models/payee_detail_response.rb +475 -0
- data/lib/velopayments/models/payee_detail_response2.rb +475 -0
- data/lib/velopayments/models/payee_invitation_status.rb +21 -7
- data/lib/velopayments/models/payee_invitation_status_response.rb +56 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +272 -0
- data/lib/velopayments/models/payee_payment_channel.rb +68 -43
- data/lib/velopayments/models/payee_payment_channel2.rb +455 -0
- data/lib/velopayments/models/payee_payor_ref.rb +21 -7
- data/lib/velopayments/models/payee_payor_ref2.rb +45 -11
- data/lib/velopayments/models/payee_payor_ref_v2.rb +282 -0
- data/lib/velopayments/models/payee_payor_ref_v3.rb +248 -0
- data/lib/velopayments/models/payee_response.rb +29 -9
- data/lib/velopayments/models/payee_response_v2.rb +475 -0
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/{mfa_status.rb → payee_type2.rb} +8 -7
- data/lib/velopayments/models/payee_user_self_update_request.rb +365 -0
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +33 -7
- data/lib/velopayments/models/payment_channel_rule.rb +48 -7
- data/lib/velopayments/models/payment_channel_rules_response.rb +21 -7
- data/lib/velopayments/models/payment_delta.rb +28 -8
- data/lib/velopayments/models/payment_delta_response.rb +22 -8
- data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
- data/lib/velopayments/models/payment_delta_v4.rb +289 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +22 -8
- data/lib/velopayments/models/payment_event_response_v4.rb +22 -8
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +73 -53
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_response_v3.rb +22 -8
- data/lib/velopayments/models/payment_response_v4.rb +50 -9
- data/lib/velopayments/models/payment_response_v4_payout.rb +21 -7
- data/lib/velopayments/models/payment_v3.rb +363 -0
- data/lib/velopayments/models/payor_address.rb +26 -7
- data/lib/velopayments/models/payor_address_v2.rb +26 -7
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -7
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +21 -7
- data/lib/velopayments/models/payor_branding_response.rb +24 -7
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -7
- data/lib/velopayments/models/payor_create_api_key_response.rb +21 -7
- data/lib/velopayments/models/payor_create_application_request.rb +22 -7
- data/lib/velopayments/models/payor_email_opt_out_request.rb +21 -7
- data/lib/velopayments/models/payor_links_response.rb +21 -7
- data/lib/velopayments/models/payor_links_response_links.rb +21 -7
- data/lib/velopayments/models/payor_links_response_payors.rb +21 -7
- data/lib/velopayments/models/payor_logo_request.rb +21 -7
- data/lib/velopayments/models/payor_v1.rb +34 -11
- data/lib/velopayments/models/payor_v2.rb +44 -11
- data/lib/velopayments/models/payout_company_v3.rb +215 -0
- data/lib/velopayments/models/{generate_otp_request.rb → payout_individual_v3.rb} +34 -20
- data/lib/velopayments/models/payout_name_v3.rb +229 -0
- data/lib/velopayments/models/{validate_otp_request.rb → payout_payee_v3.rb} +53 -49
- data/lib/velopayments/models/payout_payor_v4.rb +21 -7
- data/lib/velopayments/models/payout_principal_v4.rb +21 -7
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/payout_status_v4.rb +3 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +21 -7
- data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -10
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +43 -15
- data/lib/velopayments/models/payout_type_v4.rb +3 -2
- data/lib/velopayments/models/{supported_currency.rb → ping_response.rb} +37 -24
- data/lib/velopayments/models/query_batch_response.rb +21 -7
- data/lib/velopayments/models/query_batch_response2.rb +274 -0
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +50 -12
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +25 -11
- data/lib/velopayments/models/{region.rb → region_v2.rb} +24 -10
- data/lib/velopayments/models/register_sms_request.rb +24 -10
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +36 -10
- data/lib/velopayments/models/resend_token_request.rb +23 -8
- data/lib/velopayments/models/reset_password_request.rb +21 -7
- data/lib/velopayments/models/role.rb +21 -7
- data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +39 -22
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +21 -7
- data/lib/velopayments/models/self_update_password_request.rb +21 -7
- data/lib/velopayments/models/set_notifications_request.rb +21 -7
- data/lib/velopayments/models/source_account_response.rb +36 -11
- data/lib/velopayments/models/source_account_response_v2.rb +39 -14
- data/lib/velopayments/models/source_account_response_v3.rb +437 -0
- data/lib/velopayments/models/source_account_summary_v3.rb +21 -7
- data/lib/velopayments/models/source_account_summary_v4.rb +21 -7
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +64 -10
- data/lib/velopayments/models/supported_countries_response.rb +21 -7
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -10
- data/lib/velopayments/models/supported_country.rb +52 -36
- data/lib/velopayments/models/supported_country_v2.rb +56 -38
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +25 -11
- data/lib/velopayments/models/supported_currency_v2.rb +256 -0
- data/lib/velopayments/models/transfer_request.rb +21 -7
- data/lib/velopayments/models/transfer_request2.rb +301 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/transmission_types.rb +246 -0
- data/lib/velopayments/models/{validate_mfa_request.rb → transmission_types2.rb} +61 -45
- data/lib/velopayments/models/unregister_mfa_request.rb +25 -10
- data/lib/velopayments/models/update_payee_details_request.rb +266 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
- data/lib/velopayments/models/update_remote_id_request.rb +21 -7
- data/lib/velopayments/models/update_webhook_request.rb +288 -0
- data/lib/velopayments/models/{user_response2.rb → user_details_update_request.rb} +97 -181
- data/lib/velopayments/models/user_info.rb +21 -7
- data/lib/velopayments/models/user_response.rb +32 -17
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +21 -7
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/watchlist_status2.rb +40 -0
- data/lib/velopayments/models/{currency_type.rb → webhook_response.rb} +66 -49
- data/lib/velopayments/models/webhooks_response.rb +233 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +244 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +13 -13
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +97 -20
- data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +11 -11
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +113 -31
- data/spec/api/payees_api_spec.rb +186 -16
- data/spec/api/payment_audit_service_api_spec.rb +74 -20
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +127 -0
- data/spec/api/tokens_api_spec.rb +2 -131
- data/spec/api/users_api_spec.rb +43 -17
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
- data/spec/models/access_token_response_spec.rb +2 -2
- data/spec/models/access_token_validation_request_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +2 -2
- data/spec/models/auto_top_up_config2_spec.rb +59 -0
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company2_spec.rb +53 -0
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +53 -0
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
- data/spec/models/create_individual2_name_spec.rb +59 -0
- data/spec/models/create_individual2_spec.rb +2 -2
- data/spec/models/create_individual_spec.rb +2 -2
- data/spec/models/create_payee2_spec.rb +2 -2
- data/spec/models/create_payee_address2_spec.rb +2 -2
- data/spec/models/create_payee_address_spec.rb +2 -2
- data/spec/models/create_payee_spec.rb +2 -2
- data/spec/models/create_payees_csv_request2_spec.rb +2 -2
- data/spec/models/create_payees_csv_request_spec.rb +2 -2
- data/spec/models/create_payees_csv_response2_spec.rb +2 -2
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +53 -0
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payor_link_request_spec.rb +2 -2
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
- data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/failed_submission2_spec.rb +47 -0
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response2_spec.rb +95 -0
- data/spec/models/funding_account_response_spec.rb +26 -2
- data/spec/models/funding_account_type_spec.rb +35 -0
- data/spec/models/funding_audit_spec.rb +8 -8
- data/spec/models/funding_event_spec.rb +2 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/funding_request_v3_spec.rb +47 -0
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/{register_mfa_response_spec.rb → get_fundings_response_links_spec.rb} +10 -10
- data/spec/models/get_fundings_response_spec.rb +2 -2
- data/spec/models/get_payee_list_response_company_spec.rb +47 -0
- data/spec/models/{get_fundings_response_all_of_spec.rb → get_payee_list_response_individual_spec.rb} +9 -9
- data/spec/models/get_payee_list_response_spec.rb +137 -0
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual2_spec.rb +53 -0
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +53 -0
- data/spec/models/individual_v1_name_spec.rb +2 -2
- data/spec/models/individual_v1_spec.rb +2 -2
- data/spec/models/inline_response400_errors_spec.rb +59 -0
- data/spec/models/inline_response400_spec.rb +47 -0
- data/spec/models/inline_response401_errors_spec.rb +59 -0
- data/spec/models/inline_response401_spec.rb +47 -0
- data/spec/models/inline_response403_errors_spec.rb +59 -0
- data/spec/models/inline_response403_spec.rb +47 -0
- data/spec/models/inline_response404_errors_spec.rb +59 -0
- data/spec/models/inline_response404_spec.rb +47 -0
- data/spec/models/inline_response409_errors_spec.rb +59 -0
- data/spec/models/inline_response409_spec.rb +47 -0
- data/spec/models/inline_response412_errors_spec.rb +59 -0
- data/spec/models/inline_response412_spec.rb +47 -0
- data/spec/models/invitation_status2_spec.rb +35 -0
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/{generate_otp_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/invite_user_request_spec.rb +2 -2
- data/spec/models/kyc_state_spec.rb +2 -2
- data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/link_for_response_spec.rb +2 -2
- data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
- data/spec/models/list_funding_accounts_response_spec.rb +2 -2
- data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
- data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
- data/spec/models/list_payments_response_v4_spec.rb +2 -2
- data/spec/models/list_source_account_response_links_spec.rb +2 -2
- data/spec/models/list_source_account_response_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v3_spec.rb +53 -0
- data/spec/models/{payment_status_spec.rb → location_type_spec.rb} +8 -8
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/mfa_details_spec.rb +2 -2
- data/spec/models/mfa_type_spec.rb +2 -2
- data/spec/models/name_spec.rb +59 -0
- data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status2_spec.rb +35 -0
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/page_for_response_spec.rb +2 -2
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
- data/spec/models/{paged_response_page_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +8 -8
- data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/paged_payee_response2_spec.rb +2 -2
- data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
- data/spec/models/paged_payee_response_links_spec.rb +2 -2
- data/spec/models/paged_payee_response_page_spec.rb +2 -2
- data/spec/models/paged_payee_response_spec.rb +2 -2
- data/spec/models/paged_payee_response_summary_spec.rb +2 -2
- data/spec/models/paged_payments_response_v3_spec.rb +53 -0
- data/spec/models/paged_user_response_links_spec.rb +2 -2
- data/spec/models/paged_user_response_page_spec.rb +2 -2
- data/spec/models/paged_user_response_spec.rb +2 -2
- data/spec/models/password_request_spec.rb +2 -2
- data/spec/models/{payee_response2_spec.rb → payee2_spec.rb} +20 -10
- data/spec/models/payee_address2_spec.rb +83 -0
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +77 -0
- data/spec/models/payee_delta_response2_links_spec.rb +47 -0
- data/spec/models/payee_delta_response2_spec.rb +53 -0
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_detail_response2_spec.rb +209 -0
- data/spec/models/payee_detail_response_spec.rb +209 -0
- data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
- data/spec/models/payee_invitation_status_response_spec.rb +6 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +81 -0
- data/spec/models/payee_payment_channel_spec.rb +3 -3
- data/spec/models/payee_payor_ref2_spec.rb +14 -2
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
- data/spec/models/payee_payor_ref_v3_spec.rb +65 -0
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +209 -0
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/{token_type_spec.rb → payee_type2_spec.rb} +8 -8
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payee_user_self_update_request_spec.rb +71 -0
- data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
- data/spec/models/payment_channel_country_spec.rb +2 -2
- data/spec/models/payment_channel_rule_spec.rb +2 -2
- data/spec/models/payment_channel_rules_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_v4_spec.rb +53 -0
- data/spec/models/payment_delta_spec.rb +2 -2
- data/spec/models/payment_delta_v4_spec.rb +83 -0
- data/spec/models/payment_event_response_v3_spec.rb +2 -2
- data/spec/models/payment_event_response_v4_spec.rb +2 -2
- data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -12
- data/spec/models/payment_rails_spec.rb +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +2 -2
- data/spec/models/payment_response_v4_spec.rb +20 -2
- data/spec/models/payment_v3_spec.rb +105 -0
- data/spec/models/payor_address_spec.rb +2 -2
- data/spec/models/payor_address_v2_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +8 -2
- data/spec/models/payor_v2_spec.rb +14 -2
- data/spec/models/{validate_mfa_request_spec.rb → payout_company_v3_spec.rb} +9 -9
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
- data/spec/models/payout_name_v3_spec.rb +47 -0
- data/spec/models/payout_payee_v3_spec.rb +53 -0
- data/spec/models/payout_payor_v4_spec.rb +2 -2
- data/spec/models/payout_principal_v4_spec.rb +2 -2
- data/spec/models/payout_status_v3_spec.rb +2 -2
- data/spec/models/payout_status_v4_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/ping_response_spec.rb +47 -0
- data/spec/models/query_batch_response2_spec.rb +63 -0
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
- data/spec/models/register_sms_request_spec.rb +2 -2
- data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
- data/spec/models/resend_token_request_spec.rb +2 -2
- data/spec/models/reset_password_request_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
- data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
- data/spec/models/self_update_password_request_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +8 -2
- data/spec/models/source_account_response_v2_spec.rb +8 -2
- data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
- data/spec/models/source_account_summary_v3_spec.rb +2 -2
- data/spec/models/source_account_summary_v4_spec.rb +2 -2
- data/spec/models/source_account_type_spec.rb +35 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
- data/spec/models/supported_country_spec.rb +2 -10
- data/spec/models/supported_country_v2_spec.rb +2 -10
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
- data/spec/models/transfer_request2_spec.rb +53 -0
- data/spec/models/transfer_request_spec.rb +2 -2
- data/spec/models/transmission_type_spec.rb +35 -0
- data/spec/models/transmission_types2_spec.rb +53 -0
- data/spec/models/transmission_types_spec.rb +53 -0
- data/spec/models/unregister_mfa_request_spec.rb +3 -3
- data/spec/models/update_payee_details_request2_spec.rb +77 -0
- data/spec/models/update_payee_details_request_spec.rb +77 -0
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/update_webhook_request_spec.rb +53 -0
- data/spec/models/user_details_update_request_spec.rb +83 -0
- data/spec/models/user_info_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_status_spec.rb +2 -2
- data/spec/models/user_type2_spec.rb +2 -2
- data/spec/models/user_type_spec.rb +2 -2
- data/spec/models/validate_password_response_spec.rb +2 -2
- data/spec/models/watchlist_status2_spec.rb +35 -0
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/models/{check_token_response_spec.rb → webhook_response_spec.rb} +13 -13
- data/spec/models/webhooks_response_spec.rb +53 -0
- data/spec/models/{register_mfa_request_spec.rb → withdraw_payment_request_spec.rb} +9 -9
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +103 -0
- data/{spec/api/get_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
- data/specs/api/funding_manager_api_spec.rb +372 -0
- data/{spec/api/withdraw_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +14 -14
- data/specs/api/login_api_spec.rb +82 -0
- data/specs/api/payee_invitation_api_spec.rb +203 -0
- data/specs/api/payees_api_spec.rb +285 -0
- data/specs/api/payment_audit_service_api_spec.rb +468 -0
- data/specs/api/payors_api_spec.rb +171 -0
- data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/{spec/api/quote_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +16 -15
- data/specs/api/users_api_spec.rb +284 -0
- data/velopayments.gemspec +3 -4
- metadata +556 -322
- data/docs/CheckTokenResponse.md +0 -25
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/EmailUpdateRequest.md +0 -19
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/PagedResponse.md +0 -19
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/RegisterMFARequest.md +0 -17
- data/docs/RegisterMFAResponse.md +0 -19
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/ValidateMFARequest.md +0 -17
- data/docs/ValidateOTPRequest.md +0 -17
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -82
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -84
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -82
- data/lib/velopayments/models/check_token_response.rb +0 -234
- data/lib/velopayments/models/register_mfa_request.rb +0 -201
- data/spec/api/payout_history_api_spec.rb +0 -95
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/models/validate_otp_request_spec.rb +0 -41
data/docs/CheckTokenResponse.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# VeloPayments::CheckTokenResponse
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**expiry_date** | **DateTime** | the timestamp when the token will expire | [optional]
|
|
8
|
-
**mfa_type** | [**MFAType**](MFAType.md) | | [optional]
|
|
9
|
-
**token_type** | [**TokenType**](TokenType.md) | | [optional]
|
|
10
|
-
**mfa_verified** | **Boolean** | has the user verified their MFA device by logging in | [optional]
|
|
11
|
-
**mfa_status** | [**MFAStatus**](MFAStatus.md) | | [optional]
|
|
12
|
-
|
|
13
|
-
## Code Sample
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'VeloPayments'
|
|
17
|
-
|
|
18
|
-
instance = VeloPayments::CheckTokenResponse.new(expiry_date: 2019-10-25T14:08:25.701Z,
|
|
19
|
-
mfa_type: null,
|
|
20
|
-
token_type: null,
|
|
21
|
-
mfa_verified: null,
|
|
22
|
-
mfa_status: null)
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# VeloPayments::CreateFundingAccountRequest
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**account_name** | **String** | |
|
|
8
|
-
**account_number** | **String** | |
|
|
9
|
-
**routing_number** | **String** | |
|
|
10
|
-
**payor_id** | **String** | |
|
|
11
|
-
|
|
12
|
-
## Code Sample
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'VeloPayments'
|
|
16
|
-
|
|
17
|
-
instance = VeloPayments::CreateFundingAccountRequest.new(account_name: null,
|
|
18
|
-
account_number: null,
|
|
19
|
-
routing_number: null,
|
|
20
|
-
payor_id: null)
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
|
data/docs/EmailUpdateRequest.md
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# VeloPayments::EmailUpdateRequest
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**email** | **String** | the email address of the invited user |
|
|
8
|
-
**verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them | [optional]
|
|
9
|
-
|
|
10
|
-
## Code Sample
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'VeloPayments'
|
|
14
|
-
|
|
15
|
-
instance = VeloPayments::EmailUpdateRequest.new(email: foo@example.com,
|
|
16
|
-
verification_code: 123456)
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# VeloPayments::GetFundingsResponseAllOf
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**content** | [**Array<FundingAudit>**](FundingAudit.md) | | [optional]
|
|
8
|
-
|
|
9
|
-
## Code Sample
|
|
10
|
-
|
|
11
|
-
```ruby
|
|
12
|
-
require 'VeloPayments'
|
|
13
|
-
|
|
14
|
-
instance = VeloPayments::GetFundingsResponseAllOf.new(content: null)
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
|
data/docs/GetPayoutApi.md
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
# VeloPayments::GetPayoutApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**get_payout_summary_v3**](GetPayoutApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## get_payout_summary_v3
|
|
12
|
-
|
|
13
|
-
> PayoutSummaryResponse get_payout_summary_v3(payout_id)
|
|
14
|
-
|
|
15
|
-
Get Payout Summary
|
|
16
|
-
|
|
17
|
-
Get payout summary - returns the current state of the payout.
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
# load the gem
|
|
23
|
-
require 'velopayments'
|
|
24
|
-
# setup authorization
|
|
25
|
-
VeloPayments.configure do |config|
|
|
26
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
27
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
api_instance = VeloPayments::GetPayoutApi.new
|
|
31
|
-
payout_id = 'payout_id_example' # String | Id of the payout
|
|
32
|
-
|
|
33
|
-
begin
|
|
34
|
-
#Get Payout Summary
|
|
35
|
-
result = api_instance.get_payout_summary_v3(payout_id)
|
|
36
|
-
p result
|
|
37
|
-
rescue VeloPayments::ApiError => e
|
|
38
|
-
puts "Exception when calling GetPayoutApi->get_payout_summary_v3: #{e}"
|
|
39
|
-
end
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Parameters
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
Name | Type | Description | Notes
|
|
46
|
-
------------- | ------------- | ------------- | -------------
|
|
47
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
48
|
-
|
|
49
|
-
### Return type
|
|
50
|
-
|
|
51
|
-
[**PayoutSummaryResponse**](PayoutSummaryResponse.md)
|
|
52
|
-
|
|
53
|
-
### Authorization
|
|
54
|
-
|
|
55
|
-
[OAuth2](../README.md#OAuth2)
|
|
56
|
-
|
|
57
|
-
### HTTP request headers
|
|
58
|
-
|
|
59
|
-
- **Content-Type**: Not defined
|
|
60
|
-
- **Accept**: application/json
|
|
61
|
-
|
data/docs/InstructPayoutApi.md
DELETED
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
# VeloPayments::InstructPayoutApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**instruct_payout_v3**](InstructPayoutApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## instruct_payout_v3
|
|
12
|
-
|
|
13
|
-
> instruct_payout_v3(payout_id)
|
|
14
|
-
|
|
15
|
-
Instruct Payout
|
|
16
|
-
|
|
17
|
-
Instruct a payout to be made for the specified payoutId.
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
# load the gem
|
|
23
|
-
require 'velopayments'
|
|
24
|
-
# setup authorization
|
|
25
|
-
VeloPayments.configure do |config|
|
|
26
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
27
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
api_instance = VeloPayments::InstructPayoutApi.new
|
|
31
|
-
payout_id = 'payout_id_example' # String | Id of the payout
|
|
32
|
-
|
|
33
|
-
begin
|
|
34
|
-
#Instruct Payout
|
|
35
|
-
api_instance.instruct_payout_v3(payout_id)
|
|
36
|
-
rescue VeloPayments::ApiError => e
|
|
37
|
-
puts "Exception when calling InstructPayoutApi->instruct_payout_v3: #{e}"
|
|
38
|
-
end
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Parameters
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
Name | Type | Description | Notes
|
|
45
|
-
------------- | ------------- | ------------- | -------------
|
|
46
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
47
|
-
|
|
48
|
-
### Return type
|
|
49
|
-
|
|
50
|
-
nil (empty response body)
|
|
51
|
-
|
|
52
|
-
### Authorization
|
|
53
|
-
|
|
54
|
-
[OAuth2](../README.md#OAuth2)
|
|
55
|
-
|
|
56
|
-
### HTTP request headers
|
|
57
|
-
|
|
58
|
-
- **Content-Type**: Not defined
|
|
59
|
-
- **Accept**: Not defined
|
|
60
|
-
|
data/docs/PagedResponse.md
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# VeloPayments::PagedResponse
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**page** | [**PagedResponsePage**](PagedResponsePage.md) | | [optional]
|
|
8
|
-
**links** | **Array<Object>** | | [optional]
|
|
9
|
-
|
|
10
|
-
## Code Sample
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'VeloPayments'
|
|
14
|
-
|
|
15
|
-
instance = VeloPayments::PagedResponse.new(page: null,
|
|
16
|
-
links: null)
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/PayoutHistoryApi.md
DELETED
|
@@ -1,221 +0,0 @@
|
|
|
1
|
-
# VeloPayments::PayoutHistoryApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**get_payments_for_payout**](PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
|
|
8
|
-
[**get_payments_for_payout_v4**](PayoutHistoryApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
|
|
9
|
-
[**get_payout_stats_v1**](PayoutHistoryApi.md#get_payout_stats_v1) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## get_payments_for_payout
|
|
14
|
-
|
|
15
|
-
> GetPaymentsForPayoutResponseV3 get_payments_for_payout(payout_id, opts)
|
|
16
|
-
|
|
17
|
-
Get Payments for Payout
|
|
18
|
-
|
|
19
|
-
Get List of payments for Payout
|
|
20
|
-
|
|
21
|
-
### Example
|
|
22
|
-
|
|
23
|
-
```ruby
|
|
24
|
-
# load the gem
|
|
25
|
-
require 'velopayments'
|
|
26
|
-
# setup authorization
|
|
27
|
-
VeloPayments.configure do |config|
|
|
28
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
29
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
api_instance = VeloPayments::PayoutHistoryApi.new
|
|
33
|
-
payout_id = 'payout_id_example' # String | The id (UUID) of the payout.
|
|
34
|
-
opts = {
|
|
35
|
-
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
36
|
-
status: 'status_example', # String | Payment Status
|
|
37
|
-
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
38
|
-
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
39
|
-
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
40
|
-
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
41
|
-
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
42
|
-
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
43
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
44
|
-
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
|
45
|
-
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
|
|
46
|
-
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.
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
begin
|
|
50
|
-
#Get Payments for Payout
|
|
51
|
-
result = api_instance.get_payments_for_payout(payout_id, opts)
|
|
52
|
-
p result
|
|
53
|
-
rescue VeloPayments::ApiError => e
|
|
54
|
-
puts "Exception when calling PayoutHistoryApi->get_payments_for_payout: #{e}"
|
|
55
|
-
end
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Parameters
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
Name | Type | Description | Notes
|
|
62
|
-
------------- | ------------- | ------------- | -------------
|
|
63
|
-
**payout_id** | [**String**](.md)| The id (UUID) of the payout. |
|
|
64
|
-
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
65
|
-
**status** | **String**| Payment Status | [optional]
|
|
66
|
-
**source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional]
|
|
67
|
-
**source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional]
|
|
68
|
-
**payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional]
|
|
69
|
-
**payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional]
|
|
70
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
71
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
72
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
73
|
-
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
|
74
|
-
**sort** | **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 | [optional]
|
|
75
|
-
**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]
|
|
76
|
-
|
|
77
|
-
### Return type
|
|
78
|
-
|
|
79
|
-
[**GetPaymentsForPayoutResponseV3**](GetPaymentsForPayoutResponseV3.md)
|
|
80
|
-
|
|
81
|
-
### Authorization
|
|
82
|
-
|
|
83
|
-
[OAuth2](../README.md#OAuth2)
|
|
84
|
-
|
|
85
|
-
### HTTP request headers
|
|
86
|
-
|
|
87
|
-
- **Content-Type**: Not defined
|
|
88
|
-
- **Accept**: application/json
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
## get_payments_for_payout_v4
|
|
92
|
-
|
|
93
|
-
> GetPaymentsForPayoutResponseV4 get_payments_for_payout_v4(payout_id, opts)
|
|
94
|
-
|
|
95
|
-
Get Payments for Payout
|
|
96
|
-
|
|
97
|
-
Get List of payments for Payout, allowing for RETURNED status
|
|
98
|
-
|
|
99
|
-
### Example
|
|
100
|
-
|
|
101
|
-
```ruby
|
|
102
|
-
# load the gem
|
|
103
|
-
require 'velopayments'
|
|
104
|
-
# setup authorization
|
|
105
|
-
VeloPayments.configure do |config|
|
|
106
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
107
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
api_instance = VeloPayments::PayoutHistoryApi.new
|
|
111
|
-
payout_id = 'payout_id_example' # String | The id (UUID) of the payout.
|
|
112
|
-
opts = {
|
|
113
|
-
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
114
|
-
status: 'status_example', # String | Payment Status
|
|
115
|
-
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
116
|
-
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
117
|
-
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
118
|
-
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
119
|
-
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
120
|
-
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
121
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
122
|
-
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
|
123
|
-
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
|
|
124
|
-
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.
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
begin
|
|
128
|
-
#Get Payments for Payout
|
|
129
|
-
result = api_instance.get_payments_for_payout_v4(payout_id, opts)
|
|
130
|
-
p result
|
|
131
|
-
rescue VeloPayments::ApiError => e
|
|
132
|
-
puts "Exception when calling PayoutHistoryApi->get_payments_for_payout_v4: #{e}"
|
|
133
|
-
end
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Parameters
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
Name | Type | Description | Notes
|
|
140
|
-
------------- | ------------- | ------------- | -------------
|
|
141
|
-
**payout_id** | [**String**](.md)| The id (UUID) of the payout. |
|
|
142
|
-
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
143
|
-
**status** | **String**| Payment Status | [optional]
|
|
144
|
-
**source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional]
|
|
145
|
-
**source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional]
|
|
146
|
-
**payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional]
|
|
147
|
-
**payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional]
|
|
148
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
149
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
150
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
151
|
-
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
|
152
|
-
**sort** | **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 | [optional]
|
|
153
|
-
**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]
|
|
154
|
-
|
|
155
|
-
### Return type
|
|
156
|
-
|
|
157
|
-
[**GetPaymentsForPayoutResponseV4**](GetPaymentsForPayoutResponseV4.md)
|
|
158
|
-
|
|
159
|
-
### Authorization
|
|
160
|
-
|
|
161
|
-
[OAuth2](../README.md#OAuth2)
|
|
162
|
-
|
|
163
|
-
### HTTP request headers
|
|
164
|
-
|
|
165
|
-
- **Content-Type**: Not defined
|
|
166
|
-
- **Accept**: application/json
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
## get_payout_stats_v1
|
|
170
|
-
|
|
171
|
-
> GetPayoutStatistics get_payout_stats_v1(opts)
|
|
172
|
-
|
|
173
|
-
Get Payout Statistics
|
|
174
|
-
|
|
175
|
-
Get payout statistics for a payor.
|
|
176
|
-
|
|
177
|
-
### Example
|
|
178
|
-
|
|
179
|
-
```ruby
|
|
180
|
-
# load the gem
|
|
181
|
-
require 'velopayments'
|
|
182
|
-
# setup authorization
|
|
183
|
-
VeloPayments.configure do |config|
|
|
184
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
185
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
186
|
-
end
|
|
187
|
-
|
|
188
|
-
api_instance = VeloPayments::PayoutHistoryApi.new
|
|
189
|
-
opts = {
|
|
190
|
-
payor_id: 'payor_id_example' # String | The account owner Payor ID. Required for external users.
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
begin
|
|
194
|
-
#Get Payout Statistics
|
|
195
|
-
result = api_instance.get_payout_stats_v1(opts)
|
|
196
|
-
p result
|
|
197
|
-
rescue VeloPayments::ApiError => e
|
|
198
|
-
puts "Exception when calling PayoutHistoryApi->get_payout_stats_v1: #{e}"
|
|
199
|
-
end
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Parameters
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
Name | Type | Description | Notes
|
|
206
|
-
------------- | ------------- | ------------- | -------------
|
|
207
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID. Required for external users. | [optional]
|
|
208
|
-
|
|
209
|
-
### Return type
|
|
210
|
-
|
|
211
|
-
[**GetPayoutStatistics**](GetPayoutStatistics.md)
|
|
212
|
-
|
|
213
|
-
### Authorization
|
|
214
|
-
|
|
215
|
-
[OAuth2](../README.md#OAuth2)
|
|
216
|
-
|
|
217
|
-
### HTTP request headers
|
|
218
|
-
|
|
219
|
-
- **Content-Type**: Not defined
|
|
220
|
-
- **Accept**: application/json
|
|
221
|
-
|