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