velopayments 2.23.78.beta1 → 2.26.124.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/Makefile +2 -3
- data/README.md +61 -71
- data/docs/AcceptedPaymentV3.md +22 -17
- 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 +14 -13
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +10 -9
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +74 -21
- data/docs/CreateFundingAccountRequestV2.md +20 -19
- 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/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 +14 -15
- data/docs/CreateWebhookRequest.md +16 -13
- data/docs/CurrenciesApi.md +26 -9
- 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 -25
- data/docs/FundingAccountResponse2.md +26 -25
- data/docs/FundingAccountType.md +4 -5
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +549 -259
- data/docs/FundingManagerPrivateApi.md +98 -13
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +10 -9
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +10 -9
- data/docs/GetPayeeListResponse.md +40 -39
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +10 -9
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +8 -7
- 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 +44 -43
- 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 +12 -9
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +12 -9
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +4 -5
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +12 -11
- data/docs/ListPaymentsResponseV3.md +12 -11
- data/docs/ListPaymentsResponseV3Page.md +16 -15
- 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 +10 -9
- data/docs/ListSourceAccountResponseV3.md +12 -11
- data/docs/ListSourceAccountResponseV3Links.md +10 -9
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +109 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +14 -13
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +8 -7
- 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 +12 -11
- 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 +64 -63
- data/docs/PayeeDetailResponse2.md +64 -63
- 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 +216 -359
- 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/PayeeUserSelfUpdateRequest.md +18 -17
- data/docs/PayeesApi.md +346 -499
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +242 -631
- 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 +24 -19
- 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 +96 -85
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +32 -27
- 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/PayorV1.md +50 -49
- data/docs/PayorV2.md +52 -49
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +8 -7
- data/docs/PayoutIndividualV3.md +8 -7
- data/docs/PayoutNameV3.md +10 -9
- data/docs/PayoutPayeeV3.md +12 -11
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +208 -88
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +26 -25
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +28 -27
- data/docs/QuoteResponseV3.md +8 -7
- data/docs/RegionV2.md +10 -9
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +28 -23
- 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/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -33
- data/docs/SourceAccountResponseV2.md +38 -37
- data/docs/SourceAccountResponseV3.md +42 -37
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +4 -5
- data/docs/SourceAccountV3.md +14 -13
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +8 -7
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +12 -11
- data/docs/SupportedCurrencyResponseV2.md +8 -7
- data/docs/SupportedCurrencyV2.md +10 -9
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +12 -11
- data/docs/TransmissionType.md +4 -5
- data/docs/TransmissionTypes.md +12 -11
- data/docs/TransmissionTypes2.md +12 -11
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +20 -19
- data/docs/UpdatePayeeDetailsRequest2.md +20 -19
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +14 -11
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +478 -189
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +4 -5
- data/docs/WebhookResponse.md +18 -15
- data/docs/WebhooksApi.md +109 -92
- data/docs/WebhooksResponse.md +12 -11
- data/docs/WithdrawPaymentRequest.md +8 -7
- data/lib/velopayments.rb +50 -48
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +5 -2
- data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +25 -358
- data/lib/velopayments/api/payees_api.rb +28 -468
- data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_service_api.rb +9 -2
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +2 -2
- data/lib/velopayments/api/webhooks_api.rb +2 -61
- data/lib/velopayments/api_client.rb +6 -5
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -7
- data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
- data/lib/velopayments/models/access_token_response.rb +12 -4
- data/lib/velopayments/models/access_token_validation_request.rb +12 -4
- data/lib/velopayments/models/auth_response.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
- data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
- data/lib/velopayments/models/challenge.rb +12 -4
- data/lib/velopayments/models/challenge2.rb +12 -4
- data/lib/velopayments/models/company.rb +12 -4
- data/lib/velopayments/models/company2.rb +12 -4
- data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
- data/lib/velopayments/models/create_individual.rb +13 -5
- data/lib/velopayments/models/create_individual2.rb +13 -5
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
- data/lib/velopayments/models/create_payee.rb +16 -7
- data/lib/velopayments/models/create_payee2.rb +15 -6
- data/lib/velopayments/models/create_payee_address.rb +45 -21
- data/lib/velopayments/models/create_payee_address2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
- data/lib/velopayments/models/create_payees_request.rb +12 -4
- data/lib/velopayments/models/create_payees_request2.rb +12 -4
- data/lib/velopayments/models/create_payment_channel.rb +12 -4
- data/lib/velopayments/models/create_payment_channel2.rb +12 -4
- data/lib/velopayments/models/create_payor_link_request.rb +12 -4
- data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
- data/lib/velopayments/models/create_webhook_request.rb +31 -8
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/error.rb +46 -10
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +41 -10
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +13 -5
- data/lib/velopayments/models/failed_submission2.rb +13 -5
- data/lib/velopayments/models/funding_account_response.rb +12 -4
- data/lib/velopayments/models/funding_account_response2.rb +12 -4
- data/lib/velopayments/models/funding_account_type.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +12 -4
- data/lib/velopayments/models/funding_event.rb +12 -4
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/funding_request_v1.rb +12 -4
- data/lib/velopayments/models/funding_request_v2.rb +12 -4
- data/lib/velopayments/models/funding_request_v3.rb +12 -4
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
- data/lib/velopayments/models/fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/get_fundings_response.rb +12 -4
- data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
- data/lib/velopayments/models/get_payee_list_response.rb +14 -5
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
- data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
- data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
- data/lib/velopayments/models/get_payout_statistics.rb +12 -4
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
- data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
- data/lib/velopayments/models/individual.rb +13 -5
- data/lib/velopayments/models/individual2.rb +13 -5
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
- data/lib/velopayments/models/inline_response400.rb +43 -10
- data/lib/velopayments/models/inline_response401.rb +43 -10
- data/lib/velopayments/models/inline_response403.rb +43 -10
- data/lib/velopayments/models/inline_response404.rb +43 -10
- data/lib/velopayments/models/inline_response409.rb +43 -10
- data/lib/velopayments/models/inline_response412.rb +43 -10
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status2.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +12 -4
- data/lib/velopayments/models/invite_payee_request2.rb +12 -4
- data/lib/velopayments/models/invite_user_request.rb +12 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/link_for_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
- data/lib/velopayments/models/list_source_account_response.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +12 -4
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/name.rb +12 -4
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
- data/lib/velopayments/models/notifications.rb +12 -4
- data/lib/velopayments/models/notifications2.rb +12 -4
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status2.rb +2 -2
- data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
- data/lib/velopayments/models/page_for_response.rb +12 -4
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response.rb +13 -5
- data/lib/velopayments/models/paged_payee_response2.rb +14 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
- data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/paged_user_response.rb +12 -4
- data/lib/velopayments/models/paged_user_response_links.rb +12 -4
- data/lib/velopayments/models/paged_user_response_page.rb +12 -4
- data/lib/velopayments/models/password_request.rb +12 -4
- 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 +12 -4
- data/lib/velopayments/models/payee_address2.rb +12 -4
- data/lib/velopayments/models/payee_delta.rb +13 -5
- data/lib/velopayments/models/payee_delta2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
- data/lib/velopayments/models/payee_detail_response.rb +18 -9
- data/lib/velopayments/models/payee_detail_response2.rb +16 -7
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
- 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 +12 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/payee_payor_ref.rb +58 -8
- data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +12 -4
- data/lib/velopayments/models/payment_channel_rule.rb +12 -4
- data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
- data/lib/velopayments/models/payment_delta.rb +12 -4
- data/lib/velopayments/models/payment_delta_response.rb +12 -4
- data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
- data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/payment_event_all_of.rb +243 -0
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
- data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
- data/lib/velopayments/models/payment_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_response_v4.rb +65 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/payment_v3.rb +34 -8
- data/lib/velopayments/models/payor_address.rb +12 -4
- data/lib/velopayments/models/payor_address_v2.rb +12 -4
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
- data/lib/velopayments/models/payor_branding_response.rb +12 -4
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
- data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
- data/lib/velopayments/models/payor_create_application_request.rb +12 -4
- data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
- data/lib/velopayments/models/payor_links_response.rb +12 -4
- data/lib/velopayments/models/payor_links_response_links.rb +12 -4
- data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
- data/lib/velopayments/models/payor_v1.rb +12 -4
- data/lib/velopayments/models/payor_v2.rb +28 -8
- data/lib/velopayments/models/payout_company_v3.rb +12 -4
- data/lib/velopayments/models/payout_individual_v3.rb +12 -4
- data/lib/velopayments/models/payout_name_v3.rb +12 -4
- data/lib/velopayments/models/payout_payee_v3.rb +12 -4
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
- data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
- data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
- data/lib/velopayments/models/query_batch_response.rb +12 -4
- data/lib/velopayments/models/query_batch_response2.rb +12 -4
- data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/quote_response_v3.rb +12 -4
- data/lib/velopayments/models/region_v2.rb +12 -4
- data/lib/velopayments/models/register_sms_request.rb +12 -4
- data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
- data/lib/velopayments/models/resend_token_request.rb +12 -4
- data/lib/velopayments/models/reset_password_request.rb +12 -4
- data/lib/velopayments/models/role.rb +12 -4
- data/lib/velopayments/models/role_update_request.rb +12 -4
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
- data/lib/velopayments/models/self_update_password_request.rb +12 -4
- data/lib/velopayments/models/set_notifications_request.rb +12 -4
- data/lib/velopayments/models/source_account_response.rb +12 -4
- data/lib/velopayments/models/source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/source_account_response_v3.rb +40 -12
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
- data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
- data/lib/velopayments/models/source_account_type.rb +2 -2
- data/lib/velopayments/models/source_account_v3.rb +12 -4
- data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
- data/lib/velopayments/models/supported_countries_response.rb +12 -4
- data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_country.rb +12 -4
- data/lib/velopayments/models/supported_country_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_v2.rb +12 -4
- data/lib/velopayments/models/transfer_request.rb +12 -4
- data/lib/velopayments/models/transfer_request2.rb +12 -4
- data/lib/velopayments/models/transmission_type.rb +2 -2
- data/lib/velopayments/models/transmission_types.rb +12 -4
- data/lib/velopayments/models/transmission_types2.rb +12 -4
- data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
- data/lib/velopayments/models/update_payee_details_request.rb +19 -10
- data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
- data/lib/velopayments/models/update_remote_id_request.rb +12 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
- data/lib/velopayments/models/update_webhook_request.rb +32 -8
- data/lib/velopayments/models/user_details_update_request.rb +12 -4
- data/lib/velopayments/models/user_info.rb +12 -4
- data/lib/velopayments/models/user_response.rb +27 -4
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +12 -4
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/models/watchlist_status2.rb +2 -2
- data/lib/velopayments/models/webhook_response.rb +27 -8
- data/lib/velopayments/models/webhooks_response.rb +12 -4
- data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +3 -2
- data/spec/api/funding_manager_private_api_spec.rb +14 -2
- data/spec/api/login_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +10 -75
- data/spec/api/payees_api_spec.rb +11 -99
- data/spec/api/payment_audit_service_api_spec.rb +9 -147
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +3 -2
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +2 -12
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +17 -12
- 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/auto_top_up_config2_spec.rb +5 -12
- 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/challenge2_spec.rb +5 -12
- 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/create_funding_account_request_v2_spec.rb +6 -13
- 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_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_v3_spec.rb +5 -18
- data/spec/models/create_webhook_request_spec.rb +11 -12
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
- data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{ping_response_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 +5 -12
- data/spec/models/funding_account_response_spec.rb +5 -12
- data/spec/models/funding_account_type_spec.rb +5 -12
- data/spec/models/funding_audit_spec.rb +8 -15
- 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 +5 -12
- 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 +5 -12
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_company_spec.rb +5 -12
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
- data/spec/models/get_payee_list_response_spec.rb +5 -12
- 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 +5 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
- 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/inline_response404_spec.rb +11 -12
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +11 -12
- data/spec/models/invitation_status2_spec.rb +5 -12
- 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 +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_spec.rb +5 -12
- 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 +5 -12
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_spec.rb +5 -12
- data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
- 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 +5 -12
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +5 -12
- 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/{payee_payor_ref2_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/paged_payments_response_v3_spec.rb +5 -12
- 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_detail_response2_spec.rb +5 -12
- data/spec/models/payee_detail_response_spec.rb +5 -12
- 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_response401_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 -12
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/payee_user_self_update_request_spec.rb +5 -12
- data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
- 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_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
- data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
- 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/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
- data/spec/models/payment_instruction_v3_spec.rb +17 -12
- 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/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
- 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 +37 -14
- data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
- data/spec/models/payment_v3_spec.rb +18 -13
- 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_v1_spec.rb +6 -13
- data/spec/models/payor_v2_spec.rb +12 -13
- data/spec/models/payout_company_v3_spec.rb +5 -12
- data/spec/models/payout_individual_v3_spec.rb +5 -12
- data/spec/models/payout_name_v3_spec.rb +5 -12
- data/spec/models/payout_payee_v3_spec.rb +5 -12
- data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
- 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/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/payout_summary_response_v3_spec.rb +5 -12
- data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
- 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_v3_spec.rb +7 -14
- data/spec/models/quote_response_v3_spec.rb +5 -12
- data/spec/models/region_v2_spec.rb +5 -12
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +17 -12
- 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/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 +6 -13
- data/spec/models/source_account_response_v2_spec.rb +6 -13
- data/spec/models/source_account_response_v3_spec.rb +19 -14
- 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 +5 -12
- data/spec/models/source_account_v3_spec.rb +5 -12
- 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 +5 -12
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/supported_country_v2_spec.rb +5 -12
- data/spec/models/supported_currency_response_v2_spec.rb +5 -12
- data/spec/models/supported_currency_v2_spec.rb +5 -12
- data/spec/models/transfer_request2_spec.rb +5 -12
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +5 -12
- data/spec/models/transmission_types2_spec.rb +5 -12
- data/spec/models/transmission_types_spec.rb +5 -12
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +5 -12
- data/spec/models/update_payee_details_request_spec.rb +5 -12
- 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 +11 -12
- 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 +8 -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 +5 -12
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +11 -12
- data/spec/models/webhooks_response_spec.rb +5 -12
- data/spec/models/withdraw_payment_request_spec.rb +5 -12
- data/spec/spec_helper.rb +2 -2
- data/specs/api/payee_invitation_api_spec.rb +0 -42
- data/specs/api/payees_api_spec.rb +0 -99
- data/specs/api/payment_audit_service_api_spec.rb +0 -150
- data/velopayments.gemspec +2 -2
- metadata +194 -186
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/FxSummaryV4.md +0 -35
- 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/InlineResponse404Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InlineResponse412Errors.md +0 -23
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- 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/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/PayeePayorRef2.md +0 -25
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeType2.md +0 -16
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentDeltaResponseV4.md +0 -21
- data/docs/PaymentDeltaV4.md +0 -31
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -47
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/PingResponse.md +0 -19
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
- data/lib/velopayments/models/inline_response401_errors.rb +0 -240
- data/lib/velopayments/models/inline_response409_errors.rb +0 -240
- data/lib/velopayments/models/inline_response412_errors.rb +0 -240
- data/lib/velopayments/models/language.rb +0 -46
- data/lib/velopayments/models/language2.rb +0 -46
- data/lib/velopayments/models/location_type.rb +0 -40
- data/lib/velopayments/models/ofac_status2.rb +0 -38
- data/lib/velopayments/models/payee2.rb +0 -460
- data/lib/velopayments/models/payee_payment_channel.rb +0 -455
- data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
- data/lib/velopayments/models/payee_response.rb +0 -392
- data/lib/velopayments/models/payee_response_v2.rb +0 -475
- data/lib/velopayments/models/payor_logo_request.rb +0 -210
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response404_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/inline_response412_errors_spec.rb +0 -59
- data/spec/models/location_type_spec.rb +0 -35
- data/spec/models/payee2_spec.rb +0 -165
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payee_response_spec.rb +0 -155
- data/spec/models/payee_response_v2_spec.rb +0 -209
- 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
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# VeloPayments::PaymentAuditCurrency
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'velopayments'
|
|
12
|
+
|
|
13
|
+
instance = VeloPayments::PaymentAuditCurrency.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Example
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
require '
|
|
11
|
+
require 'velopayments'
|
|
12
12
|
|
|
13
13
|
instance = VeloPayments::PaymentAuditCurrencyV3.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
@@ -2,97 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
12
|
-
[**
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**get_payout_stats_v1**](PaymentAuditServiceApi.md#get_payout_stats_v1) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
|
|
16
|
-
[**get_payout_stats_v4**](PaymentAuditServiceApi.md#get_payout_stats_v4) | **GET** /v4/paymentaudit/payoutStatistics | Get Payout Statistics
|
|
17
|
-
[**get_payouts_for_payor_v3**](PaymentAuditServiceApi.md#get_payouts_for_payor_v3) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
|
|
18
|
-
[**get_payouts_for_payor_v4**](PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor
|
|
19
|
-
[**list_payment_changes**](PaymentAuditServiceApi.md#list_payment_changes) | **GET** /v1/deltas/payments | List Payment Changes
|
|
20
|
-
[**list_payment_changes_v4**](PaymentAuditServiceApi.md#list_payment_changes_v4) | **GET** /v4/payments/deltas | List Payment Changes
|
|
21
|
-
[**list_payments_audit**](PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
|
|
22
|
-
[**list_payments_audit_v4**](PaymentAuditServiceApi.md#list_payments_audit_v4) | **GET** /v4/paymentaudit/payments | Get List of Payments
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
## export_transactions_csvv3
|
|
27
|
-
|
|
28
|
-
> PayorAmlTransactionV3 export_transactions_csvv3(opts)
|
|
29
|
-
|
|
30
|
-
Export Transactions
|
|
31
|
-
|
|
32
|
-
Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
|
|
33
|
-
|
|
34
|
-
### Example
|
|
35
|
-
|
|
36
|
-
```ruby
|
|
37
|
-
# load the gem
|
|
38
|
-
require 'velopayments'
|
|
39
|
-
# setup authorization
|
|
40
|
-
VeloPayments.configure do |config|
|
|
41
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
42
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
43
|
-
end
|
|
44
|
-
|
|
45
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
46
|
-
opts = {
|
|
47
|
-
payor_id: 'payor_id_example', # 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.
|
|
48
|
-
start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
|
|
49
|
-
end_date: Date.parse('2013-10-20') # Date | End date, inclusive. Format is YYYY-MM-DD
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
begin
|
|
53
|
-
#Export Transactions
|
|
54
|
-
result = api_instance.export_transactions_csvv3(opts)
|
|
55
|
-
p result
|
|
56
|
-
rescue VeloPayments::ApiError => e
|
|
57
|
-
puts "Exception when calling PaymentAuditServiceApi->export_transactions_csvv3: #{e}"
|
|
58
|
-
end
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Parameters
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
Name | Type | Description | Notes
|
|
65
|
-
------------- | ------------- | ------------- | -------------
|
|
66
|
-
**payor_id** | [**String**](.md)| The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. | [optional]
|
|
67
|
-
**start_date** | **Date**| Start date, inclusive. Format is YYYY-MM-DD | [optional]
|
|
68
|
-
**end_date** | **Date**| End date, inclusive. Format is YYYY-MM-DD | [optional]
|
|
69
|
-
|
|
70
|
-
### Return type
|
|
71
|
-
|
|
72
|
-
[**PayorAmlTransactionV3**](PayorAmlTransactionV3.md)
|
|
73
|
-
|
|
74
|
-
### Authorization
|
|
75
|
-
|
|
76
|
-
[OAuth2](../README.md#OAuth2)
|
|
77
|
-
|
|
78
|
-
### HTTP request headers
|
|
79
|
-
|
|
80
|
-
- **Content-Type**: Not defined
|
|
81
|
-
- **Accept**: application/csv, application/json
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**export_transactions_csvv4**](PaymentAuditServiceApi.md#export_transactions_csvv4) | **GET** /v4/paymentaudit/transactions | Export Transactions |
|
|
8
|
+
| [**get_fundings_v4**](PaymentAuditServiceApi.md#get_fundings_v4) | **GET** /v4/paymentaudit/fundings | Get Fundings for Payor |
|
|
9
|
+
| [**get_payment_details_v4**](PaymentAuditServiceApi.md#get_payment_details_v4) | **GET** /v4/paymentaudit/payments/{paymentId} | Get Payment |
|
|
10
|
+
| [**get_payments_for_payout_v4**](PaymentAuditServiceApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout |
|
|
11
|
+
| [**get_payout_stats_v4**](PaymentAuditServiceApi.md#get_payout_stats_v4) | **GET** /v4/paymentaudit/payoutStatistics | Get Payout Statistics |
|
|
12
|
+
| [**get_payouts_for_payor_v4**](PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor |
|
|
13
|
+
| [**list_payment_changes_v4**](PaymentAuditServiceApi.md#list_payment_changes_v4) | **GET** /v4/payments/deltas | List Payment Changes |
|
|
14
|
+
| [**list_payments_audit_v4**](PaymentAuditServiceApi.md#list_payments_audit_v4) | **GET** /v4/paymentaudit/payments | Get List of Payments |
|
|
82
15
|
|
|
83
16
|
|
|
84
17
|
## export_transactions_csvv4
|
|
85
18
|
|
|
86
|
-
>
|
|
19
|
+
> <PayorAmlTransaction> export_transactions_csvv4(opts)
|
|
87
20
|
|
|
88
21
|
Export Transactions
|
|
89
22
|
|
|
90
23
|
Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
|
|
91
24
|
|
|
92
|
-
###
|
|
25
|
+
### Examples
|
|
93
26
|
|
|
94
27
|
```ruby
|
|
95
|
-
|
|
28
|
+
require 'time'
|
|
96
29
|
require 'velopayments'
|
|
97
30
|
# setup authorization
|
|
98
31
|
VeloPayments.configure do |config|
|
|
@@ -102,94 +35,51 @@ end
|
|
|
102
35
|
|
|
103
36
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
104
37
|
opts = {
|
|
105
|
-
payor_id:
|
|
38
|
+
payor_id: TODO, # String | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
|
|
106
39
|
start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
|
|
107
40
|
end_date: Date.parse('2013-10-20'), # Date | End date, inclusive. Format is YYYY-MM-DD
|
|
108
|
-
include: '
|
|
41
|
+
include: 'payorOnly' # String | <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
|
|
109
42
|
}
|
|
110
43
|
|
|
111
44
|
begin
|
|
112
|
-
#Export Transactions
|
|
45
|
+
# Export Transactions
|
|
113
46
|
result = api_instance.export_transactions_csvv4(opts)
|
|
114
47
|
p result
|
|
115
48
|
rescue VeloPayments::ApiError => e
|
|
116
|
-
puts "
|
|
49
|
+
puts "Error when calling PaymentAuditServiceApi->export_transactions_csvv4: #{e}"
|
|
117
50
|
end
|
|
118
51
|
```
|
|
119
52
|
|
|
120
|
-
|
|
121
|
-
|
|
53
|
+
#### Using the export_transactions_csvv4_with_http_info variant
|
|
122
54
|
|
|
123
|
-
|
|
124
|
-
------------- | ------------- | ------------- | -------------
|
|
125
|
-
**payor_id** | [**String**](.md)| <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p> | [optional]
|
|
126
|
-
**start_date** | **Date**| Start date, inclusive. Format is YYYY-MM-DD | [optional]
|
|
127
|
-
**end_date** | **Date**| End date, inclusive. Format is YYYY-MM-DD | [optional]
|
|
128
|
-
**include** | **String**| <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p> | [optional]
|
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
|
129
56
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
[**PayorAmlTransactionV4**](PayorAmlTransactionV4.md)
|
|
133
|
-
|
|
134
|
-
### Authorization
|
|
135
|
-
|
|
136
|
-
[OAuth2](../README.md#OAuth2)
|
|
137
|
-
|
|
138
|
-
### HTTP request headers
|
|
139
|
-
|
|
140
|
-
- **Content-Type**: Not defined
|
|
141
|
-
- **Accept**: application/csv
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
## get_fundings_v1
|
|
145
|
-
|
|
146
|
-
> GetFundingsResponse get_fundings_v1(payor_id, opts)
|
|
147
|
-
|
|
148
|
-
Get Fundings for Payor
|
|
149
|
-
|
|
150
|
-
<p>Get a list of Fundings for a payor.</p> <p>Deprecated (use v4/paymentaudit/fundings)</p>
|
|
151
|
-
|
|
152
|
-
### Example
|
|
57
|
+
> <Array(<PayorAmlTransaction>, Integer, Hash)> export_transactions_csvv4_with_http_info(opts)
|
|
153
58
|
|
|
154
59
|
```ruby
|
|
155
|
-
# load the gem
|
|
156
|
-
require 'velopayments'
|
|
157
|
-
# setup authorization
|
|
158
|
-
VeloPayments.configure do |config|
|
|
159
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
160
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
161
|
-
end
|
|
162
|
-
|
|
163
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
164
|
-
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
|
165
|
-
opts = {
|
|
166
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
167
|
-
page_size: 25, # Integer | The number of results to return in a page
|
|
168
|
-
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.
|
|
169
|
-
}
|
|
170
|
-
|
|
171
60
|
begin
|
|
172
|
-
#
|
|
173
|
-
|
|
174
|
-
p
|
|
61
|
+
# Export Transactions
|
|
62
|
+
data, status_code, headers = api_instance.export_transactions_csvv4_with_http_info(opts)
|
|
63
|
+
p status_code # => 2xx
|
|
64
|
+
p headers # => { ... }
|
|
65
|
+
p data # => <PayorAmlTransaction>
|
|
175
66
|
rescue VeloPayments::ApiError => e
|
|
176
|
-
puts "
|
|
67
|
+
puts "Error when calling PaymentAuditServiceApi->export_transactions_csvv4_with_http_info: #{e}"
|
|
177
68
|
end
|
|
178
69
|
```
|
|
179
70
|
|
|
180
71
|
### Parameters
|
|
181
72
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
**
|
|
186
|
-
**
|
|
187
|
-
**
|
|
188
|
-
**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]
|
|
73
|
+
| Name | Type | Description | Notes |
|
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
|
75
|
+
| **payor_id** | [**String**](.md) | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p> | [optional] |
|
|
76
|
+
| **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
|
|
77
|
+
| **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
|
|
78
|
+
| **include** | **String** | <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p> | [optional] |
|
|
189
79
|
|
|
190
80
|
### Return type
|
|
191
81
|
|
|
192
|
-
[**
|
|
82
|
+
[**PayorAmlTransaction**](PayorAmlTransaction.md)
|
|
193
83
|
|
|
194
84
|
### Authorization
|
|
195
85
|
|
|
@@ -198,21 +88,21 @@ Name | Type | Description | Notes
|
|
|
198
88
|
### HTTP request headers
|
|
199
89
|
|
|
200
90
|
- **Content-Type**: Not defined
|
|
201
|
-
- **Accept**: application/
|
|
91
|
+
- **Accept**: application/csv
|
|
202
92
|
|
|
203
93
|
|
|
204
94
|
## get_fundings_v4
|
|
205
95
|
|
|
206
|
-
> GetFundingsResponse get_fundings_v4(payor_id, opts)
|
|
96
|
+
> <GetFundingsResponse> get_fundings_v4(payor_id, opts)
|
|
207
97
|
|
|
208
98
|
Get Fundings for Payor
|
|
209
99
|
|
|
210
100
|
<p>Get a list of Fundings for a payor.</p>
|
|
211
101
|
|
|
212
|
-
###
|
|
102
|
+
### Examples
|
|
213
103
|
|
|
214
104
|
```ruby
|
|
215
|
-
|
|
105
|
+
require 'time'
|
|
216
106
|
require 'velopayments'
|
|
217
107
|
# setup authorization
|
|
218
108
|
VeloPayments.configure do |config|
|
|
@@ -221,91 +111,52 @@ VeloPayments.configure do |config|
|
|
|
221
111
|
end
|
|
222
112
|
|
|
223
113
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
224
|
-
payor_id =
|
|
114
|
+
payor_id = TODO # String | The account owner Payor ID
|
|
225
115
|
opts = {
|
|
226
|
-
page:
|
|
227
|
-
page_size:
|
|
116
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
117
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
228
118
|
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.
|
|
229
119
|
}
|
|
230
120
|
|
|
231
121
|
begin
|
|
232
|
-
#Get Fundings for Payor
|
|
122
|
+
# Get Fundings for Payor
|
|
233
123
|
result = api_instance.get_fundings_v4(payor_id, opts)
|
|
234
124
|
p result
|
|
235
125
|
rescue VeloPayments::ApiError => e
|
|
236
|
-
puts "
|
|
126
|
+
puts "Error when calling PaymentAuditServiceApi->get_fundings_v4: #{e}"
|
|
237
127
|
end
|
|
238
128
|
```
|
|
239
129
|
|
|
240
|
-
|
|
241
|
-
|
|
130
|
+
#### Using the get_fundings_v4_with_http_info variant
|
|
242
131
|
|
|
243
|
-
|
|
244
|
-
------------- | ------------- | ------------- | -------------
|
|
245
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
|
246
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
247
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
248
|
-
**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]
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
249
133
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
[**GetFundingsResponse**](GetFundingsResponse.md)
|
|
253
|
-
|
|
254
|
-
### Authorization
|
|
255
|
-
|
|
256
|
-
[OAuth2](../README.md#OAuth2)
|
|
257
|
-
|
|
258
|
-
### HTTP request headers
|
|
259
|
-
|
|
260
|
-
- **Content-Type**: Not defined
|
|
261
|
-
- **Accept**: application/json
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
## get_payment_details
|
|
265
|
-
|
|
266
|
-
> PaymentResponseV3 get_payment_details(payment_id, opts)
|
|
267
|
-
|
|
268
|
-
Get Payment
|
|
269
|
-
|
|
270
|
-
Get the payment with the given id. This contains the payment history.
|
|
271
|
-
|
|
272
|
-
### Example
|
|
134
|
+
> <Array(<GetFundingsResponse>, Integer, Hash)> get_fundings_v4_with_http_info(payor_id, opts)
|
|
273
135
|
|
|
274
136
|
```ruby
|
|
275
|
-
# load the gem
|
|
276
|
-
require 'velopayments'
|
|
277
|
-
# setup authorization
|
|
278
|
-
VeloPayments.configure do |config|
|
|
279
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
280
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
281
|
-
end
|
|
282
|
-
|
|
283
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
284
|
-
payment_id = 'payment_id_example' # String | Payment Id
|
|
285
|
-
opts = {
|
|
286
|
-
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.
|
|
287
|
-
}
|
|
288
|
-
|
|
289
137
|
begin
|
|
290
|
-
#Get
|
|
291
|
-
|
|
292
|
-
p
|
|
138
|
+
# Get Fundings for Payor
|
|
139
|
+
data, status_code, headers = api_instance.get_fundings_v4_with_http_info(payor_id, opts)
|
|
140
|
+
p status_code # => 2xx
|
|
141
|
+
p headers # => { ... }
|
|
142
|
+
p data # => <GetFundingsResponse>
|
|
293
143
|
rescue VeloPayments::ApiError => e
|
|
294
|
-
puts "
|
|
144
|
+
puts "Error when calling PaymentAuditServiceApi->get_fundings_v4_with_http_info: #{e}"
|
|
295
145
|
end
|
|
296
146
|
```
|
|
297
147
|
|
|
298
148
|
### Parameters
|
|
299
149
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
**
|
|
304
|
-
**
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
|
152
|
+
| **payor_id** | [**String**](.md) | The account owner Payor ID | |
|
|
153
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
154
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
155
|
+
| **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] |
|
|
305
156
|
|
|
306
157
|
### Return type
|
|
307
158
|
|
|
308
|
-
[**
|
|
159
|
+
[**GetFundingsResponse**](GetFundingsResponse.md)
|
|
309
160
|
|
|
310
161
|
### Authorization
|
|
311
162
|
|
|
@@ -319,16 +170,16 @@ Name | Type | Description | Notes
|
|
|
319
170
|
|
|
320
171
|
## get_payment_details_v4
|
|
321
172
|
|
|
322
|
-
> PaymentResponseV4 get_payment_details_v4(payment_id, opts)
|
|
173
|
+
> <PaymentResponseV4> get_payment_details_v4(payment_id, opts)
|
|
323
174
|
|
|
324
175
|
Get Payment
|
|
325
176
|
|
|
326
177
|
Get the payment with the given id. This contains the payment history.
|
|
327
178
|
|
|
328
|
-
###
|
|
179
|
+
### Examples
|
|
329
180
|
|
|
330
181
|
```ruby
|
|
331
|
-
|
|
182
|
+
require 'time'
|
|
332
183
|
require 'velopayments'
|
|
333
184
|
# setup authorization
|
|
334
185
|
VeloPayments.configure do |config|
|
|
@@ -337,109 +188,48 @@ VeloPayments.configure do |config|
|
|
|
337
188
|
end
|
|
338
189
|
|
|
339
190
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
340
|
-
payment_id =
|
|
191
|
+
payment_id = TODO # String | Payment Id
|
|
341
192
|
opts = {
|
|
342
193
|
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.
|
|
343
194
|
}
|
|
344
195
|
|
|
345
196
|
begin
|
|
346
|
-
#Get Payment
|
|
197
|
+
# Get Payment
|
|
347
198
|
result = api_instance.get_payment_details_v4(payment_id, opts)
|
|
348
199
|
p result
|
|
349
200
|
rescue VeloPayments::ApiError => e
|
|
350
|
-
puts "
|
|
201
|
+
puts "Error when calling PaymentAuditServiceApi->get_payment_details_v4: #{e}"
|
|
351
202
|
end
|
|
352
203
|
```
|
|
353
204
|
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
Name | Type | Description | Notes
|
|
358
|
-
------------- | ------------- | ------------- | -------------
|
|
359
|
-
**payment_id** | [**String**](.md)| Payment Id |
|
|
360
|
-
**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]
|
|
361
|
-
|
|
362
|
-
### Return type
|
|
205
|
+
#### Using the get_payment_details_v4_with_http_info variant
|
|
363
206
|
|
|
364
|
-
|
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
|
365
208
|
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
[OAuth2](../README.md#OAuth2)
|
|
369
|
-
|
|
370
|
-
### HTTP request headers
|
|
371
|
-
|
|
372
|
-
- **Content-Type**: Not defined
|
|
373
|
-
- **Accept**: application/json
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
## get_payments_for_payout
|
|
377
|
-
|
|
378
|
-
> GetPaymentsForPayoutResponseV3 get_payments_for_payout(payout_id, opts)
|
|
379
|
-
|
|
380
|
-
Get Payments for Payout
|
|
381
|
-
|
|
382
|
-
Get List of payments for Payout
|
|
383
|
-
|
|
384
|
-
### Example
|
|
209
|
+
> <Array(<PaymentResponseV4>, Integer, Hash)> get_payment_details_v4_with_http_info(payment_id, opts)
|
|
385
210
|
|
|
386
211
|
```ruby
|
|
387
|
-
# load the gem
|
|
388
|
-
require 'velopayments'
|
|
389
|
-
# setup authorization
|
|
390
|
-
VeloPayments.configure do |config|
|
|
391
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
392
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
393
|
-
end
|
|
394
|
-
|
|
395
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
396
|
-
payout_id = 'payout_id_example' # String | The id (UUID) of the payout.
|
|
397
|
-
opts = {
|
|
398
|
-
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
399
|
-
status: 'status_example', # String | Payment Status
|
|
400
|
-
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
401
|
-
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
402
|
-
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
403
|
-
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
404
|
-
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
405
|
-
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
406
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
407
|
-
page_size: 25, # Integer | The number of results to return in a page
|
|
408
|
-
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>
|
|
409
|
-
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.
|
|
410
|
-
}
|
|
411
|
-
|
|
412
212
|
begin
|
|
413
|
-
#Get
|
|
414
|
-
|
|
415
|
-
p
|
|
213
|
+
# Get Payment
|
|
214
|
+
data, status_code, headers = api_instance.get_payment_details_v4_with_http_info(payment_id, opts)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => <PaymentResponseV4>
|
|
416
218
|
rescue VeloPayments::ApiError => e
|
|
417
|
-
puts "
|
|
219
|
+
puts "Error when calling PaymentAuditServiceApi->get_payment_details_v4_with_http_info: #{e}"
|
|
418
220
|
end
|
|
419
221
|
```
|
|
420
222
|
|
|
421
223
|
### Parameters
|
|
422
224
|
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
**
|
|
427
|
-
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
428
|
-
**status** | **String**| Payment Status | [optional]
|
|
429
|
-
**source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional]
|
|
430
|
-
**source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional]
|
|
431
|
-
**payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional]
|
|
432
|
-
**payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional]
|
|
433
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
434
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
435
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
436
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
437
|
-
**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]
|
|
438
|
-
**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]
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **payment_id** | [**String**](.md) | Payment Id | |
|
|
228
|
+
| **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] |
|
|
439
229
|
|
|
440
230
|
### Return type
|
|
441
231
|
|
|
442
|
-
[**
|
|
232
|
+
[**PaymentResponseV4**](PaymentResponseV4.md)
|
|
443
233
|
|
|
444
234
|
### Authorization
|
|
445
235
|
|
|
@@ -453,16 +243,16 @@ Name | Type | Description | Notes
|
|
|
453
243
|
|
|
454
244
|
## get_payments_for_payout_v4
|
|
455
245
|
|
|
456
|
-
> GetPaymentsForPayoutResponseV4 get_payments_for_payout_v4(payout_id, opts)
|
|
246
|
+
> <GetPaymentsForPayoutResponseV4> get_payments_for_payout_v4(payout_id, opts)
|
|
457
247
|
|
|
458
248
|
Get Payments for Payout
|
|
459
249
|
|
|
460
250
|
Get List of payments for Payout, allowing for RETURNED status
|
|
461
251
|
|
|
462
|
-
###
|
|
252
|
+
### Examples
|
|
463
253
|
|
|
464
254
|
```ruby
|
|
465
|
-
|
|
255
|
+
require 'time'
|
|
466
256
|
require 'velopayments'
|
|
467
257
|
# setup authorization
|
|
468
258
|
VeloPayments.configure do |config|
|
|
@@ -471,107 +261,74 @@ VeloPayments.configure do |config|
|
|
|
471
261
|
end
|
|
472
262
|
|
|
473
263
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
474
|
-
payout_id =
|
|
264
|
+
payout_id = TODO # String | The id (UUID) of the payout.
|
|
475
265
|
opts = {
|
|
476
266
|
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
477
|
-
|
|
267
|
+
remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
|
|
268
|
+
status: 'ACCEPTED', # String | Payment Status
|
|
478
269
|
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
479
270
|
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
480
271
|
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
481
272
|
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
482
273
|
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
483
274
|
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
484
|
-
|
|
485
|
-
|
|
275
|
+
transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
276
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
277
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
486
278
|
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
|
|
487
279
|
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.
|
|
488
280
|
}
|
|
489
281
|
|
|
490
282
|
begin
|
|
491
|
-
#Get Payments for Payout
|
|
283
|
+
# Get Payments for Payout
|
|
492
284
|
result = api_instance.get_payments_for_payout_v4(payout_id, opts)
|
|
493
285
|
p result
|
|
494
286
|
rescue VeloPayments::ApiError => e
|
|
495
|
-
puts "
|
|
287
|
+
puts "Error when calling PaymentAuditServiceApi->get_payments_for_payout_v4: #{e}"
|
|
496
288
|
end
|
|
497
289
|
```
|
|
498
290
|
|
|
499
|
-
|
|
500
|
-
|
|
291
|
+
#### Using the get_payments_for_payout_v4_with_http_info variant
|
|
501
292
|
|
|
502
|
-
|
|
503
|
-
------------- | ------------- | ------------- | -------------
|
|
504
|
-
**payout_id** | [**String**](.md)| The id (UUID) of the payout. |
|
|
505
|
-
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
506
|
-
**status** | **String**| Payment Status | [optional]
|
|
507
|
-
**source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional]
|
|
508
|
-
**source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional]
|
|
509
|
-
**payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional]
|
|
510
|
-
**payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional]
|
|
511
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
512
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
513
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
514
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
515
|
-
**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]
|
|
516
|
-
**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]
|
|
293
|
+
This returns an Array which contains the response data, status code and headers.
|
|
517
294
|
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
[**GetPaymentsForPayoutResponseV4**](GetPaymentsForPayoutResponseV4.md)
|
|
521
|
-
|
|
522
|
-
### Authorization
|
|
523
|
-
|
|
524
|
-
[OAuth2](../README.md#OAuth2)
|
|
525
|
-
|
|
526
|
-
### HTTP request headers
|
|
527
|
-
|
|
528
|
-
- **Content-Type**: Not defined
|
|
529
|
-
- **Accept**: application/json
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
## get_payout_stats_v1
|
|
533
|
-
|
|
534
|
-
> GetPayoutStatistics get_payout_stats_v1(opts)
|
|
535
|
-
|
|
536
|
-
Get Payout Statistics
|
|
537
|
-
|
|
538
|
-
<p>Get payout statistics for a payor.</p> <p>Deprecated (Use /v4/paymentaudit/payoutStatistics)</p>
|
|
539
|
-
|
|
540
|
-
### Example
|
|
295
|
+
> <Array(<GetPaymentsForPayoutResponseV4>, Integer, Hash)> get_payments_for_payout_v4_with_http_info(payout_id, opts)
|
|
541
296
|
|
|
542
297
|
```ruby
|
|
543
|
-
# load the gem
|
|
544
|
-
require 'velopayments'
|
|
545
|
-
# setup authorization
|
|
546
|
-
VeloPayments.configure do |config|
|
|
547
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
548
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
549
|
-
end
|
|
550
|
-
|
|
551
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
552
|
-
opts = {
|
|
553
|
-
payor_id: 'payor_id_example' # String | The account owner Payor ID. Required for external users.
|
|
554
|
-
}
|
|
555
|
-
|
|
556
298
|
begin
|
|
557
|
-
#Get Payout
|
|
558
|
-
|
|
559
|
-
p
|
|
299
|
+
# Get Payments for Payout
|
|
300
|
+
data, status_code, headers = api_instance.get_payments_for_payout_v4_with_http_info(payout_id, opts)
|
|
301
|
+
p status_code # => 2xx
|
|
302
|
+
p headers # => { ... }
|
|
303
|
+
p data # => <GetPaymentsForPayoutResponseV4>
|
|
560
304
|
rescue VeloPayments::ApiError => e
|
|
561
|
-
puts "
|
|
305
|
+
puts "Error when calling PaymentAuditServiceApi->get_payments_for_payout_v4_with_http_info: #{e}"
|
|
562
306
|
end
|
|
563
307
|
```
|
|
564
308
|
|
|
565
309
|
### Parameters
|
|
566
310
|
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
**
|
|
311
|
+
| Name | Type | Description | Notes |
|
|
312
|
+
| ---- | ---- | ----------- | ----- |
|
|
313
|
+
| **payout_id** | [**String**](.md) | The id (UUID) of the payout. | |
|
|
314
|
+
| **remote_id** | **String** | The remote id of the payees. | [optional] |
|
|
315
|
+
| **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
|
|
316
|
+
| **status** | **String** | Payment Status | [optional] |
|
|
317
|
+
| **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] |
|
|
318
|
+
| **source_amount_to** | **Integer** | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] |
|
|
319
|
+
| **payment_amount_from** | **Integer** | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] |
|
|
320
|
+
| **payment_amount_to** | **Integer** | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] |
|
|
321
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
|
322
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
|
323
|
+
| **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE | [optional] |
|
|
324
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
325
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
326
|
+
| **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] |
|
|
327
|
+
| **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] |
|
|
571
328
|
|
|
572
329
|
### Return type
|
|
573
330
|
|
|
574
|
-
[**
|
|
331
|
+
[**GetPaymentsForPayoutResponseV4**](GetPaymentsForPayoutResponseV4.md)
|
|
575
332
|
|
|
576
333
|
### Authorization
|
|
577
334
|
|
|
@@ -585,16 +342,16 @@ Name | Type | Description | Notes
|
|
|
585
342
|
|
|
586
343
|
## get_payout_stats_v4
|
|
587
344
|
|
|
588
|
-
> GetPayoutStatistics get_payout_stats_v4(opts)
|
|
345
|
+
> <GetPayoutStatistics> get_payout_stats_v4(opts)
|
|
589
346
|
|
|
590
347
|
Get Payout Statistics
|
|
591
348
|
|
|
592
349
|
<p>Get payout statistics for a payor.</p>
|
|
593
350
|
|
|
594
|
-
###
|
|
351
|
+
### Examples
|
|
595
352
|
|
|
596
353
|
```ruby
|
|
597
|
-
|
|
354
|
+
require 'time'
|
|
598
355
|
require 'velopayments'
|
|
599
356
|
# setup authorization
|
|
600
357
|
VeloPayments.configure do |config|
|
|
@@ -604,96 +361,45 @@ end
|
|
|
604
361
|
|
|
605
362
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
606
363
|
opts = {
|
|
607
|
-
payor_id:
|
|
364
|
+
payor_id: TODO # String | The account owner Payor ID. Required for external users.
|
|
608
365
|
}
|
|
609
366
|
|
|
610
367
|
begin
|
|
611
|
-
#Get Payout Statistics
|
|
368
|
+
# Get Payout Statistics
|
|
612
369
|
result = api_instance.get_payout_stats_v4(opts)
|
|
613
370
|
p result
|
|
614
371
|
rescue VeloPayments::ApiError => e
|
|
615
|
-
puts "
|
|
372
|
+
puts "Error when calling PaymentAuditServiceApi->get_payout_stats_v4: #{e}"
|
|
616
373
|
end
|
|
617
374
|
```
|
|
618
375
|
|
|
619
|
-
|
|
620
|
-
|
|
376
|
+
#### Using the get_payout_stats_v4_with_http_info variant
|
|
621
377
|
|
|
622
|
-
|
|
623
|
-
------------- | ------------- | ------------- | -------------
|
|
624
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID. Required for external users. | [optional]
|
|
378
|
+
This returns an Array which contains the response data, status code and headers.
|
|
625
379
|
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
[**GetPayoutStatistics**](GetPayoutStatistics.md)
|
|
629
|
-
|
|
630
|
-
### Authorization
|
|
631
|
-
|
|
632
|
-
[OAuth2](../README.md#OAuth2)
|
|
633
|
-
|
|
634
|
-
### HTTP request headers
|
|
635
|
-
|
|
636
|
-
- **Content-Type**: Not defined
|
|
637
|
-
- **Accept**: application/json
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
## get_payouts_for_payor_v3
|
|
641
|
-
|
|
642
|
-
> GetPayoutsResponseV3 get_payouts_for_payor_v3(payor_id, opts)
|
|
643
|
-
|
|
644
|
-
Get Payouts for Payor
|
|
645
|
-
|
|
646
|
-
<p>Get List of payouts for payor</p> <p>Deprecated Use v4</p>
|
|
647
|
-
|
|
648
|
-
### Example
|
|
380
|
+
> <Array(<GetPayoutStatistics>, Integer, Hash)> get_payout_stats_v4_with_http_info(opts)
|
|
649
381
|
|
|
650
382
|
```ruby
|
|
651
|
-
# load the gem
|
|
652
|
-
require 'velopayments'
|
|
653
|
-
# setup authorization
|
|
654
|
-
VeloPayments.configure do |config|
|
|
655
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
656
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
657
|
-
end
|
|
658
|
-
|
|
659
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
660
|
-
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
|
661
|
-
opts = {
|
|
662
|
-
payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
|
|
663
|
-
status: 'status_example', # String | Payout Status
|
|
664
|
-
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
665
|
-
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
666
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
667
|
-
page_size: 25, # Integer | The number of results to return in a page
|
|
668
|
-
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.
|
|
669
|
-
}
|
|
670
|
-
|
|
671
383
|
begin
|
|
672
|
-
#Get
|
|
673
|
-
|
|
674
|
-
p
|
|
384
|
+
# Get Payout Statistics
|
|
385
|
+
data, status_code, headers = api_instance.get_payout_stats_v4_with_http_info(opts)
|
|
386
|
+
p status_code # => 2xx
|
|
387
|
+
p headers # => { ... }
|
|
388
|
+
p data # => <GetPayoutStatistics>
|
|
675
389
|
rescue VeloPayments::ApiError => e
|
|
676
|
-
puts "
|
|
390
|
+
puts "Error when calling PaymentAuditServiceApi->get_payout_stats_v4_with_http_info: #{e}"
|
|
677
391
|
end
|
|
678
392
|
```
|
|
679
393
|
|
|
680
394
|
### Parameters
|
|
681
395
|
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
|
686
|
-
**payout_memo** | **String**| Payout Memo filter - case insensitive sub-string match | [optional]
|
|
687
|
-
**status** | **String**| Payout Status | [optional]
|
|
688
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
689
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
690
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
691
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
692
|
-
**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]
|
|
396
|
+
| Name | Type | Description | Notes |
|
|
397
|
+
| ---- | ---- | ----------- | ----- |
|
|
398
|
+
| **payor_id** | [**String**](.md) | The account owner Payor ID. Required for external users. | [optional] |
|
|
693
399
|
|
|
694
400
|
### Return type
|
|
695
401
|
|
|
696
|
-
[**
|
|
402
|
+
[**GetPayoutStatistics**](GetPayoutStatistics.md)
|
|
697
403
|
|
|
698
404
|
### Authorization
|
|
699
405
|
|
|
@@ -707,16 +413,16 @@ Name | Type | Description | Notes
|
|
|
707
413
|
|
|
708
414
|
## get_payouts_for_payor_v4
|
|
709
415
|
|
|
710
|
-
>
|
|
416
|
+
> <GetPayoutsResponse> get_payouts_for_payor_v4(opts)
|
|
711
417
|
|
|
712
418
|
Get Payouts for Payor
|
|
713
419
|
|
|
714
420
|
Get List of payouts for payor
|
|
715
421
|
|
|
716
|
-
###
|
|
422
|
+
### Examples
|
|
717
423
|
|
|
718
424
|
```ruby
|
|
719
|
-
|
|
425
|
+
require 'time'
|
|
720
426
|
require 'velopayments'
|
|
721
427
|
# setup authorization
|
|
722
428
|
VeloPayments.configure do |config|
|
|
@@ -726,104 +432,61 @@ end
|
|
|
726
432
|
|
|
727
433
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
728
434
|
opts = {
|
|
729
|
-
payor_id:
|
|
435
|
+
payor_id: TODO, # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
|
|
730
436
|
payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
|
|
731
|
-
status: '
|
|
437
|
+
status: 'ACCEPTED', # String | Payout Status
|
|
732
438
|
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
733
439
|
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
734
440
|
from_payor_name: 'from_payor_name_example', # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
|
|
735
|
-
page:
|
|
736
|
-
page_size:
|
|
441
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
442
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
737
443
|
sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
|
|
738
444
|
}
|
|
739
445
|
|
|
740
446
|
begin
|
|
741
|
-
#Get Payouts for Payor
|
|
447
|
+
# Get Payouts for Payor
|
|
742
448
|
result = api_instance.get_payouts_for_payor_v4(opts)
|
|
743
449
|
p result
|
|
744
450
|
rescue VeloPayments::ApiError => e
|
|
745
|
-
puts "
|
|
451
|
+
puts "Error when calling PaymentAuditServiceApi->get_payouts_for_payor_v4: #{e}"
|
|
746
452
|
end
|
|
747
453
|
```
|
|
748
454
|
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
Name | Type | Description | Notes
|
|
753
|
-
------------- | ------------- | ------------- | -------------
|
|
754
|
-
**payor_id** | [**String**](.md)| The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional]
|
|
755
|
-
**payout_memo** | **String**| Payout Memo filter - case insensitive sub-string match | [optional]
|
|
756
|
-
**status** | **String**| Payout Status | [optional]
|
|
757
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
758
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
759
|
-
**from_payor_name** | **String**| The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional]
|
|
760
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
761
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
762
|
-
**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, totalPayments, payoutId | [optional]
|
|
763
|
-
|
|
764
|
-
### Return type
|
|
765
|
-
|
|
766
|
-
[**GetPayoutsResponseV4**](GetPayoutsResponseV4.md)
|
|
767
|
-
|
|
768
|
-
### Authorization
|
|
769
|
-
|
|
770
|
-
[OAuth2](../README.md#OAuth2)
|
|
771
|
-
|
|
772
|
-
### HTTP request headers
|
|
773
|
-
|
|
774
|
-
- **Content-Type**: Not defined
|
|
775
|
-
- **Accept**: application/json
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
## list_payment_changes
|
|
455
|
+
#### Using the get_payouts_for_payor_v4_with_http_info variant
|
|
779
456
|
|
|
780
|
-
|
|
457
|
+
This returns an Array which contains the response data, status code and headers.
|
|
781
458
|
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
Get a paginated response listing payment changes.
|
|
785
|
-
|
|
786
|
-
### Example
|
|
459
|
+
> <Array(<GetPayoutsResponse>, Integer, Hash)> get_payouts_for_payor_v4_with_http_info(opts)
|
|
787
460
|
|
|
788
461
|
```ruby
|
|
789
|
-
# load the gem
|
|
790
|
-
require 'velopayments'
|
|
791
|
-
# setup authorization
|
|
792
|
-
VeloPayments.configure do |config|
|
|
793
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
794
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
795
|
-
end
|
|
796
|
-
|
|
797
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
798
|
-
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payments
|
|
799
|
-
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
|
|
800
|
-
opts = {
|
|
801
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
802
|
-
page_size: 100 # Integer | The number of results to return in a page
|
|
803
|
-
}
|
|
804
|
-
|
|
805
462
|
begin
|
|
806
|
-
#
|
|
807
|
-
|
|
808
|
-
p
|
|
463
|
+
# Get Payouts for Payor
|
|
464
|
+
data, status_code, headers = api_instance.get_payouts_for_payor_v4_with_http_info(opts)
|
|
465
|
+
p status_code # => 2xx
|
|
466
|
+
p headers # => { ... }
|
|
467
|
+
p data # => <GetPayoutsResponse>
|
|
809
468
|
rescue VeloPayments::ApiError => e
|
|
810
|
-
puts "
|
|
469
|
+
puts "Error when calling PaymentAuditServiceApi->get_payouts_for_payor_v4_with_http_info: #{e}"
|
|
811
470
|
end
|
|
812
471
|
```
|
|
813
472
|
|
|
814
473
|
### Parameters
|
|
815
474
|
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
**
|
|
820
|
-
**
|
|
821
|
-
**
|
|
822
|
-
**
|
|
475
|
+
| Name | Type | Description | Notes |
|
|
476
|
+
| ---- | ---- | ----------- | ----- |
|
|
477
|
+
| **payor_id** | [**String**](.md) | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] |
|
|
478
|
+
| **payout_memo** | **String** | Payout Memo filter - case insensitive sub-string match | [optional] |
|
|
479
|
+
| **status** | **String** | Payout Status | [optional] |
|
|
480
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
|
481
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
|
482
|
+
| **from_payor_name** | **String** | The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional] |
|
|
483
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
484
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
485
|
+
| **sort** | **String** | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId | [optional] |
|
|
823
486
|
|
|
824
487
|
### Return type
|
|
825
488
|
|
|
826
|
-
[**
|
|
489
|
+
[**GetPayoutsResponse**](GetPayoutsResponse.md)
|
|
827
490
|
|
|
828
491
|
### Authorization
|
|
829
492
|
|
|
@@ -837,16 +500,16 @@ Name | Type | Description | Notes
|
|
|
837
500
|
|
|
838
501
|
## list_payment_changes_v4
|
|
839
502
|
|
|
840
|
-
>
|
|
503
|
+
> <PaymentDeltaResponse> list_payment_changes_v4(payor_id, updated_since, opts)
|
|
841
504
|
|
|
842
505
|
List Payment Changes
|
|
843
506
|
|
|
844
507
|
Get a paginated response listing payment changes.
|
|
845
508
|
|
|
846
|
-
###
|
|
509
|
+
### Examples
|
|
847
510
|
|
|
848
511
|
```ruby
|
|
849
|
-
|
|
512
|
+
require 'time'
|
|
850
513
|
require 'velopayments'
|
|
851
514
|
# setup authorization
|
|
852
515
|
VeloPayments.configure do |config|
|
|
@@ -855,125 +518,52 @@ VeloPayments.configure do |config|
|
|
|
855
518
|
end
|
|
856
519
|
|
|
857
520
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
858
|
-
payor_id =
|
|
521
|
+
payor_id = TODO # String | The Payor ID to find associated Payments
|
|
859
522
|
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
|
|
860
523
|
opts = {
|
|
861
|
-
page:
|
|
862
|
-
page_size:
|
|
524
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
525
|
+
page_size: 56 # Integer | The number of results to return in a page
|
|
863
526
|
}
|
|
864
527
|
|
|
865
528
|
begin
|
|
866
|
-
#List Payment Changes
|
|
529
|
+
# List Payment Changes
|
|
867
530
|
result = api_instance.list_payment_changes_v4(payor_id, updated_since, opts)
|
|
868
531
|
p result
|
|
869
532
|
rescue VeloPayments::ApiError => e
|
|
870
|
-
puts "
|
|
533
|
+
puts "Error when calling PaymentAuditServiceApi->list_payment_changes_v4: #{e}"
|
|
871
534
|
end
|
|
872
535
|
```
|
|
873
536
|
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
Name | Type | Description | Notes
|
|
878
|
-
------------- | ------------- | ------------- | -------------
|
|
879
|
-
**payor_id** | [**String**](.md)| The Payor ID to find associated Payments |
|
|
880
|
-
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
|
881
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
882
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 100]
|
|
883
|
-
|
|
884
|
-
### Return type
|
|
885
|
-
|
|
886
|
-
[**PaymentDeltaResponseV4**](PaymentDeltaResponseV4.md)
|
|
887
|
-
|
|
888
|
-
### Authorization
|
|
889
|
-
|
|
890
|
-
[OAuth2](../README.md#OAuth2)
|
|
891
|
-
|
|
892
|
-
### HTTP request headers
|
|
893
|
-
|
|
894
|
-
- **Content-Type**: Not defined
|
|
895
|
-
- **Accept**: application/json
|
|
896
|
-
|
|
537
|
+
#### Using the list_payment_changes_v4_with_http_info variant
|
|
897
538
|
|
|
898
|
-
|
|
539
|
+
This returns an Array which contains the response data, status code and headers.
|
|
899
540
|
|
|
900
|
-
>
|
|
901
|
-
|
|
902
|
-
Get List of Payments
|
|
903
|
-
|
|
904
|
-
Get payments for the given payor Id
|
|
905
|
-
|
|
906
|
-
### Example
|
|
541
|
+
> <Array(<PaymentDeltaResponse>, Integer, Hash)> list_payment_changes_v4_with_http_info(payor_id, updated_since, opts)
|
|
907
542
|
|
|
908
543
|
```ruby
|
|
909
|
-
# load the gem
|
|
910
|
-
require 'velopayments'
|
|
911
|
-
# setup authorization
|
|
912
|
-
VeloPayments.configure do |config|
|
|
913
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
914
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
915
|
-
end
|
|
916
|
-
|
|
917
|
-
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
918
|
-
opts = {
|
|
919
|
-
payee_id: 'payee_id_example', # String | The UUID of the payee.
|
|
920
|
-
payor_id: 'payor_id_example', # String | The account owner Payor Id. Required for external users.
|
|
921
|
-
payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
|
|
922
|
-
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
923
|
-
status: 'status_example', # String | Payment Status
|
|
924
|
-
source_account_name: 'source_account_name_example', # String | The source account name filter. This filters via a case insensitive substring match.
|
|
925
|
-
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
926
|
-
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
927
|
-
source_currency: 'source_currency_example', # String | The source currency filter. Filters based on an exact match on the currency.
|
|
928
|
-
payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
929
|
-
payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
930
|
-
payment_currency: 'payment_currency_example', # String | The payment currency filter. Filters based on an exact match on the currency.
|
|
931
|
-
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
932
|
-
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
933
|
-
payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
|
|
934
|
-
page: 1, # Integer | Page number. Default is 1.
|
|
935
|
-
page_size: 25, # Integer | The number of results to return in a page
|
|
936
|
-
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
|
|
937
|
-
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.
|
|
938
|
-
}
|
|
939
|
-
|
|
940
544
|
begin
|
|
941
|
-
#
|
|
942
|
-
|
|
943
|
-
p
|
|
545
|
+
# List Payment Changes
|
|
546
|
+
data, status_code, headers = api_instance.list_payment_changes_v4_with_http_info(payor_id, updated_since, opts)
|
|
547
|
+
p status_code # => 2xx
|
|
548
|
+
p headers # => { ... }
|
|
549
|
+
p data # => <PaymentDeltaResponse>
|
|
944
550
|
rescue VeloPayments::ApiError => e
|
|
945
|
-
puts "
|
|
551
|
+
puts "Error when calling PaymentAuditServiceApi->list_payment_changes_v4_with_http_info: #{e}"
|
|
946
552
|
end
|
|
947
553
|
```
|
|
948
554
|
|
|
949
555
|
### Parameters
|
|
950
556
|
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
**
|
|
955
|
-
**
|
|
956
|
-
**
|
|
957
|
-
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
958
|
-
**status** | **String**| Payment Status | [optional]
|
|
959
|
-
**source_account_name** | **String**| The source account name filter. This filters via a case insensitive substring match. | [optional]
|
|
960
|
-
**source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional]
|
|
961
|
-
**source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional]
|
|
962
|
-
**source_currency** | **String**| The source currency filter. Filters based on an exact match on the currency. | [optional]
|
|
963
|
-
**payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional]
|
|
964
|
-
**payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional]
|
|
965
|
-
**payment_currency** | **String**| The payment currency filter. Filters based on an exact match on the currency. | [optional]
|
|
966
|
-
**submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional]
|
|
967
|
-
**submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional]
|
|
968
|
-
**payment_memo** | **String**| The payment memo filter. This filters via a case insensitive substring match. | [optional]
|
|
969
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
970
|
-
**page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
|
|
971
|
-
**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]
|
|
972
|
-
**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]
|
|
557
|
+
| Name | Type | Description | Notes |
|
|
558
|
+
| ---- | ---- | ----------- | ----- |
|
|
559
|
+
| **payor_id** | [**String**](.md) | The Payor ID to find associated Payments | |
|
|
560
|
+
| **updated_since** | **Time** | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | |
|
|
561
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
562
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 100] |
|
|
973
563
|
|
|
974
564
|
### Return type
|
|
975
565
|
|
|
976
|
-
[**
|
|
566
|
+
[**PaymentDeltaResponse**](PaymentDeltaResponse.md)
|
|
977
567
|
|
|
978
568
|
### Authorization
|
|
979
569
|
|
|
@@ -987,16 +577,16 @@ Name | Type | Description | Notes
|
|
|
987
577
|
|
|
988
578
|
## list_payments_audit_v4
|
|
989
579
|
|
|
990
|
-
> ListPaymentsResponseV4 list_payments_audit_v4(opts)
|
|
580
|
+
> <ListPaymentsResponseV4> list_payments_audit_v4(opts)
|
|
991
581
|
|
|
992
582
|
Get List of Payments
|
|
993
583
|
|
|
994
584
|
Get payments for the given payor Id
|
|
995
585
|
|
|
996
|
-
###
|
|
586
|
+
### Examples
|
|
997
587
|
|
|
998
588
|
```ruby
|
|
999
|
-
|
|
589
|
+
require 'time'
|
|
1000
590
|
require 'velopayments'
|
|
1001
591
|
# setup authorization
|
|
1002
592
|
VeloPayments.configure do |config|
|
|
@@ -1006,11 +596,13 @@ end
|
|
|
1006
596
|
|
|
1007
597
|
api_instance = VeloPayments::PaymentAuditServiceApi.new
|
|
1008
598
|
opts = {
|
|
1009
|
-
payee_id:
|
|
1010
|
-
payor_id:
|
|
599
|
+
payee_id: TODO, # String | The UUID of the payee.
|
|
600
|
+
payor_id: TODO, # String | The account owner Payor Id. Required for external users.
|
|
1011
601
|
payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
|
|
1012
602
|
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
1013
|
-
|
|
603
|
+
remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
|
|
604
|
+
status: 'ACCEPTED', # String | Payment Status
|
|
605
|
+
transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
1014
606
|
source_account_name: 'source_account_name_example', # String | The source account name filter. This filters via a case insensitive substring match.
|
|
1015
607
|
source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
1016
608
|
source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
@@ -1021,45 +613,64 @@ opts = {
|
|
|
1021
613
|
submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
|
1022
614
|
submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
|
1023
615
|
payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
|
|
1024
|
-
page:
|
|
1025
|
-
page_size:
|
|
616
|
+
page: 56, # Integer | Page number. Default is 1.
|
|
617
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
1026
618
|
sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
|
|
1027
619
|
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.
|
|
1028
620
|
}
|
|
1029
621
|
|
|
1030
622
|
begin
|
|
1031
|
-
#Get List of Payments
|
|
623
|
+
# Get List of Payments
|
|
1032
624
|
result = api_instance.list_payments_audit_v4(opts)
|
|
1033
625
|
p result
|
|
1034
626
|
rescue VeloPayments::ApiError => e
|
|
1035
|
-
puts "
|
|
627
|
+
puts "Error when calling PaymentAuditServiceApi->list_payments_audit_v4: #{e}"
|
|
1036
628
|
end
|
|
1037
629
|
```
|
|
1038
630
|
|
|
1039
|
-
|
|
631
|
+
#### Using the list_payments_audit_v4_with_http_info variant
|
|
632
|
+
|
|
633
|
+
This returns an Array which contains the response data, status code and headers.
|
|
634
|
+
|
|
635
|
+
> <Array(<ListPaymentsResponseV4>, Integer, Hash)> list_payments_audit_v4_with_http_info(opts)
|
|
636
|
+
|
|
637
|
+
```ruby
|
|
638
|
+
begin
|
|
639
|
+
# Get List of Payments
|
|
640
|
+
data, status_code, headers = api_instance.list_payments_audit_v4_with_http_info(opts)
|
|
641
|
+
p status_code # => 2xx
|
|
642
|
+
p headers # => { ... }
|
|
643
|
+
p data # => <ListPaymentsResponseV4>
|
|
644
|
+
rescue VeloPayments::ApiError => e
|
|
645
|
+
puts "Error when calling PaymentAuditServiceApi->list_payments_audit_v4_with_http_info: #{e}"
|
|
646
|
+
end
|
|
647
|
+
```
|
|
1040
648
|
|
|
649
|
+
### Parameters
|
|
1041
650
|
|
|
1042
|
-
Name | Type | Description
|
|
1043
|
-
|
|
1044
|
-
**payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
|
|
1045
|
-
**payor_id** | [**String**](.md)| The account owner Payor Id. Required for external users. | [optional]
|
|
1046
|
-
**payor_name** | **String
|
|
1047
|
-
**remote_id** | **String
|
|
1048
|
-
**
|
|
1049
|
-
**
|
|
1050
|
-
**
|
|
1051
|
-
**
|
|
1052
|
-
**
|
|
1053
|
-
**
|
|
1054
|
-
**
|
|
1055
|
-
**
|
|
1056
|
-
**
|
|
1057
|
-
**
|
|
1058
|
-
**
|
|
1059
|
-
**
|
|
1060
|
-
**
|
|
1061
|
-
**
|
|
1062
|
-
**
|
|
651
|
+
| Name | Type | Description | Notes |
|
|
652
|
+
| ---- | ---- | ----------- | ----- |
|
|
653
|
+
| **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
|
|
654
|
+
| **payor_id** | [**String**](.md) | The account owner Payor Id. Required for external users. | [optional] |
|
|
655
|
+
| **payor_name** | **String** | The payor’s name. This filters via a case insensitive substring match. | [optional] |
|
|
656
|
+
| **remote_id** | **String** | The remote id of the payees. | [optional] |
|
|
657
|
+
| **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
|
|
658
|
+
| **status** | **String** | Payment Status | [optional] |
|
|
659
|
+
| **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE | [optional] |
|
|
660
|
+
| **source_account_name** | **String** | The source account name filter. This filters via a case insensitive substring match. | [optional] |
|
|
661
|
+
| **source_amount_from** | **Integer** | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] |
|
|
662
|
+
| **source_amount_to** | **Integer** | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] |
|
|
663
|
+
| **source_currency** | **String** | The source currency filter. Filters based on an exact match on the currency. | [optional] |
|
|
664
|
+
| **payment_amount_from** | **Integer** | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] |
|
|
665
|
+
| **payment_amount_to** | **Integer** | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] |
|
|
666
|
+
| **payment_currency** | **String** | The payment currency filter. Filters based on an exact match on the currency. | [optional] |
|
|
667
|
+
| **submitted_date_from** | **Date** | The submitted date from range filter. Format is yyyy-MM-dd. | [optional] |
|
|
668
|
+
| **submitted_date_to** | **Date** | The submitted date to range filter. Format is yyyy-MM-dd. | [optional] |
|
|
669
|
+
| **payment_memo** | **String** | The payment memo filter. This filters via a case insensitive substring match. | [optional] |
|
|
670
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
671
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
672
|
+
| **sort** | **String** | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId | [optional] |
|
|
673
|
+
| **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] |
|
|
1063
674
|
|
|
1064
675
|
### Return type
|
|
1065
676
|
|