velopayments 2.20.29.beta1 → 2.29.128.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 +2 -2
- data/Makefile +27 -18
- data/README.md +174 -99
- data/docs/AcceptedPaymentV3.md +32 -0
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +24 -0
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +20 -0
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +91 -38
- data/docs/CreateFundingAccountRequestV2.md +30 -0
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVRequest.md +64 -63
- data/docs/CreatePayeesCSVRequest2.md +64 -63
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +24 -0
- data/docs/CreateWebhookRequest.md +26 -0
- data/docs/CurrenciesApi.md +29 -12
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -17
- data/docs/FundingAccountResponse2.md +36 -0
- data/docs/FundingAccountType.md +15 -0
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +772 -185
- data/docs/FundingManagerPrivateApi.md +101 -16
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +20 -0
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +20 -0
- data/docs/GetPayeeListResponse.md +50 -0
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +20 -0
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +18 -0
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +46 -41
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +22 -0
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +22 -0
- data/docs/InstructPayoutRequest.md +18 -0
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +15 -0
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +28 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +22 -0
- data/docs/ListPaymentsResponseV3.md +22 -0
- data/docs/ListPaymentsResponseV3Page.md +26 -0
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +20 -0
- data/docs/ListSourceAccountResponseV3.md +22 -0
- data/docs/ListSourceAccountResponseV3Links.md +20 -0
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +113 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +24 -0
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +18 -0
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +22 -0
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +74 -0
- data/docs/PayeeDetailResponse2.md +74 -0
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +253 -171
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeType2.md +15 -0
- data/docs/PayeeUserSelfUpdateRequest.md +28 -0
- data/docs/PayeesApi.md +472 -212
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +293 -438
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +34 -0
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +100 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +44 -0
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorLogoRequest.md +8 -7
- data/docs/PayorV1.md +50 -47
- data/docs/PayorV2.md +56 -45
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +18 -0
- data/docs/PayoutIndividualV3.md +18 -0
- data/docs/PayoutNameV3.md +20 -0
- data/docs/PayoutPayeeV3.md +22 -0
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutSchedule.md +28 -0
- data/docs/PayoutSchedule2.md +26 -0
- data/docs/PayoutServiceApi.md +659 -0
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +50 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +38 -0
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/PingResponse.md +20 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +38 -0
- data/docs/QuoteResponseV3.md +18 -0
- data/docs/RegionV2.md +20 -0
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +38 -0
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SchedulePayoutRequest.md +20 -0
- data/docs/ScheduleStatus.md +15 -0
- data/docs/ScheduleStatus2.md +15 -0
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -31
- data/docs/SourceAccountResponseV2.md +38 -35
- data/docs/SourceAccountResponseV3.md +52 -0
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +15 -0
- data/docs/SourceAccountV3.md +24 -0
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +18 -0
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +22 -0
- data/docs/SupportedCurrencyResponseV2.md +18 -0
- data/docs/SupportedCurrencyV2.md +20 -0
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +22 -0
- data/docs/TransmissionType.md +15 -0
- data/docs/TransmissionTypes.md +22 -0
- data/docs/TransmissionTypes2.md +22 -0
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +30 -0
- data/docs/UpdatePayeeDetailsRequest2.md +32 -0
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +24 -0
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +38 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +528 -181
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +15 -0
- data/docs/WebhookResponse.md +28 -0
- data/docs/WebhooksApi.md +365 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +541 -78
- data/lib/velopayments/api/funding_manager_private_api.rb +81 -14
- data/lib/velopayments/api/login_api.rb +29 -16
- data/lib/velopayments/api/payee_invitation_api.rb +116 -158
- data/lib/velopayments/api/payees_api.rb +317 -209
- data/lib/velopayments/api/payment_audit_service_api.rb +181 -461
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +64 -44
- data/lib/velopayments/api/payors_private_api.rb +10 -6
- data/lib/velopayments/api/payout_service_api.rb +659 -0
- data/lib/velopayments/api/tokens_api.rb +10 -6
- data/lib/velopayments/api/users_api.rb +188 -63
- data/lib/velopayments/api/webhooks_api.rb +356 -0
- data/lib/velopayments/api_client.rb +54 -50
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +42 -12
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +45 -15
- data/lib/velopayments/models/access_token_response.rb +20 -8
- data/lib/velopayments/models/access_token_validation_request.rb +20 -8
- data/lib/velopayments/models/auth_response.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
- data/lib/velopayments/models/{language.rb → category.rb} +9 -16
- data/lib/velopayments/models/challenge.rb +20 -8
- data/lib/velopayments/models/challenge2.rb +295 -0
- data/lib/velopayments/models/company.rb +25 -13
- data/lib/velopayments/models/company2.rb +25 -13
- data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
- data/lib/velopayments/models/create_individual.rb +21 -9
- data/lib/velopayments/models/create_individual2.rb +21 -9
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +25 -12
- data/lib/velopayments/models/create_payee2.rb +26 -13
- data/lib/velopayments/models/create_payee_address.rb +53 -25
- data/lib/velopayments/models/create_payee_address2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_request.rb +47 -46
- data/lib/velopayments/models/create_payees_csv_request2.rb +22 -21
- data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
- data/lib/velopayments/models/create_payees_request.rb +20 -8
- data/lib/velopayments/models/create_payees_request2.rb +20 -8
- data/lib/velopayments/models/create_payment_channel.rb +20 -8
- data/lib/velopayments/models/create_payment_channel2.rb +20 -8
- data/lib/velopayments/models/create_payor_link_request.rb +20 -8
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
- data/lib/velopayments/models/create_webhook_request.rb +338 -0
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/debit_event_all_of.rb +224 -0
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/error.rb +54 -14
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +49 -14
- data/lib/velopayments/models/failed_payee.rb +313 -0
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +21 -9
- data/lib/velopayments/models/failed_submission2.rb +21 -9
- data/lib/velopayments/models/funding_account_response.rb +115 -12
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
- data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
- data/lib/velopayments/models/funding_audit.rb +33 -19
- data/lib/velopayments/models/funding_event.rb +21 -9
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
- data/lib/velopayments/models/funding_request_v1.rb +20 -8
- data/lib/velopayments/models/funding_request_v2.rb +20 -8
- data/lib/velopayments/models/funding_request_v3.rb +267 -0
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
- data/lib/velopayments/models/fx_summary_v3.rb +21 -9
- data/lib/velopayments/models/get_fundings_response.rb +23 -18
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +97 -116
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +98 -117
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
- data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
- data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +53 -57
- data/lib/velopayments/models/get_payout_statistics.rb +20 -8
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
- data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
- data/lib/velopayments/models/individual.rb +21 -9
- data/lib/velopayments/models/individual2.rb +21 -9
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +23 -11
- data/lib/velopayments/models/inline_response400.rb +51 -14
- data/lib/velopayments/models/inline_response401.rb +51 -14
- data/lib/velopayments/models/inline_response403.rb +51 -14
- data/lib/velopayments/models/inline_response404.rb +258 -0
- data/lib/velopayments/models/inline_response409.rb +51 -14
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/instruct_payout_request.rb +219 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invite_payee_request.rb +20 -8
- data/lib/velopayments/models/invite_payee_request2.rb +20 -8
- data/lib/velopayments/models/invite_user_request.rb +54 -20
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
- data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +23 -11
- data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
- data/lib/velopayments/models/list_source_account_response.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +227 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +20 -8
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +341 -0
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +78 -58
- data/lib/velopayments/models/notifications.rb +20 -8
- data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/{inline_response409_errors.rb → onboarding_status_changed.rb} +92 -39
- data/lib/velopayments/models/page_for_response.rb +20 -8
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response.rb +21 -9
- data/lib/velopayments/models/paged_payee_response2.rb +22 -10
- data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
- data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
- data/lib/velopayments/models/paged_user_response.rb +20 -8
- data/lib/velopayments/models/paged_user_response_links.rb +20 -8
- data/lib/velopayments/models/paged_user_response_page.rb +20 -8
- data/lib/velopayments/models/password_request.rb +20 -8
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +20 -8
- data/lib/velopayments/models/payee_address2.rb +20 -8
- data/lib/velopayments/models/payee_delta.rb +21 -9
- data/lib/velopayments/models/payee_delta2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +46 -24
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +78 -65
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/payee_payor_ref.rb +66 -12
- data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
- data/lib/velopayments/models/payee_type.rb +5 -4
- data/lib/velopayments/models/payee_type2.rb +37 -0
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +20 -8
- data/lib/velopayments/models/payment_channel_rule.rb +20 -8
- data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
- data/lib/velopayments/models/payment_delta.rb +20 -8
- data/lib/velopayments/models/payment_delta_response.rb +20 -8
- data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
- data/lib/velopayments/models/payment_delta_v1.rb +297 -0
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/{list_payments_response_page.rb → payment_event_all_of.rb} +49 -48
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
- data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +108 -15
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
- data/lib/velopayments/models/payment_response_v3.rb +21 -9
- data/lib/velopayments/models/payment_response_v4.rb +120 -13
- data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/payment_v3.rb +399 -0
- data/lib/velopayments/models/payor_address.rb +20 -8
- data/lib/velopayments/models/payor_address_v2.rb +20 -8
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
- data/lib/velopayments/models/payor_branding_response.rb +20 -8
- data/lib/velopayments/models/payor_create_api_key_request.rb +31 -9
- data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
- data/lib/velopayments/models/payor_create_application_request.rb +20 -8
- data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
- data/lib/velopayments/models/payor_links_response.rb +20 -8
- data/lib/velopayments/models/payor_links_response_links.rb +20 -8
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
- data/lib/velopayments/models/payor_logo_request.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +75 -12
- data/lib/velopayments/models/payout_company_v3.rb +223 -0
- data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
- data/lib/velopayments/models/payout_name_v3.rb +237 -0
- data/lib/velopayments/models/payout_payee_v3.rb +242 -0
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
- data/lib/velopayments/models/payout_schedule.rb +291 -0
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → payout_schedule2.rb} +81 -78
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +51 -21
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +53 -18
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +68 -48
- data/lib/velopayments/models/{invitation_status_response.rb → ping_response.rb} +39 -25
- data/lib/velopayments/models/query_batch_response.rb +20 -8
- data/lib/velopayments/models/query_batch_response2.rb +20 -8
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +25 -13
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
- data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
- data/lib/velopayments/models/register_sms_request.rb +23 -11
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +42 -12
- data/lib/velopayments/models/resend_token_request.rb +20 -8
- data/lib/velopayments/models/reset_password_request.rb +20 -8
- data/lib/velopayments/models/role.rb +20 -8
- data/lib/velopayments/models/role_update_request.rb +20 -8
- data/lib/velopayments/models/{inline_response401_errors.rb → schedule_payout_request.rb} +48 -45
- data/lib/velopayments/models/schedule_status.rb +38 -0
- data/lib/velopayments/models/schedule_status2.rb +38 -0
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
- data/lib/velopayments/models/self_update_password_request.rb +20 -8
- data/lib/velopayments/models/set_notifications_request.rb +20 -8
- data/lib/velopayments/models/source_account_response.rb +34 -13
- data/lib/velopayments/models/source_account_response_v2.rb +36 -15
- data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
- data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +23 -11
- data/lib/velopayments/models/source_event.rb +255 -0
- data/lib/velopayments/models/supported_countries_response.rb +20 -8
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_country.rb +20 -8
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +23 -11
- data/lib/velopayments/models/transfer_request.rb +20 -8
- data/lib/velopayments/models/transfer_request2.rb +309 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{currency_type.rb → transmission_types.rb} +60 -45
- data/lib/velopayments/models/transmission_types2.rb +254 -0
- data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
- data/lib/velopayments/models/update_payee_details_request.rb +275 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +302 -0
- data/lib/velopayments/models/update_remote_id_request.rb +20 -8
- data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
- data/lib/velopayments/models/update_webhook_request.rb +312 -0
- data/lib/velopayments/models/user_details_update_request.rb +29 -17
- data/lib/velopayments/models/user_info.rb +20 -8
- data/lib/velopayments/models/user_response.rb +102 -19
- 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 +20 -8
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
- data/lib/velopayments/models/webhook_response.rb +265 -0
- data/lib/velopayments/models/webhooks_response.rb +241 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
- data/lib/velopayments/version.rb +3 -3
- data/lib/velopayments.rb +117 -68
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +94 -18
- data/spec/api/funding_manager_private_api_spec.rb +17 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +23 -35
- data/spec/api/payees_api_spec.rb +65 -49
- data/spec/api/payment_audit_service_api_spec.rb +35 -113
- data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- 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 +154 -0
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +18 -4
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +76 -0
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_request2_spec.rb +8 -19
- data/spec/models/create_payees_csv_request_spec.rb +11 -18
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -21
- data/spec/models/create_webhook_request_spec.rb +58 -0
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/debit_event_spec.rb +52 -0
- data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{marketing_opt_in_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +88 -0
- data/spec/models/funding_account_response_spec.rb +29 -12
- data/spec/models/{ofac_status2_spec.rb → funding_account_type_spec.rb} +8 -15
- data/spec/models/funding_audit_spec.rb +14 -21
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +40 -0
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +40 -0
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
- data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +17 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/instruct_payout_request_spec.rb +34 -0
- data/spec/models/{location_type_spec.rb → invitation_status2_spec.rb} +8 -15
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +16 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/{list_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
- data/spec/models/list_payments_response_v3_spec.rb +46 -0
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v3_spec.rb +46 -0
- data/spec/models/localisation_details_spec.rb +40 -0
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +52 -0
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +34 -0
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{list_payments_response_page_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/{payee_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response400_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -16
- data/spec/models/{language2_spec.rb → payee_type2_spec.rb} +8 -15
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
- data/spec/models/payment_audit_currency_spec.rb +28 -0
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_v1_spec.rb +46 -0
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/payment_delta_v1_spec.rb +76 -0
- data/spec/models/payment_event_all_of_spec.rb +46 -0
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
- data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/payment_rejected_or_returned_spec.rb +82 -0
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +67 -14
- data/spec/models/payment_status_changed_all_of_spec.rb +34 -0
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/{user_response2_spec.rb → payment_v3_spec.rb} +24 -45
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_logo_request_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +12 -13
- data/spec/models/payor_v2_spec.rb +36 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -15
- data/spec/models/payout_name_v3_spec.rb +40 -0
- data/spec/models/payout_payee_v3_spec.rb +46 -0
- data/spec/models/payout_payor_ids_spec.rb +46 -0
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/payout_schedule2_spec.rb +58 -0
- data/spec/models/{paged_payee_response2_summary_spec.rb → payout_schedule_spec.rb} +18 -19
- data/spec/models/payout_status_spec.rb +28 -0
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +20 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +20 -15
- data/spec/models/payout_type_spec.rb +28 -0
- data/spec/models/ping_response_spec.rb +40 -0
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +94 -0
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/schedule_payout_request_spec.rb +40 -0
- data/spec/models/schedule_status2_spec.rb +28 -0
- data/spec/models/schedule_status_spec.rb +28 -0
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +12 -13
- data/spec/models/source_account_response_v2_spec.rb +12 -13
- data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +28 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +34 -0
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
- data/spec/models/transfer_request2_spec.rb +46 -0
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +28 -0
- data/spec/models/transmission_types2_spec.rb +46 -0
- data/spec/models/transmission_types_spec.rb +46 -0
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request2_spec.rb} +20 -25
- data/spec/models/update_payee_details_request_spec.rb +70 -0
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +52 -0
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +24 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +28 -0
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +64 -0
- data/spec/models/webhooks_response_spec.rb +46 -0
- data/spec/models/withdraw_payment_request_spec.rb +34 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +45 -37
- data/specs/api/payees_api_spec.rb +53 -65
- data/specs/api/payment_audit_service_api_spec.rb +125 -74
- data/specs/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/{spec/models/payee2_spec.rb → specs/api/payout_service_api_spec.rb} +72 -110
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/specs/api/webhooks_api_spec.rb +96 -0
- data/velopayments.gemspec +3 -4
- metadata +466 -293
- data/docs/AcceptedPayment.md +0 -27
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayoutRequest.md +0 -25
- data/docs/CurrencyType.md +0 -17
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/ListPaymentsResponse.md +0 -21
- data/docs/ListPaymentsResponsePage.md +0 -25
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeResponseV3.md +0 -71
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PaymentInstruction.md +0 -27
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -45
- data/docs/PayoutSummaryResponse.md +0 -33
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/QuoteFxSummary.md +0 -37
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/Region.md +0 -19
- data/docs/RejectedPayment.md +0 -33
- data/docs/SourceAccount.md +0 -23
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCountry2.md +0 -21
- 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/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- 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 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/lib/velopayments/models/inline_response403_errors.rb +0 -236
- data/lib/velopayments/models/language2.rb +0 -45
- data/lib/velopayments/models/payee2.rb +0 -456
- data/lib/velopayments/models/payee_response.rb +0 -388
- data/spec/api/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- data/spec/models/get_fundings_response_all_of_spec.rb +0 -41
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
- data/spec/models/supported_countries_response2_spec.rb +0 -41
- data/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
@@ -0,0 +1,675 @@
|
|
1
|
+
# VeloPayments::PaymentAuditServiceDeprecatedApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.sandbox.velopayments.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**export_transactions_csvv3**](PaymentAuditServiceDeprecatedApi.md#export_transactions_csvv3) | **GET** /v3/paymentaudit/transactions | V3 Export Transactions |
|
8
|
+
| [**get_fundings_v1**](PaymentAuditServiceDeprecatedApi.md#get_fundings_v1) | **GET** /v1/paymentaudit/fundings | V1 Get Fundings for Payor |
|
9
|
+
| [**get_payment_details_v3**](PaymentAuditServiceDeprecatedApi.md#get_payment_details_v3) | **GET** /v3/paymentaudit/payments/{paymentId} | V3 Get Payment |
|
10
|
+
| [**get_payments_for_payout_pav3**](PaymentAuditServiceDeprecatedApi.md#get_payments_for_payout_pav3) | **GET** /v3/paymentaudit/payouts/{payoutId} | V3 Get Payments for Payout |
|
11
|
+
| [**get_payout_stats_v1**](PaymentAuditServiceDeprecatedApi.md#get_payout_stats_v1) | **GET** /v1/paymentaudit/payoutStatistics | V1 Get Payout Statistics |
|
12
|
+
| [**get_payouts_for_payor_v3**](PaymentAuditServiceDeprecatedApi.md#get_payouts_for_payor_v3) | **GET** /v3/paymentaudit/payouts | V3 Get Payouts for Payor |
|
13
|
+
| [**list_payment_changes**](PaymentAuditServiceDeprecatedApi.md#list_payment_changes) | **GET** /v1/deltas/payments | V1 List Payment Changes |
|
14
|
+
| [**list_payments_audit_v3**](PaymentAuditServiceDeprecatedApi.md#list_payments_audit_v3) | **GET** /v3/paymentaudit/payments | V3 Get List of Payments |
|
15
|
+
|
16
|
+
|
17
|
+
## export_transactions_csvv3
|
18
|
+
|
19
|
+
> <PayorAmlTransactionV3> export_transactions_csvv3(opts)
|
20
|
+
|
21
|
+
V3 Export Transactions
|
22
|
+
|
23
|
+
Deprecated (use /v4/paymentaudit/transactions instead)
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'velopayments'
|
30
|
+
# setup authorization
|
31
|
+
VeloPayments.configure do |config|
|
32
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
33
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
37
|
+
opts = {
|
38
|
+
payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
|
39
|
+
start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
|
40
|
+
end_date: Date.parse('2013-10-20') # Date | End date, inclusive. Format is YYYY-MM-DD
|
41
|
+
}
|
42
|
+
|
43
|
+
begin
|
44
|
+
# V3 Export Transactions
|
45
|
+
result = api_instance.export_transactions_csvv3(opts)
|
46
|
+
p result
|
47
|
+
rescue VeloPayments::ApiError => e
|
48
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->export_transactions_csvv3: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Using the export_transactions_csvv3_with_http_info variant
|
53
|
+
|
54
|
+
This returns an Array which contains the response data, status code and headers.
|
55
|
+
|
56
|
+
> <Array(<PayorAmlTransactionV3>, Integer, Hash)> export_transactions_csvv3_with_http_info(opts)
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
begin
|
60
|
+
# V3 Export Transactions
|
61
|
+
data, status_code, headers = api_instance.export_transactions_csvv3_with_http_info(opts)
|
62
|
+
p status_code # => 2xx
|
63
|
+
p headers # => { ... }
|
64
|
+
p data # => <PayorAmlTransactionV3>
|
65
|
+
rescue VeloPayments::ApiError => e
|
66
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->export_transactions_csvv3_with_http_info: #{e}"
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
| Name | Type | Description | Notes |
|
73
|
+
| ---- | ---- | ----------- | ----- |
|
74
|
+
| **payor_id** | **String** | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. | [optional] |
|
75
|
+
| **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
|
76
|
+
| **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**PayorAmlTransactionV3**](PayorAmlTransactionV3.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[OAuth2](../README.md#OAuth2)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: Not defined
|
89
|
+
- **Accept**: application/csv, application/json
|
90
|
+
|
91
|
+
|
92
|
+
## get_fundings_v1
|
93
|
+
|
94
|
+
> <GetFundingsResponse> get_fundings_v1(payor_id, opts)
|
95
|
+
|
96
|
+
V1 Get Fundings for Payor
|
97
|
+
|
98
|
+
Deprecated (use /v4/paymentaudit/fundings)
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'velopayments'
|
105
|
+
# setup authorization
|
106
|
+
VeloPayments.configure do |config|
|
107
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
108
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
109
|
+
end
|
110
|
+
|
111
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
112
|
+
payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
|
113
|
+
opts = {
|
114
|
+
page: 56, # Integer | Page number. Default is 1.
|
115
|
+
page_size: 56, # Integer | The number of results to return in a page
|
116
|
+
sort: 'sort_example' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
117
|
+
}
|
118
|
+
|
119
|
+
begin
|
120
|
+
# V1 Get Fundings for Payor
|
121
|
+
result = api_instance.get_fundings_v1(payor_id, opts)
|
122
|
+
p result
|
123
|
+
rescue VeloPayments::ApiError => e
|
124
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_fundings_v1: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
#### Using the get_fundings_v1_with_http_info variant
|
129
|
+
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
131
|
+
|
132
|
+
> <Array(<GetFundingsResponse>, Integer, Hash)> get_fundings_v1_with_http_info(payor_id, opts)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
# V1 Get Fundings for Payor
|
137
|
+
data, status_code, headers = api_instance.get_fundings_v1_with_http_info(payor_id, opts)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <GetFundingsResponse>
|
141
|
+
rescue VeloPayments::ApiError => e
|
142
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_fundings_v1_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **payor_id** | **String** | The account owner Payor ID | |
|
151
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
152
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
153
|
+
| **sort** | **String** | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. | [optional] |
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**GetFundingsResponse**](GetFundingsResponse.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_payment_details_v3
|
170
|
+
|
171
|
+
> <PaymentResponseV3> get_payment_details_v3(payment_id, opts)
|
172
|
+
|
173
|
+
V3 Get Payment
|
174
|
+
|
175
|
+
Deprecated (use /v4/paymentaudit/payments/<paymentId> instead)
|
176
|
+
|
177
|
+
### Examples
|
178
|
+
|
179
|
+
```ruby
|
180
|
+
require 'time'
|
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::PaymentAuditServiceDeprecatedApi.new
|
189
|
+
payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Payment Id
|
190
|
+
opts = {
|
191
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
192
|
+
}
|
193
|
+
|
194
|
+
begin
|
195
|
+
# V3 Get Payment
|
196
|
+
result = api_instance.get_payment_details_v3(payment_id, opts)
|
197
|
+
p result
|
198
|
+
rescue VeloPayments::ApiError => e
|
199
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payment_details_v3: #{e}"
|
200
|
+
end
|
201
|
+
```
|
202
|
+
|
203
|
+
#### Using the get_payment_details_v3_with_http_info variant
|
204
|
+
|
205
|
+
This returns an Array which contains the response data, status code and headers.
|
206
|
+
|
207
|
+
> <Array(<PaymentResponseV3>, Integer, Hash)> get_payment_details_v3_with_http_info(payment_id, opts)
|
208
|
+
|
209
|
+
```ruby
|
210
|
+
begin
|
211
|
+
# V3 Get Payment
|
212
|
+
data, status_code, headers = api_instance.get_payment_details_v3_with_http_info(payment_id, opts)
|
213
|
+
p status_code # => 2xx
|
214
|
+
p headers # => { ... }
|
215
|
+
p data # => <PaymentResponseV3>
|
216
|
+
rescue VeloPayments::ApiError => e
|
217
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payment_details_v3_with_http_info: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
### Parameters
|
222
|
+
|
223
|
+
| Name | Type | Description | Notes |
|
224
|
+
| ---- | ---- | ----------- | ----- |
|
225
|
+
| **payment_id** | **String** | Payment Id | |
|
226
|
+
| **sensitive** | **Boolean** | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional] |
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**PaymentResponseV3**](PaymentResponseV3.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
[OAuth2](../README.md#OAuth2)
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
## get_payments_for_payout_pav3
|
243
|
+
|
244
|
+
> <GetPaymentsForPayoutResponseV3> get_payments_for_payout_pav3(payout_id, opts)
|
245
|
+
|
246
|
+
V3 Get Payments for Payout
|
247
|
+
|
248
|
+
Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead)
|
249
|
+
|
250
|
+
### Examples
|
251
|
+
|
252
|
+
```ruby
|
253
|
+
require 'time'
|
254
|
+
require 'velopayments'
|
255
|
+
# setup authorization
|
256
|
+
VeloPayments.configure do |config|
|
257
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
258
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
259
|
+
end
|
260
|
+
|
261
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
262
|
+
payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id (UUID) of the payout.
|
263
|
+
opts = {
|
264
|
+
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
265
|
+
status: 'ACCEPTED', # String | Payment Status
|
266
|
+
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
267
|
+
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
268
|
+
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
269
|
+
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
270
|
+
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
271
|
+
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
272
|
+
page: 56, # Integer | Page number. Default is 1.
|
273
|
+
page_size: 56, # Integer | The number of results to return in a page
|
274
|
+
sort: 'sort_example', # String | <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p>
|
275
|
+
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.
|
276
|
+
}
|
277
|
+
|
278
|
+
begin
|
279
|
+
# V3 Get Payments for Payout
|
280
|
+
result = api_instance.get_payments_for_payout_pav3(payout_id, opts)
|
281
|
+
p result
|
282
|
+
rescue VeloPayments::ApiError => e
|
283
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payments_for_payout_pav3: #{e}"
|
284
|
+
end
|
285
|
+
```
|
286
|
+
|
287
|
+
#### Using the get_payments_for_payout_pav3_with_http_info variant
|
288
|
+
|
289
|
+
This returns an Array which contains the response data, status code and headers.
|
290
|
+
|
291
|
+
> <Array(<GetPaymentsForPayoutResponseV3>, Integer, Hash)> get_payments_for_payout_pav3_with_http_info(payout_id, opts)
|
292
|
+
|
293
|
+
```ruby
|
294
|
+
begin
|
295
|
+
# V3 Get Payments for Payout
|
296
|
+
data, status_code, headers = api_instance.get_payments_for_payout_pav3_with_http_info(payout_id, opts)
|
297
|
+
p status_code # => 2xx
|
298
|
+
p headers # => { ... }
|
299
|
+
p data # => <GetPaymentsForPayoutResponseV3>
|
300
|
+
rescue VeloPayments::ApiError => e
|
301
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payments_for_payout_pav3_with_http_info: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
### Parameters
|
306
|
+
|
307
|
+
| Name | Type | Description | Notes |
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
309
|
+
| **payout_id** | **String** | The id (UUID) of the payout. | |
|
310
|
+
| **remote_id** | **String** | The remote id of the payees. | [optional] |
|
311
|
+
| **status** | **String** | Payment Status | [optional] |
|
312
|
+
| **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] |
|
313
|
+
| **source_amount_to** | **Integer** | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] |
|
314
|
+
| **payment_amount_from** | **Integer** | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] |
|
315
|
+
| **payment_amount_to** | **Integer** | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] |
|
316
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
317
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
318
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
319
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
320
|
+
| **sort** | **String** | <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p> | [optional] |
|
321
|
+
| **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] |
|
322
|
+
|
323
|
+
### Return type
|
324
|
+
|
325
|
+
[**GetPaymentsForPayoutResponseV3**](GetPaymentsForPayoutResponseV3.md)
|
326
|
+
|
327
|
+
### Authorization
|
328
|
+
|
329
|
+
[OAuth2](../README.md#OAuth2)
|
330
|
+
|
331
|
+
### HTTP request headers
|
332
|
+
|
333
|
+
- **Content-Type**: Not defined
|
334
|
+
- **Accept**: application/json
|
335
|
+
|
336
|
+
|
337
|
+
## get_payout_stats_v1
|
338
|
+
|
339
|
+
> <GetPayoutStatistics> get_payout_stats_v1(opts)
|
340
|
+
|
341
|
+
V1 Get Payout Statistics
|
342
|
+
|
343
|
+
Deprecated (Use /v4/paymentaudit/payoutStatistics)
|
344
|
+
|
345
|
+
### Examples
|
346
|
+
|
347
|
+
```ruby
|
348
|
+
require 'time'
|
349
|
+
require 'velopayments'
|
350
|
+
# setup authorization
|
351
|
+
VeloPayments.configure do |config|
|
352
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
353
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
354
|
+
end
|
355
|
+
|
356
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
357
|
+
opts = {
|
358
|
+
payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID. Required for external users.
|
359
|
+
}
|
360
|
+
|
361
|
+
begin
|
362
|
+
# V1 Get Payout Statistics
|
363
|
+
result = api_instance.get_payout_stats_v1(opts)
|
364
|
+
p result
|
365
|
+
rescue VeloPayments::ApiError => e
|
366
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payout_stats_v1: #{e}"
|
367
|
+
end
|
368
|
+
```
|
369
|
+
|
370
|
+
#### Using the get_payout_stats_v1_with_http_info variant
|
371
|
+
|
372
|
+
This returns an Array which contains the response data, status code and headers.
|
373
|
+
|
374
|
+
> <Array(<GetPayoutStatistics>, Integer, Hash)> get_payout_stats_v1_with_http_info(opts)
|
375
|
+
|
376
|
+
```ruby
|
377
|
+
begin
|
378
|
+
# V1 Get Payout Statistics
|
379
|
+
data, status_code, headers = api_instance.get_payout_stats_v1_with_http_info(opts)
|
380
|
+
p status_code # => 2xx
|
381
|
+
p headers # => { ... }
|
382
|
+
p data # => <GetPayoutStatistics>
|
383
|
+
rescue VeloPayments::ApiError => e
|
384
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payout_stats_v1_with_http_info: #{e}"
|
385
|
+
end
|
386
|
+
```
|
387
|
+
|
388
|
+
### Parameters
|
389
|
+
|
390
|
+
| Name | Type | Description | Notes |
|
391
|
+
| ---- | ---- | ----------- | ----- |
|
392
|
+
| **payor_id** | **String** | The account owner Payor ID. Required for external users. | [optional] |
|
393
|
+
|
394
|
+
### Return type
|
395
|
+
|
396
|
+
[**GetPayoutStatistics**](GetPayoutStatistics.md)
|
397
|
+
|
398
|
+
### Authorization
|
399
|
+
|
400
|
+
[OAuth2](../README.md#OAuth2)
|
401
|
+
|
402
|
+
### HTTP request headers
|
403
|
+
|
404
|
+
- **Content-Type**: Not defined
|
405
|
+
- **Accept**: application/json
|
406
|
+
|
407
|
+
|
408
|
+
## get_payouts_for_payor_v3
|
409
|
+
|
410
|
+
> <GetPayoutsResponseV3> get_payouts_for_payor_v3(payor_id, opts)
|
411
|
+
|
412
|
+
V3 Get Payouts for Payor
|
413
|
+
|
414
|
+
Deprecated (use /v4/paymentaudit/payouts instead)
|
415
|
+
|
416
|
+
### Examples
|
417
|
+
|
418
|
+
```ruby
|
419
|
+
require 'time'
|
420
|
+
require 'velopayments'
|
421
|
+
# setup authorization
|
422
|
+
VeloPayments.configure do |config|
|
423
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
424
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
425
|
+
end
|
426
|
+
|
427
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
428
|
+
payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
|
429
|
+
opts = {
|
430
|
+
payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
|
431
|
+
status: 'ACCEPTED', # String | Payout Status
|
432
|
+
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
433
|
+
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
434
|
+
page: 56, # Integer | Page number. Default is 1.
|
435
|
+
page_size: 56, # Integer | The number of results to return in a page
|
436
|
+
sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.
|
437
|
+
}
|
438
|
+
|
439
|
+
begin
|
440
|
+
# V3 Get Payouts for Payor
|
441
|
+
result = api_instance.get_payouts_for_payor_v3(payor_id, opts)
|
442
|
+
p result
|
443
|
+
rescue VeloPayments::ApiError => e
|
444
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payouts_for_payor_v3: #{e}"
|
445
|
+
end
|
446
|
+
```
|
447
|
+
|
448
|
+
#### Using the get_payouts_for_payor_v3_with_http_info variant
|
449
|
+
|
450
|
+
This returns an Array which contains the response data, status code and headers.
|
451
|
+
|
452
|
+
> <Array(<GetPayoutsResponseV3>, Integer, Hash)> get_payouts_for_payor_v3_with_http_info(payor_id, opts)
|
453
|
+
|
454
|
+
```ruby
|
455
|
+
begin
|
456
|
+
# V3 Get Payouts for Payor
|
457
|
+
data, status_code, headers = api_instance.get_payouts_for_payor_v3_with_http_info(payor_id, opts)
|
458
|
+
p status_code # => 2xx
|
459
|
+
p headers # => { ... }
|
460
|
+
p data # => <GetPayoutsResponseV3>
|
461
|
+
rescue VeloPayments::ApiError => e
|
462
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->get_payouts_for_payor_v3_with_http_info: #{e}"
|
463
|
+
end
|
464
|
+
```
|
465
|
+
|
466
|
+
### Parameters
|
467
|
+
|
468
|
+
| Name | Type | Description | Notes |
|
469
|
+
| ---- | ---- | ----------- | ----- |
|
470
|
+
| **payor_id** | **String** | The account owner Payor ID | |
|
471
|
+
| **payout_memo** | **String** | Payout Memo filter - case insensitive sub-string match | [optional] |
|
472
|
+
| **status** | **String** | Payout Status | [optional] |
|
473
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
474
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
475
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
476
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
477
|
+
| **sort** | **String** | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. | [optional] |
|
478
|
+
|
479
|
+
### Return type
|
480
|
+
|
481
|
+
[**GetPayoutsResponseV3**](GetPayoutsResponseV3.md)
|
482
|
+
|
483
|
+
### Authorization
|
484
|
+
|
485
|
+
[OAuth2](../README.md#OAuth2)
|
486
|
+
|
487
|
+
### HTTP request headers
|
488
|
+
|
489
|
+
- **Content-Type**: Not defined
|
490
|
+
- **Accept**: application/json
|
491
|
+
|
492
|
+
|
493
|
+
## list_payment_changes
|
494
|
+
|
495
|
+
> <PaymentDeltaResponseV1> list_payment_changes(payor_id, updated_since, opts)
|
496
|
+
|
497
|
+
V1 List Payment Changes
|
498
|
+
|
499
|
+
Deprecated (use /v4/payments/deltas instead)
|
500
|
+
|
501
|
+
### Examples
|
502
|
+
|
503
|
+
```ruby
|
504
|
+
require 'time'
|
505
|
+
require 'velopayments'
|
506
|
+
# setup authorization
|
507
|
+
VeloPayments.configure do |config|
|
508
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
509
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
510
|
+
end
|
511
|
+
|
512
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
513
|
+
payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payments
|
514
|
+
updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
515
|
+
opts = {
|
516
|
+
page: 56, # Integer | Page number. Default is 1.
|
517
|
+
page_size: 56 # Integer | The number of results to return in a page
|
518
|
+
}
|
519
|
+
|
520
|
+
begin
|
521
|
+
# V1 List Payment Changes
|
522
|
+
result = api_instance.list_payment_changes(payor_id, updated_since, opts)
|
523
|
+
p result
|
524
|
+
rescue VeloPayments::ApiError => e
|
525
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->list_payment_changes: #{e}"
|
526
|
+
end
|
527
|
+
```
|
528
|
+
|
529
|
+
#### Using the list_payment_changes_with_http_info variant
|
530
|
+
|
531
|
+
This returns an Array which contains the response data, status code and headers.
|
532
|
+
|
533
|
+
> <Array(<PaymentDeltaResponseV1>, Integer, Hash)> list_payment_changes_with_http_info(payor_id, updated_since, opts)
|
534
|
+
|
535
|
+
```ruby
|
536
|
+
begin
|
537
|
+
# V1 List Payment Changes
|
538
|
+
data, status_code, headers = api_instance.list_payment_changes_with_http_info(payor_id, updated_since, opts)
|
539
|
+
p status_code # => 2xx
|
540
|
+
p headers # => { ... }
|
541
|
+
p data # => <PaymentDeltaResponseV1>
|
542
|
+
rescue VeloPayments::ApiError => e
|
543
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->list_payment_changes_with_http_info: #{e}"
|
544
|
+
end
|
545
|
+
```
|
546
|
+
|
547
|
+
### Parameters
|
548
|
+
|
549
|
+
| Name | Type | Description | Notes |
|
550
|
+
| ---- | ---- | ----------- | ----- |
|
551
|
+
| **payor_id** | **String** | The Payor ID to find associated Payments | |
|
552
|
+
| **updated_since** | **Time** | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | |
|
553
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
554
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 100] |
|
555
|
+
|
556
|
+
### Return type
|
557
|
+
|
558
|
+
[**PaymentDeltaResponseV1**](PaymentDeltaResponseV1.md)
|
559
|
+
|
560
|
+
### Authorization
|
561
|
+
|
562
|
+
[OAuth2](../README.md#OAuth2)
|
563
|
+
|
564
|
+
### HTTP request headers
|
565
|
+
|
566
|
+
- **Content-Type**: Not defined
|
567
|
+
- **Accept**: application/json
|
568
|
+
|
569
|
+
|
570
|
+
## list_payments_audit_v3
|
571
|
+
|
572
|
+
> <ListPaymentsResponseV3> list_payments_audit_v3(opts)
|
573
|
+
|
574
|
+
V3 Get List of Payments
|
575
|
+
|
576
|
+
Deprecated (use /v4/paymentaudit/payments instead)
|
577
|
+
|
578
|
+
### Examples
|
579
|
+
|
580
|
+
```ruby
|
581
|
+
require 'time'
|
582
|
+
require 'velopayments'
|
583
|
+
# setup authorization
|
584
|
+
VeloPayments.configure do |config|
|
585
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
586
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
587
|
+
end
|
588
|
+
|
589
|
+
api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
|
590
|
+
opts = {
|
591
|
+
payee_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The UUID of the payee.
|
592
|
+
payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The account owner Payor Id. Required for external users.
|
593
|
+
payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
|
594
|
+
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
595
|
+
status: 'ACCEPTED', # String | Payment Status
|
596
|
+
source_account_name: 'source_account_name_example', # String | The source account name filter. This filters via a case insensitive substring match.
|
597
|
+
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
598
|
+
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
599
|
+
source_currency: 'source_currency_example', # String | The source currency filter. Filters based on an exact match on the currency.
|
600
|
+
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
601
|
+
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
602
|
+
payment_currency: 'payment_currency_example', # String | The payment currency filter. Filters based on an exact match on the currency.
|
603
|
+
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
604
|
+
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
605
|
+
payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
|
606
|
+
page: 56, # Integer | Page number. Default is 1.
|
607
|
+
page_size: 56, # Integer | The number of results to return in a page
|
608
|
+
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
|
609
|
+
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.
|
610
|
+
}
|
611
|
+
|
612
|
+
begin
|
613
|
+
# V3 Get List of Payments
|
614
|
+
result = api_instance.list_payments_audit_v3(opts)
|
615
|
+
p result
|
616
|
+
rescue VeloPayments::ApiError => e
|
617
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->list_payments_audit_v3: #{e}"
|
618
|
+
end
|
619
|
+
```
|
620
|
+
|
621
|
+
#### Using the list_payments_audit_v3_with_http_info variant
|
622
|
+
|
623
|
+
This returns an Array which contains the response data, status code and headers.
|
624
|
+
|
625
|
+
> <Array(<ListPaymentsResponseV3>, Integer, Hash)> list_payments_audit_v3_with_http_info(opts)
|
626
|
+
|
627
|
+
```ruby
|
628
|
+
begin
|
629
|
+
# V3 Get List of Payments
|
630
|
+
data, status_code, headers = api_instance.list_payments_audit_v3_with_http_info(opts)
|
631
|
+
p status_code # => 2xx
|
632
|
+
p headers # => { ... }
|
633
|
+
p data # => <ListPaymentsResponseV3>
|
634
|
+
rescue VeloPayments::ApiError => e
|
635
|
+
puts "Error when calling PaymentAuditServiceDeprecatedApi->list_payments_audit_v3_with_http_info: #{e}"
|
636
|
+
end
|
637
|
+
```
|
638
|
+
|
639
|
+
### Parameters
|
640
|
+
|
641
|
+
| Name | Type | Description | Notes |
|
642
|
+
| ---- | ---- | ----------- | ----- |
|
643
|
+
| **payee_id** | **String** | The UUID of the payee. | [optional] |
|
644
|
+
| **payor_id** | **String** | The account owner Payor Id. Required for external users. | [optional] |
|
645
|
+
| **payor_name** | **String** | The payor’s name. This filters via a case insensitive substring match. | [optional] |
|
646
|
+
| **remote_id** | **String** | The remote id of the payees. | [optional] |
|
647
|
+
| **status** | **String** | Payment Status | [optional] |
|
648
|
+
| **source_account_name** | **String** | The source account name filter. This filters via a case insensitive substring match. | [optional] |
|
649
|
+
| **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] |
|
650
|
+
| **source_amount_to** | **Integer** | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] |
|
651
|
+
| **source_currency** | **String** | The source currency filter. Filters based on an exact match on the currency. | [optional] |
|
652
|
+
| **payment_amount_from** | **Integer** | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] |
|
653
|
+
| **payment_amount_to** | **Integer** | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] |
|
654
|
+
| **payment_currency** | **String** | The payment currency filter. Filters based on an exact match on the currency. | [optional] |
|
655
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
656
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
657
|
+
| **payment_memo** | **String** | The payment memo filter. This filters via a case insensitive substring match. | [optional] |
|
658
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
659
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
660
|
+
| **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] |
|
661
|
+
| **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] |
|
662
|
+
|
663
|
+
### Return type
|
664
|
+
|
665
|
+
[**ListPaymentsResponseV3**](ListPaymentsResponseV3.md)
|
666
|
+
|
667
|
+
### Authorization
|
668
|
+
|
669
|
+
[OAuth2](../README.md#OAuth2)
|
670
|
+
|
671
|
+
### HTTP request headers
|
672
|
+
|
673
|
+
- **Content-Type**: Not defined
|
674
|
+
- **Accept**: application/json
|
675
|
+
|