velopayments 2.23.78.beta1 → 2.26.124.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Makefile +2 -3
- data/README.md +61 -71
- data/docs/AcceptedPaymentV3.md +22 -17
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +14 -13
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +10 -9
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +74 -21
- data/docs/CreateFundingAccountRequestV2.md +20 -19
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +14 -15
- data/docs/CreateWebhookRequest.md +16 -13
- data/docs/CurrenciesApi.md +26 -9
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -25
- data/docs/FundingAccountResponse2.md +26 -25
- data/docs/FundingAccountType.md +4 -5
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +549 -259
- data/docs/FundingManagerPrivateApi.md +98 -13
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +10 -9
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +10 -9
- data/docs/GetPayeeListResponse.md +40 -39
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +10 -9
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +8 -7
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -43
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +12 -9
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +12 -9
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +4 -5
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +12 -11
- data/docs/ListPaymentsResponseV3.md +12 -11
- data/docs/ListPaymentsResponseV3Page.md +16 -15
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +10 -9
- data/docs/ListSourceAccountResponseV3.md +12 -11
- data/docs/ListSourceAccountResponseV3Links.md +10 -9
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +109 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +14 -13
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +8 -7
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +12 -11
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +64 -63
- data/docs/PayeeDetailResponse2.md +64 -63
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +216 -359
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeUserSelfUpdateRequest.md +18 -17
- data/docs/PayeesApi.md +346 -499
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +242 -631
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +24 -19
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +96 -85
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +32 -27
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorV1.md +50 -49
- data/docs/PayorV2.md +52 -49
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +8 -7
- data/docs/PayoutIndividualV3.md +8 -7
- data/docs/PayoutNameV3.md +10 -9
- data/docs/PayoutPayeeV3.md +12 -11
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +208 -88
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +26 -25
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +28 -27
- data/docs/QuoteResponseV3.md +8 -7
- data/docs/RegionV2.md +10 -9
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +28 -23
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -33
- data/docs/SourceAccountResponseV2.md +38 -37
- data/docs/SourceAccountResponseV3.md +42 -37
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +4 -5
- data/docs/SourceAccountV3.md +14 -13
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +8 -7
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +12 -11
- data/docs/SupportedCurrencyResponseV2.md +8 -7
- data/docs/SupportedCurrencyV2.md +10 -9
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +12 -11
- data/docs/TransmissionType.md +4 -5
- data/docs/TransmissionTypes.md +12 -11
- data/docs/TransmissionTypes2.md +12 -11
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +20 -19
- data/docs/UpdatePayeeDetailsRequest2.md +20 -19
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +14 -11
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +478 -189
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +4 -5
- data/docs/WebhookResponse.md +18 -15
- data/docs/WebhooksApi.md +109 -92
- data/docs/WebhooksResponse.md +12 -11
- data/docs/WithdrawPaymentRequest.md +8 -7
- data/lib/velopayments.rb +50 -48
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +5 -2
- data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +25 -358
- data/lib/velopayments/api/payees_api.rb +28 -468
- data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_service_api.rb +9 -2
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +2 -2
- data/lib/velopayments/api/webhooks_api.rb +2 -61
- data/lib/velopayments/api_client.rb +6 -5
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -7
- data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
- data/lib/velopayments/models/access_token_response.rb +12 -4
- data/lib/velopayments/models/access_token_validation_request.rb +12 -4
- data/lib/velopayments/models/auth_response.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
- data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
- data/lib/velopayments/models/challenge.rb +12 -4
- data/lib/velopayments/models/challenge2.rb +12 -4
- data/lib/velopayments/models/company.rb +12 -4
- data/lib/velopayments/models/company2.rb +12 -4
- data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
- data/lib/velopayments/models/create_individual.rb +13 -5
- data/lib/velopayments/models/create_individual2.rb +13 -5
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
- data/lib/velopayments/models/create_payee.rb +16 -7
- data/lib/velopayments/models/create_payee2.rb +15 -6
- data/lib/velopayments/models/create_payee_address.rb +45 -21
- data/lib/velopayments/models/create_payee_address2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
- data/lib/velopayments/models/create_payees_request.rb +12 -4
- data/lib/velopayments/models/create_payees_request2.rb +12 -4
- data/lib/velopayments/models/create_payment_channel.rb +12 -4
- data/lib/velopayments/models/create_payment_channel2.rb +12 -4
- data/lib/velopayments/models/create_payor_link_request.rb +12 -4
- data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
- data/lib/velopayments/models/create_webhook_request.rb +31 -8
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/error.rb +46 -10
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +41 -10
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +13 -5
- data/lib/velopayments/models/failed_submission2.rb +13 -5
- data/lib/velopayments/models/funding_account_response.rb +12 -4
- data/lib/velopayments/models/funding_account_response2.rb +12 -4
- data/lib/velopayments/models/funding_account_type.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +12 -4
- data/lib/velopayments/models/funding_event.rb +12 -4
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/funding_request_v1.rb +12 -4
- data/lib/velopayments/models/funding_request_v2.rb +12 -4
- data/lib/velopayments/models/funding_request_v3.rb +12 -4
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
- data/lib/velopayments/models/fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/get_fundings_response.rb +12 -4
- data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
- data/lib/velopayments/models/get_payee_list_response.rb +14 -5
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
- data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
- data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
- data/lib/velopayments/models/get_payout_statistics.rb +12 -4
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
- data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
- data/lib/velopayments/models/individual.rb +13 -5
- data/lib/velopayments/models/individual2.rb +13 -5
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
- data/lib/velopayments/models/inline_response400.rb +43 -10
- data/lib/velopayments/models/inline_response401.rb +43 -10
- data/lib/velopayments/models/inline_response403.rb +43 -10
- data/lib/velopayments/models/inline_response404.rb +43 -10
- data/lib/velopayments/models/inline_response409.rb +43 -10
- data/lib/velopayments/models/inline_response412.rb +43 -10
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status2.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +12 -4
- data/lib/velopayments/models/invite_payee_request2.rb +12 -4
- data/lib/velopayments/models/invite_user_request.rb +12 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/link_for_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
- data/lib/velopayments/models/list_source_account_response.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +12 -4
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/name.rb +12 -4
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
- data/lib/velopayments/models/notifications.rb +12 -4
- data/lib/velopayments/models/notifications2.rb +12 -4
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status2.rb +2 -2
- data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
- data/lib/velopayments/models/page_for_response.rb +12 -4
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response.rb +13 -5
- data/lib/velopayments/models/paged_payee_response2.rb +14 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
- data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/paged_user_response.rb +12 -4
- data/lib/velopayments/models/paged_user_response_links.rb +12 -4
- data/lib/velopayments/models/paged_user_response_page.rb +12 -4
- data/lib/velopayments/models/password_request.rb +12 -4
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +12 -4
- data/lib/velopayments/models/payee_address2.rb +12 -4
- data/lib/velopayments/models/payee_delta.rb +13 -5
- data/lib/velopayments/models/payee_delta2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
- data/lib/velopayments/models/payee_detail_response.rb +18 -9
- data/lib/velopayments/models/payee_detail_response2.rb +16 -7
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/payee_payor_ref.rb +58 -8
- data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +12 -4
- data/lib/velopayments/models/payment_channel_rule.rb +12 -4
- data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
- data/lib/velopayments/models/payment_delta.rb +12 -4
- data/lib/velopayments/models/payment_delta_response.rb +12 -4
- data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
- data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/payment_event_all_of.rb +243 -0
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
- data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
- data/lib/velopayments/models/payment_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_response_v4.rb +65 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/payment_v3.rb +34 -8
- data/lib/velopayments/models/payor_address.rb +12 -4
- data/lib/velopayments/models/payor_address_v2.rb +12 -4
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
- data/lib/velopayments/models/payor_branding_response.rb +12 -4
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
- data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
- data/lib/velopayments/models/payor_create_application_request.rb +12 -4
- data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
- data/lib/velopayments/models/payor_links_response.rb +12 -4
- data/lib/velopayments/models/payor_links_response_links.rb +12 -4
- data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
- data/lib/velopayments/models/payor_v1.rb +12 -4
- data/lib/velopayments/models/payor_v2.rb +28 -8
- data/lib/velopayments/models/payout_company_v3.rb +12 -4
- data/lib/velopayments/models/payout_individual_v3.rb +12 -4
- data/lib/velopayments/models/payout_name_v3.rb +12 -4
- data/lib/velopayments/models/payout_payee_v3.rb +12 -4
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
- data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
- data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
- data/lib/velopayments/models/query_batch_response.rb +12 -4
- data/lib/velopayments/models/query_batch_response2.rb +12 -4
- data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/quote_response_v3.rb +12 -4
- data/lib/velopayments/models/region_v2.rb +12 -4
- data/lib/velopayments/models/register_sms_request.rb +12 -4
- data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
- data/lib/velopayments/models/resend_token_request.rb +12 -4
- data/lib/velopayments/models/reset_password_request.rb +12 -4
- data/lib/velopayments/models/role.rb +12 -4
- data/lib/velopayments/models/role_update_request.rb +12 -4
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
- data/lib/velopayments/models/self_update_password_request.rb +12 -4
- data/lib/velopayments/models/set_notifications_request.rb +12 -4
- data/lib/velopayments/models/source_account_response.rb +12 -4
- data/lib/velopayments/models/source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/source_account_response_v3.rb +40 -12
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
- data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
- data/lib/velopayments/models/source_account_type.rb +2 -2
- data/lib/velopayments/models/source_account_v3.rb +12 -4
- data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
- data/lib/velopayments/models/supported_countries_response.rb +12 -4
- data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_country.rb +12 -4
- data/lib/velopayments/models/supported_country_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_v2.rb +12 -4
- data/lib/velopayments/models/transfer_request.rb +12 -4
- data/lib/velopayments/models/transfer_request2.rb +12 -4
- data/lib/velopayments/models/transmission_type.rb +2 -2
- data/lib/velopayments/models/transmission_types.rb +12 -4
- data/lib/velopayments/models/transmission_types2.rb +12 -4
- data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
- data/lib/velopayments/models/update_payee_details_request.rb +19 -10
- data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
- data/lib/velopayments/models/update_remote_id_request.rb +12 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
- data/lib/velopayments/models/update_webhook_request.rb +32 -8
- data/lib/velopayments/models/user_details_update_request.rb +12 -4
- data/lib/velopayments/models/user_info.rb +12 -4
- data/lib/velopayments/models/user_response.rb +27 -4
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +12 -4
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/models/watchlist_status2.rb +2 -2
- data/lib/velopayments/models/webhook_response.rb +27 -8
- data/lib/velopayments/models/webhooks_response.rb +12 -4
- data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +3 -2
- data/spec/api/funding_manager_private_api_spec.rb +14 -2
- data/spec/api/login_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +10 -75
- data/spec/api/payees_api_spec.rb +11 -99
- data/spec/api/payment_audit_service_api_spec.rb +9 -147
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +3 -2
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +2 -12
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +17 -12
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/auto_top_up_config2_spec.rb +5 -12
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/challenge2_spec.rb +5 -12
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/create_funding_account_request_v2_spec.rb +6 -13
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/create_payout_request_v3_spec.rb +5 -18
- data/spec/models/create_webhook_request_spec.rb +11 -12
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
- data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{ping_response_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +5 -12
- data/spec/models/funding_account_response_spec.rb +5 -12
- data/spec/models/funding_account_type_spec.rb +5 -12
- data/spec/models/funding_audit_spec.rb +8 -15
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +5 -12
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +5 -12
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_company_spec.rb +5 -12
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
- data/spec/models/get_payee_list_response_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +5 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/inline_response404_spec.rb +11 -12
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +11 -12
- data/spec/models/invitation_status2_spec.rb +5 -12
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_spec.rb +5 -12
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_spec.rb +5 -12
- data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +5 -12
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +5 -12
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{payee_payor_ref2_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/paged_payments_response_v3_spec.rb +5 -12
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/payee_detail_response2_spec.rb +5 -12
- data/spec/models/payee_detail_response_spec.rb +5 -12
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response401_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -12
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/payee_user_self_update_request_spec.rb +5 -12
- data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/{payment_delta_response_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
- data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
- data/spec/models/payment_instruction_v3_spec.rb +17 -12
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +37 -14
- data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
- data/spec/models/payment_v3_spec.rb +18 -13
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +6 -13
- data/spec/models/payor_v2_spec.rb +12 -13
- data/spec/models/payout_company_v3_spec.rb +5 -12
- data/spec/models/payout_individual_v3_spec.rb +5 -12
- data/spec/models/payout_name_v3_spec.rb +5 -12
- data/spec/models/payout_payee_v3_spec.rb +5 -12
- data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/payout_summary_response_v3_spec.rb +5 -12
- data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/quote_fx_summary_v3_spec.rb +7 -14
- data/spec/models/quote_response_v3_spec.rb +5 -12
- data/spec/models/region_v2_spec.rb +5 -12
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +17 -12
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +6 -13
- data/spec/models/source_account_response_v2_spec.rb +6 -13
- data/spec/models/source_account_response_v3_spec.rb +19 -14
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +5 -12
- data/spec/models/source_account_v3_spec.rb +5 -12
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +5 -12
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/supported_country_v2_spec.rb +5 -12
- data/spec/models/supported_currency_response_v2_spec.rb +5 -12
- data/spec/models/supported_currency_v2_spec.rb +5 -12
- data/spec/models/transfer_request2_spec.rb +5 -12
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +5 -12
- data/spec/models/transmission_types2_spec.rb +5 -12
- data/spec/models/transmission_types_spec.rb +5 -12
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +5 -12
- data/spec/models/update_payee_details_request_spec.rb +5 -12
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +11 -12
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +8 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +5 -12
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +11 -12
- data/spec/models/webhooks_response_spec.rb +5 -12
- data/spec/models/withdraw_payment_request_spec.rb +5 -12
- data/spec/spec_helper.rb +2 -2
- data/specs/api/payee_invitation_api_spec.rb +0 -42
- data/specs/api/payees_api_spec.rb +0 -99
- data/specs/api/payment_audit_service_api_spec.rb +0 -150
- data/velopayments.gemspec +2 -2
- metadata +194 -186
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InlineResponse404Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InlineResponse412Errors.md +0 -23
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRef2.md +0 -25
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeType2.md +0 -16
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentDeltaResponseV4.md +0 -21
- data/docs/PaymentDeltaV4.md +0 -31
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -47
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/PingResponse.md +0 -19
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
- data/lib/velopayments/models/inline_response401_errors.rb +0 -240
- data/lib/velopayments/models/inline_response409_errors.rb +0 -240
- data/lib/velopayments/models/inline_response412_errors.rb +0 -240
- data/lib/velopayments/models/language.rb +0 -46
- data/lib/velopayments/models/language2.rb +0 -46
- data/lib/velopayments/models/location_type.rb +0 -40
- data/lib/velopayments/models/ofac_status2.rb +0 -38
- data/lib/velopayments/models/payee2.rb +0 -460
- data/lib/velopayments/models/payee_payment_channel.rb +0 -455
- data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
- data/lib/velopayments/models/payee_response.rb +0 -392
- data/lib/velopayments/models/payee_response_v2.rb +0 -475
- data/lib/velopayments/models/payor_logo_request.rb +0 -210
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response404_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/inline_response412_errors_spec.rb +0 -59
- data/spec/models/location_type_spec.rb +0 -35
- data/spec/models/payee2_spec.rb +0 -165
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payee_response_spec.rb +0 -155
- data/spec/models/payee_response_v2_spec.rb +0 -209
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.
|
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 5.
|
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -19,72 +19,6 @@ module VeloPayments
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Export Transactions
|
|
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.
|
|
24
|
-
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [String] :payor_id 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.
|
|
26
|
-
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
|
|
27
|
-
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
|
28
|
-
# @return [PayorAmlTransactionV3]
|
|
29
|
-
def export_transactions_csvv3(opts = {})
|
|
30
|
-
data, _status_code, _headers = export_transactions_csvv3_with_http_info(opts)
|
|
31
|
-
data
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# Export Transactions
|
|
35
|
-
# 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.
|
|
36
|
-
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @option opts [String] :payor_id 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.
|
|
38
|
-
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
|
|
39
|
-
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
|
40
|
-
# @return [Array<(PayorAmlTransactionV3, Integer, Hash)>] PayorAmlTransactionV3 data, response status code and response headers
|
|
41
|
-
def export_transactions_csvv3_with_http_info(opts = {})
|
|
42
|
-
if @api_client.config.debugging
|
|
43
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv3 ...'
|
|
44
|
-
end
|
|
45
|
-
# resource path
|
|
46
|
-
local_var_path = '/v3/paymentaudit/transactions'
|
|
47
|
-
|
|
48
|
-
# query parameters
|
|
49
|
-
query_params = opts[:query_params] || {}
|
|
50
|
-
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
|
51
|
-
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
52
|
-
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
53
|
-
|
|
54
|
-
# header parameters
|
|
55
|
-
header_params = opts[:header_params] || {}
|
|
56
|
-
# HTTP header 'Accept' (if needed)
|
|
57
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/csv', 'application/json'])
|
|
58
|
-
|
|
59
|
-
# form parameters
|
|
60
|
-
form_params = opts[:form_params] || {}
|
|
61
|
-
|
|
62
|
-
# http body (model)
|
|
63
|
-
post_body = opts[:debug_body]
|
|
64
|
-
|
|
65
|
-
# return_type
|
|
66
|
-
return_type = opts[:debug_return_type] || 'PayorAmlTransactionV3'
|
|
67
|
-
|
|
68
|
-
# auth_names
|
|
69
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
70
|
-
|
|
71
|
-
new_options = opts.merge(
|
|
72
|
-
:operation => :"PaymentAuditServiceApi.export_transactions_csvv3",
|
|
73
|
-
:header_params => header_params,
|
|
74
|
-
:query_params => query_params,
|
|
75
|
-
:form_params => form_params,
|
|
76
|
-
:body => post_body,
|
|
77
|
-
:auth_names => auth_names,
|
|
78
|
-
:return_type => return_type
|
|
79
|
-
)
|
|
80
|
-
|
|
81
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
82
|
-
if @api_client.config.debugging
|
|
83
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#export_transactions_csvv3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
84
|
-
end
|
|
85
|
-
return data, status_code, headers
|
|
86
|
-
end
|
|
87
|
-
|
|
88
22
|
# Export Transactions
|
|
89
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.
|
|
90
24
|
# @param [Hash] opts the optional parameters
|
|
@@ -92,7 +26,7 @@ module VeloPayments
|
|
|
92
26
|
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
|
|
93
27
|
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
|
94
28
|
# @option opts [String] :include <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>
|
|
95
|
-
# @return [
|
|
29
|
+
# @return [PayorAmlTransaction]
|
|
96
30
|
def export_transactions_csvv4(opts = {})
|
|
97
31
|
data, _status_code, _headers = export_transactions_csvv4_with_http_info(opts)
|
|
98
32
|
data
|
|
@@ -105,7 +39,7 @@ module VeloPayments
|
|
|
105
39
|
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
|
|
106
40
|
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
|
107
41
|
# @option opts [String] :include <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>
|
|
108
|
-
# @return [Array<(
|
|
42
|
+
# @return [Array<(PayorAmlTransaction, Integer, Hash)>] PayorAmlTransaction data, response status code and response headers
|
|
109
43
|
def export_transactions_csvv4_with_http_info(opts = {})
|
|
110
44
|
if @api_client.config.debugging
|
|
111
45
|
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv4 ...'
|
|
@@ -136,7 +70,7 @@ module VeloPayments
|
|
|
136
70
|
post_body = opts[:debug_body]
|
|
137
71
|
|
|
138
72
|
# return_type
|
|
139
|
-
return_type = opts[:debug_return_type] || '
|
|
73
|
+
return_type = opts[:debug_return_type] || 'PayorAmlTransaction'
|
|
140
74
|
|
|
141
75
|
# auth_names
|
|
142
76
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
@@ -158,87 +92,6 @@ module VeloPayments
|
|
|
158
92
|
return data, status_code, headers
|
|
159
93
|
end
|
|
160
94
|
|
|
161
|
-
# Get Fundings for Payor
|
|
162
|
-
# <p>Get a list of Fundings for a payor.</p> <p>Deprecated (use v4/paymentaudit/fundings)</p>
|
|
163
|
-
# @param payor_id [String] The account owner Payor ID
|
|
164
|
-
# @param [Hash] opts the optional parameters
|
|
165
|
-
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
166
|
-
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
167
|
-
# @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
|
168
|
-
# @return [GetFundingsResponse]
|
|
169
|
-
def get_fundings_v1(payor_id, opts = {})
|
|
170
|
-
data, _status_code, _headers = get_fundings_v1_with_http_info(payor_id, opts)
|
|
171
|
-
data
|
|
172
|
-
end
|
|
173
|
-
|
|
174
|
-
# Get Fundings for Payor
|
|
175
|
-
# <p>Get a list of Fundings for a payor.</p> <p>Deprecated (use v4/paymentaudit/fundings)</p>
|
|
176
|
-
# @param payor_id [String] The account owner Payor ID
|
|
177
|
-
# @param [Hash] opts the optional parameters
|
|
178
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
|
179
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
|
180
|
-
# @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
|
181
|
-
# @return [Array<(GetFundingsResponse, Integer, Hash)>] GetFundingsResponse data, response status code and response headers
|
|
182
|
-
def get_fundings_v1_with_http_info(payor_id, opts = {})
|
|
183
|
-
if @api_client.config.debugging
|
|
184
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_fundings_v1 ...'
|
|
185
|
-
end
|
|
186
|
-
# verify the required parameter 'payor_id' is set
|
|
187
|
-
if @api_client.config.client_side_validation && payor_id.nil?
|
|
188
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.get_fundings_v1"
|
|
189
|
-
end
|
|
190
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
191
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v1, must be smaller than or equal to 100.'
|
|
192
|
-
end
|
|
193
|
-
|
|
194
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
195
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v1, must be greater than or equal to 1.'
|
|
196
|
-
end
|
|
197
|
-
|
|
198
|
-
# resource path
|
|
199
|
-
local_var_path = '/v1/paymentaudit/fundings'
|
|
200
|
-
|
|
201
|
-
# query parameters
|
|
202
|
-
query_params = opts[:query_params] || {}
|
|
203
|
-
query_params[:'payorId'] = payor_id
|
|
204
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
205
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
206
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
207
|
-
|
|
208
|
-
# header parameters
|
|
209
|
-
header_params = opts[:header_params] || {}
|
|
210
|
-
# HTTP header 'Accept' (if needed)
|
|
211
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
212
|
-
|
|
213
|
-
# form parameters
|
|
214
|
-
form_params = opts[:form_params] || {}
|
|
215
|
-
|
|
216
|
-
# http body (model)
|
|
217
|
-
post_body = opts[:debug_body]
|
|
218
|
-
|
|
219
|
-
# return_type
|
|
220
|
-
return_type = opts[:debug_return_type] || 'GetFundingsResponse'
|
|
221
|
-
|
|
222
|
-
# auth_names
|
|
223
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
224
|
-
|
|
225
|
-
new_options = opts.merge(
|
|
226
|
-
:operation => :"PaymentAuditServiceApi.get_fundings_v1",
|
|
227
|
-
:header_params => header_params,
|
|
228
|
-
:query_params => query_params,
|
|
229
|
-
:form_params => form_params,
|
|
230
|
-
:body => post_body,
|
|
231
|
-
:auth_names => auth_names,
|
|
232
|
-
:return_type => return_type
|
|
233
|
-
)
|
|
234
|
-
|
|
235
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
236
|
-
if @api_client.config.debugging
|
|
237
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_fundings_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
238
|
-
end
|
|
239
|
-
return data, status_code, headers
|
|
240
|
-
end
|
|
241
|
-
|
|
242
95
|
# Get Fundings for Payor
|
|
243
96
|
# <p>Get a list of Fundings for a payor.</p>
|
|
244
97
|
# @param payor_id [String] The account owner Payor ID
|
|
@@ -320,72 +173,6 @@ module VeloPayments
|
|
|
320
173
|
return data, status_code, headers
|
|
321
174
|
end
|
|
322
175
|
|
|
323
|
-
# Get Payment
|
|
324
|
-
# Get the payment with the given id. This contains the payment history.
|
|
325
|
-
# @param payment_id [String] Payment Id
|
|
326
|
-
# @param [Hash] opts the optional parameters
|
|
327
|
-
# @option opts [Boolean] :sensitive 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.
|
|
328
|
-
# @return [PaymentResponseV3]
|
|
329
|
-
def get_payment_details(payment_id, opts = {})
|
|
330
|
-
data, _status_code, _headers = get_payment_details_with_http_info(payment_id, opts)
|
|
331
|
-
data
|
|
332
|
-
end
|
|
333
|
-
|
|
334
|
-
# Get Payment
|
|
335
|
-
# Get the payment with the given id. This contains the payment history.
|
|
336
|
-
# @param payment_id [String] Payment Id
|
|
337
|
-
# @param [Hash] opts the optional parameters
|
|
338
|
-
# @option opts [Boolean] :sensitive 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.
|
|
339
|
-
# @return [Array<(PaymentResponseV3, Integer, Hash)>] PaymentResponseV3 data, response status code and response headers
|
|
340
|
-
def get_payment_details_with_http_info(payment_id, opts = {})
|
|
341
|
-
if @api_client.config.debugging
|
|
342
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payment_details ...'
|
|
343
|
-
end
|
|
344
|
-
# verify the required parameter 'payment_id' is set
|
|
345
|
-
if @api_client.config.client_side_validation && payment_id.nil?
|
|
346
|
-
fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentAuditServiceApi.get_payment_details"
|
|
347
|
-
end
|
|
348
|
-
# resource path
|
|
349
|
-
local_var_path = '/v3/paymentaudit/payments/{paymentId}'.sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s))
|
|
350
|
-
|
|
351
|
-
# query parameters
|
|
352
|
-
query_params = opts[:query_params] || {}
|
|
353
|
-
query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
|
|
354
|
-
|
|
355
|
-
# header parameters
|
|
356
|
-
header_params = opts[:header_params] || {}
|
|
357
|
-
# HTTP header 'Accept' (if needed)
|
|
358
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
359
|
-
|
|
360
|
-
# form parameters
|
|
361
|
-
form_params = opts[:form_params] || {}
|
|
362
|
-
|
|
363
|
-
# http body (model)
|
|
364
|
-
post_body = opts[:debug_body]
|
|
365
|
-
|
|
366
|
-
# return_type
|
|
367
|
-
return_type = opts[:debug_return_type] || 'PaymentResponseV3'
|
|
368
|
-
|
|
369
|
-
# auth_names
|
|
370
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
371
|
-
|
|
372
|
-
new_options = opts.merge(
|
|
373
|
-
:operation => :"PaymentAuditServiceApi.get_payment_details",
|
|
374
|
-
:header_params => header_params,
|
|
375
|
-
:query_params => query_params,
|
|
376
|
-
:form_params => form_params,
|
|
377
|
-
:body => post_body,
|
|
378
|
-
:auth_names => auth_names,
|
|
379
|
-
:return_type => return_type
|
|
380
|
-
)
|
|
381
|
-
|
|
382
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
383
|
-
if @api_client.config.debugging
|
|
384
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payment_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
385
|
-
end
|
|
386
|
-
return data, status_code, headers
|
|
387
|
-
end
|
|
388
|
-
|
|
389
176
|
# Get Payment
|
|
390
177
|
# Get the payment with the given id. This contains the payment history.
|
|
391
178
|
# @param payment_id [String] Payment Id
|
|
@@ -453,10 +240,11 @@ module VeloPayments
|
|
|
453
240
|
end
|
|
454
241
|
|
|
455
242
|
# Get Payments for Payout
|
|
456
|
-
# Get List of payments for Payout
|
|
243
|
+
# Get List of payments for Payout, allowing for RETURNED status
|
|
457
244
|
# @param payout_id [String] The id (UUID) of the payout.
|
|
458
245
|
# @param [Hash] opts the optional parameters
|
|
459
246
|
# @option opts [String] :remote_id The remote id of the payees.
|
|
247
|
+
# @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
|
|
460
248
|
# @option opts [String] :status Payment Status
|
|
461
249
|
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
462
250
|
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
@@ -464,21 +252,23 @@ module VeloPayments
|
|
|
464
252
|
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
465
253
|
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
466
254
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
255
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
467
256
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
468
257
|
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
469
|
-
# @option opts [String] :sort
|
|
258
|
+
# @option opts [String] :sort 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
|
|
470
259
|
# @option opts [Boolean] :sensitive 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.
|
|
471
|
-
# @return [
|
|
472
|
-
def
|
|
473
|
-
data, _status_code, _headers =
|
|
260
|
+
# @return [GetPaymentsForPayoutResponseV4]
|
|
261
|
+
def get_payments_for_payout_v4(payout_id, opts = {})
|
|
262
|
+
data, _status_code, _headers = get_payments_for_payout_v4_with_http_info(payout_id, opts)
|
|
474
263
|
data
|
|
475
264
|
end
|
|
476
265
|
|
|
477
266
|
# Get Payments for Payout
|
|
478
|
-
# Get List of payments for Payout
|
|
267
|
+
# Get List of payments for Payout, allowing for RETURNED status
|
|
479
268
|
# @param payout_id [String] The id (UUID) of the payout.
|
|
480
269
|
# @param [Hash] opts the optional parameters
|
|
481
270
|
# @option opts [String] :remote_id The remote id of the payees.
|
|
271
|
+
# @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
|
|
482
272
|
# @option opts [String] :status Payment Status
|
|
483
273
|
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
484
274
|
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
@@ -486,37 +276,43 @@ module VeloPayments
|
|
|
486
276
|
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
487
277
|
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
488
278
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
279
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
489
280
|
# @option opts [Integer] :page Page number. Default is 1.
|
|
490
281
|
# @option opts [Integer] :page_size The number of results to return in a page
|
|
491
|
-
# @option opts [String] :sort
|
|
282
|
+
# @option opts [String] :sort 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
|
|
492
283
|
# @option opts [Boolean] :sensitive 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.
|
|
493
|
-
# @return [Array<(
|
|
494
|
-
def
|
|
284
|
+
# @return [Array<(GetPaymentsForPayoutResponseV4, Integer, Hash)>] GetPaymentsForPayoutResponseV4 data, response status code and response headers
|
|
285
|
+
def get_payments_for_payout_v4_with_http_info(payout_id, opts = {})
|
|
495
286
|
if @api_client.config.debugging
|
|
496
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.
|
|
287
|
+
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payments_for_payout_v4 ...'
|
|
497
288
|
end
|
|
498
289
|
# verify the required parameter 'payout_id' is set
|
|
499
290
|
if @api_client.config.client_side_validation && payout_id.nil?
|
|
500
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PaymentAuditServiceApi.
|
|
291
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PaymentAuditServiceApi.get_payments_for_payout_v4"
|
|
501
292
|
end
|
|
502
293
|
allowable_values = ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "RETURNED", "WITHDRAWN"]
|
|
503
294
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
504
295
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
505
296
|
end
|
|
297
|
+
allowable_values = ["ACH", "SAME_DAY_ACH", "WIRE"]
|
|
298
|
+
if @api_client.config.client_side_validation && opts[:'transmission_type'] && !allowable_values.include?(opts[:'transmission_type'])
|
|
299
|
+
fail ArgumentError, "invalid value for \"transmission_type\", must be one of #{allowable_values}"
|
|
300
|
+
end
|
|
506
301
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
507
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.
|
|
302
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be smaller than or equal to 100.'
|
|
508
303
|
end
|
|
509
304
|
|
|
510
305
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
511
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.
|
|
306
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be greater than or equal to 1.'
|
|
512
307
|
end
|
|
513
308
|
|
|
514
309
|
# resource path
|
|
515
|
-
local_var_path = '/
|
|
310
|
+
local_var_path = '/v4/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
|
516
311
|
|
|
517
312
|
# query parameters
|
|
518
313
|
query_params = opts[:query_params] || {}
|
|
519
314
|
query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
315
|
+
query_params[:'remoteSystemId'] = opts[:'remote_system_id'] if !opts[:'remote_system_id'].nil?
|
|
520
316
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
521
317
|
query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil?
|
|
522
318
|
query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil?
|
|
@@ -524,6 +320,7 @@ module VeloPayments
|
|
|
524
320
|
query_params[:'paymentAmountTo'] = opts[:'payment_amount_to'] if !opts[:'payment_amount_to'].nil?
|
|
525
321
|
query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil?
|
|
526
322
|
query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil?
|
|
323
|
+
query_params[:'transmissionType'] = opts[:'transmission_type'] if !opts[:'transmission_type'].nil?
|
|
527
324
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
528
325
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
529
326
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
@@ -541,13 +338,13 @@ module VeloPayments
|
|
|
541
338
|
post_body = opts[:debug_body]
|
|
542
339
|
|
|
543
340
|
# return_type
|
|
544
|
-
return_type = opts[:debug_return_type] || '
|
|
341
|
+
return_type = opts[:debug_return_type] || 'GetPaymentsForPayoutResponseV4'
|
|
545
342
|
|
|
546
343
|
# auth_names
|
|
547
344
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
548
345
|
|
|
549
346
|
new_options = opts.merge(
|
|
550
|
-
:operation => :"PaymentAuditServiceApi.
|
|
347
|
+
:operation => :"PaymentAuditServiceApi.get_payments_for_payout_v4",
|
|
551
348
|
:header_params => header_params,
|
|
552
349
|
:query_params => query_params,
|
|
553
350
|
:form_params => form_params,
|
|
@@ -558,203 +355,32 @@ module VeloPayments
|
|
|
558
355
|
|
|
559
356
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
560
357
|
if @api_client.config.debugging
|
|
561
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#
|
|
358
|
+
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payments_for_payout_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
562
359
|
end
|
|
563
360
|
return data, status_code, headers
|
|
564
361
|
end
|
|
565
362
|
|
|
566
|
-
# Get
|
|
567
|
-
# Get
|
|
568
|
-
# @param payout_id [String] The id (UUID) of the payout.
|
|
363
|
+
# Get Payout Statistics
|
|
364
|
+
# <p>Get payout statistics for a payor.</p>
|
|
569
365
|
# @param [Hash] opts the optional parameters
|
|
570
|
-
# @option opts [String] :
|
|
571
|
-
# @
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
# @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
575
|
-
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
576
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
577
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
578
|
-
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
579
|
-
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
580
|
-
# @option opts [String] :sort 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
|
|
581
|
-
# @option opts [Boolean] :sensitive 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.
|
|
582
|
-
# @return [GetPaymentsForPayoutResponseV4]
|
|
583
|
-
def get_payments_for_payout_v4(payout_id, opts = {})
|
|
584
|
-
data, _status_code, _headers = get_payments_for_payout_v4_with_http_info(payout_id, opts)
|
|
366
|
+
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
367
|
+
# @return [GetPayoutStatistics]
|
|
368
|
+
def get_payout_stats_v4(opts = {})
|
|
369
|
+
data, _status_code, _headers = get_payout_stats_v4_with_http_info(opts)
|
|
585
370
|
data
|
|
586
371
|
end
|
|
587
372
|
|
|
588
|
-
# Get
|
|
589
|
-
# Get
|
|
590
|
-
# @param payout_id [String] The id (UUID) of the payout.
|
|
373
|
+
# Get Payout Statistics
|
|
374
|
+
# <p>Get payout statistics for a payor.</p>
|
|
591
375
|
# @param [Hash] opts the optional parameters
|
|
592
|
-
# @option opts [String] :
|
|
593
|
-
# @
|
|
594
|
-
|
|
595
|
-
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
596
|
-
# @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
597
|
-
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
598
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
599
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
600
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
|
601
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
|
602
|
-
# @option opts [String] :sort 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
|
|
603
|
-
# @option opts [Boolean] :sensitive 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.
|
|
604
|
-
# @return [Array<(GetPaymentsForPayoutResponseV4, Integer, Hash)>] GetPaymentsForPayoutResponseV4 data, response status code and response headers
|
|
605
|
-
def get_payments_for_payout_v4_with_http_info(payout_id, opts = {})
|
|
376
|
+
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
377
|
+
# @return [Array<(GetPayoutStatistics, Integer, Hash)>] GetPayoutStatistics data, response status code and response headers
|
|
378
|
+
def get_payout_stats_v4_with_http_info(opts = {})
|
|
606
379
|
if @api_client.config.debugging
|
|
607
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.
|
|
608
|
-
end
|
|
609
|
-
# verify the required parameter 'payout_id' is set
|
|
610
|
-
if @api_client.config.client_side_validation && payout_id.nil?
|
|
611
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PaymentAuditServiceApi.get_payments_for_payout_v4"
|
|
612
|
-
end
|
|
613
|
-
allowable_values = ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "RETURNED", "WITHDRAWN"]
|
|
614
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
615
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
616
|
-
end
|
|
617
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
618
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be smaller than or equal to 100.'
|
|
380
|
+
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payout_stats_v4 ...'
|
|
619
381
|
end
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be greater than or equal to 1.'
|
|
623
|
-
end
|
|
624
|
-
|
|
625
|
-
# resource path
|
|
626
|
-
local_var_path = '/v4/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
|
627
|
-
|
|
628
|
-
# query parameters
|
|
629
|
-
query_params = opts[:query_params] || {}
|
|
630
|
-
query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
631
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
632
|
-
query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil?
|
|
633
|
-
query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil?
|
|
634
|
-
query_params[:'paymentAmountFrom'] = opts[:'payment_amount_from'] if !opts[:'payment_amount_from'].nil?
|
|
635
|
-
query_params[:'paymentAmountTo'] = opts[:'payment_amount_to'] if !opts[:'payment_amount_to'].nil?
|
|
636
|
-
query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil?
|
|
637
|
-
query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil?
|
|
638
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
639
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
640
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
641
|
-
query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
|
|
642
|
-
|
|
643
|
-
# header parameters
|
|
644
|
-
header_params = opts[:header_params] || {}
|
|
645
|
-
# HTTP header 'Accept' (if needed)
|
|
646
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
647
|
-
|
|
648
|
-
# form parameters
|
|
649
|
-
form_params = opts[:form_params] || {}
|
|
650
|
-
|
|
651
|
-
# http body (model)
|
|
652
|
-
post_body = opts[:debug_body]
|
|
653
|
-
|
|
654
|
-
# return_type
|
|
655
|
-
return_type = opts[:debug_return_type] || 'GetPaymentsForPayoutResponseV4'
|
|
656
|
-
|
|
657
|
-
# auth_names
|
|
658
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
659
|
-
|
|
660
|
-
new_options = opts.merge(
|
|
661
|
-
:operation => :"PaymentAuditServiceApi.get_payments_for_payout_v4",
|
|
662
|
-
:header_params => header_params,
|
|
663
|
-
:query_params => query_params,
|
|
664
|
-
:form_params => form_params,
|
|
665
|
-
:body => post_body,
|
|
666
|
-
:auth_names => auth_names,
|
|
667
|
-
:return_type => return_type
|
|
668
|
-
)
|
|
669
|
-
|
|
670
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
671
|
-
if @api_client.config.debugging
|
|
672
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payments_for_payout_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
673
|
-
end
|
|
674
|
-
return data, status_code, headers
|
|
675
|
-
end
|
|
676
|
-
|
|
677
|
-
# Get Payout Statistics
|
|
678
|
-
# <p>Get payout statistics for a payor.</p> <p>Deprecated (Use /v4/paymentaudit/payoutStatistics)</p>
|
|
679
|
-
# @param [Hash] opts the optional parameters
|
|
680
|
-
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
681
|
-
# @return [GetPayoutStatistics]
|
|
682
|
-
def get_payout_stats_v1(opts = {})
|
|
683
|
-
data, _status_code, _headers = get_payout_stats_v1_with_http_info(opts)
|
|
684
|
-
data
|
|
685
|
-
end
|
|
686
|
-
|
|
687
|
-
# Get Payout Statistics
|
|
688
|
-
# <p>Get payout statistics for a payor.</p> <p>Deprecated (Use /v4/paymentaudit/payoutStatistics)</p>
|
|
689
|
-
# @param [Hash] opts the optional parameters
|
|
690
|
-
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
691
|
-
# @return [Array<(GetPayoutStatistics, Integer, Hash)>] GetPayoutStatistics data, response status code and response headers
|
|
692
|
-
def get_payout_stats_v1_with_http_info(opts = {})
|
|
693
|
-
if @api_client.config.debugging
|
|
694
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payout_stats_v1 ...'
|
|
695
|
-
end
|
|
696
|
-
# resource path
|
|
697
|
-
local_var_path = '/v1/paymentaudit/payoutStatistics'
|
|
698
|
-
|
|
699
|
-
# query parameters
|
|
700
|
-
query_params = opts[:query_params] || {}
|
|
701
|
-
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
|
702
|
-
|
|
703
|
-
# header parameters
|
|
704
|
-
header_params = opts[:header_params] || {}
|
|
705
|
-
# HTTP header 'Accept' (if needed)
|
|
706
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
707
|
-
|
|
708
|
-
# form parameters
|
|
709
|
-
form_params = opts[:form_params] || {}
|
|
710
|
-
|
|
711
|
-
# http body (model)
|
|
712
|
-
post_body = opts[:debug_body]
|
|
713
|
-
|
|
714
|
-
# return_type
|
|
715
|
-
return_type = opts[:debug_return_type] || 'GetPayoutStatistics'
|
|
716
|
-
|
|
717
|
-
# auth_names
|
|
718
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
719
|
-
|
|
720
|
-
new_options = opts.merge(
|
|
721
|
-
:operation => :"PaymentAuditServiceApi.get_payout_stats_v1",
|
|
722
|
-
:header_params => header_params,
|
|
723
|
-
:query_params => query_params,
|
|
724
|
-
:form_params => form_params,
|
|
725
|
-
:body => post_body,
|
|
726
|
-
:auth_names => auth_names,
|
|
727
|
-
:return_type => return_type
|
|
728
|
-
)
|
|
729
|
-
|
|
730
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
731
|
-
if @api_client.config.debugging
|
|
732
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payout_stats_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
733
|
-
end
|
|
734
|
-
return data, status_code, headers
|
|
735
|
-
end
|
|
736
|
-
|
|
737
|
-
# Get Payout Statistics
|
|
738
|
-
# <p>Get payout statistics for a payor.</p>
|
|
739
|
-
# @param [Hash] opts the optional parameters
|
|
740
|
-
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
741
|
-
# @return [GetPayoutStatistics]
|
|
742
|
-
def get_payout_stats_v4(opts = {})
|
|
743
|
-
data, _status_code, _headers = get_payout_stats_v4_with_http_info(opts)
|
|
744
|
-
data
|
|
745
|
-
end
|
|
746
|
-
|
|
747
|
-
# Get Payout Statistics
|
|
748
|
-
# <p>Get payout statistics for a payor.</p>
|
|
749
|
-
# @param [Hash] opts the optional parameters
|
|
750
|
-
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
|
751
|
-
# @return [Array<(GetPayoutStatistics, Integer, Hash)>] GetPayoutStatistics data, response status code and response headers
|
|
752
|
-
def get_payout_stats_v4_with_http_info(opts = {})
|
|
753
|
-
if @api_client.config.debugging
|
|
754
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payout_stats_v4 ...'
|
|
755
|
-
end
|
|
756
|
-
# resource path
|
|
757
|
-
local_var_path = '/v4/paymentaudit/payoutStatistics'
|
|
382
|
+
# resource path
|
|
383
|
+
local_var_path = '/v4/paymentaudit/payoutStatistics'
|
|
758
384
|
|
|
759
385
|
# query parameters
|
|
760
386
|
query_params = opts[:query_params] || {}
|
|
@@ -794,103 +420,6 @@ module VeloPayments
|
|
|
794
420
|
return data, status_code, headers
|
|
795
421
|
end
|
|
796
422
|
|
|
797
|
-
# Get Payouts for Payor
|
|
798
|
-
# <p>Get List of payouts for payor</p> <p>Deprecated Use v4</p>
|
|
799
|
-
# @param payor_id [String] The account owner Payor ID
|
|
800
|
-
# @param [Hash] opts the optional parameters
|
|
801
|
-
# @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
|
|
802
|
-
# @option opts [String] :status Payout Status
|
|
803
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
804
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
805
|
-
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
806
|
-
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
807
|
-
# @option opts [String] :sort 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.
|
|
808
|
-
# @return [GetPayoutsResponseV3]
|
|
809
|
-
def get_payouts_for_payor_v3(payor_id, opts = {})
|
|
810
|
-
data, _status_code, _headers = get_payouts_for_payor_v3_with_http_info(payor_id, opts)
|
|
811
|
-
data
|
|
812
|
-
end
|
|
813
|
-
|
|
814
|
-
# Get Payouts for Payor
|
|
815
|
-
# <p>Get List of payouts for payor</p> <p>Deprecated Use v4</p>
|
|
816
|
-
# @param payor_id [String] The account owner Payor ID
|
|
817
|
-
# @param [Hash] opts the optional parameters
|
|
818
|
-
# @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
|
|
819
|
-
# @option opts [String] :status Payout Status
|
|
820
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
821
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
822
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
|
823
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
|
824
|
-
# @option opts [String] :sort 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.
|
|
825
|
-
# @return [Array<(GetPayoutsResponseV3, Integer, Hash)>] GetPayoutsResponseV3 data, response status code and response headers
|
|
826
|
-
def get_payouts_for_payor_v3_with_http_info(payor_id, opts = {})
|
|
827
|
-
if @api_client.config.debugging
|
|
828
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payouts_for_payor_v3 ...'
|
|
829
|
-
end
|
|
830
|
-
# verify the required parameter 'payor_id' is set
|
|
831
|
-
if @api_client.config.client_side_validation && payor_id.nil?
|
|
832
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.get_payouts_for_payor_v3"
|
|
833
|
-
end
|
|
834
|
-
allowable_values = ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "WITHDRAWN"]
|
|
835
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
836
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
837
|
-
end
|
|
838
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
839
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v3, must be smaller than or equal to 100.'
|
|
840
|
-
end
|
|
841
|
-
|
|
842
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
843
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v3, must be greater than or equal to 1.'
|
|
844
|
-
end
|
|
845
|
-
|
|
846
|
-
# resource path
|
|
847
|
-
local_var_path = '/v3/paymentaudit/payouts'
|
|
848
|
-
|
|
849
|
-
# query parameters
|
|
850
|
-
query_params = opts[:query_params] || {}
|
|
851
|
-
query_params[:'payorId'] = payor_id
|
|
852
|
-
query_params[:'payoutMemo'] = opts[:'payout_memo'] if !opts[:'payout_memo'].nil?
|
|
853
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
854
|
-
query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil?
|
|
855
|
-
query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil?
|
|
856
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
857
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
858
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
859
|
-
|
|
860
|
-
# header parameters
|
|
861
|
-
header_params = opts[:header_params] || {}
|
|
862
|
-
# HTTP header 'Accept' (if needed)
|
|
863
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
864
|
-
|
|
865
|
-
# form parameters
|
|
866
|
-
form_params = opts[:form_params] || {}
|
|
867
|
-
|
|
868
|
-
# http body (model)
|
|
869
|
-
post_body = opts[:debug_body]
|
|
870
|
-
|
|
871
|
-
# return_type
|
|
872
|
-
return_type = opts[:debug_return_type] || 'GetPayoutsResponseV3'
|
|
873
|
-
|
|
874
|
-
# auth_names
|
|
875
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
876
|
-
|
|
877
|
-
new_options = opts.merge(
|
|
878
|
-
:operation => :"PaymentAuditServiceApi.get_payouts_for_payor_v3",
|
|
879
|
-
:header_params => header_params,
|
|
880
|
-
:query_params => query_params,
|
|
881
|
-
:form_params => form_params,
|
|
882
|
-
:body => post_body,
|
|
883
|
-
:auth_names => auth_names,
|
|
884
|
-
:return_type => return_type
|
|
885
|
-
)
|
|
886
|
-
|
|
887
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
888
|
-
if @api_client.config.debugging
|
|
889
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payouts_for_payor_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
890
|
-
end
|
|
891
|
-
return data, status_code, headers
|
|
892
|
-
end
|
|
893
|
-
|
|
894
423
|
# Get Payouts for Payor
|
|
895
424
|
# Get List of payouts for payor
|
|
896
425
|
# @param [Hash] opts the optional parameters
|
|
@@ -903,7 +432,7 @@ module VeloPayments
|
|
|
903
432
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
904
433
|
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
905
434
|
# @option opts [String] :sort 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
|
|
906
|
-
# @return [
|
|
435
|
+
# @return [GetPayoutsResponse]
|
|
907
436
|
def get_payouts_for_payor_v4(opts = {})
|
|
908
437
|
data, _status_code, _headers = get_payouts_for_payor_v4_with_http_info(opts)
|
|
909
438
|
data
|
|
@@ -921,7 +450,7 @@ module VeloPayments
|
|
|
921
450
|
# @option opts [Integer] :page Page number. Default is 1.
|
|
922
451
|
# @option opts [Integer] :page_size The number of results to return in a page
|
|
923
452
|
# @option opts [String] :sort 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
|
|
924
|
-
# @return [Array<(
|
|
453
|
+
# @return [Array<(GetPayoutsResponse, Integer, Hash)>] GetPayoutsResponse data, response status code and response headers
|
|
925
454
|
def get_payouts_for_payor_v4_with_http_info(opts = {})
|
|
926
455
|
if @api_client.config.debugging
|
|
927
456
|
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payouts_for_payor_v4 ...'
|
|
@@ -965,7 +494,7 @@ module VeloPayments
|
|
|
965
494
|
post_body = opts[:debug_body]
|
|
966
495
|
|
|
967
496
|
# return_type
|
|
968
|
-
return_type = opts[:debug_return_type] || '
|
|
497
|
+
return_type = opts[:debug_return_type] || 'GetPayoutsResponse'
|
|
969
498
|
|
|
970
499
|
# auth_names
|
|
971
500
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
@@ -995,91 +524,6 @@ module VeloPayments
|
|
|
995
524
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
996
525
|
# @option opts [Integer] :page_size The number of results to return in a page (default to 100)
|
|
997
526
|
# @return [PaymentDeltaResponse]
|
|
998
|
-
def list_payment_changes(payor_id, updated_since, opts = {})
|
|
999
|
-
data, _status_code, _headers = list_payment_changes_with_http_info(payor_id, updated_since, opts)
|
|
1000
|
-
data
|
|
1001
|
-
end
|
|
1002
|
-
|
|
1003
|
-
# List Payment Changes
|
|
1004
|
-
# Get a paginated response listing payment changes.
|
|
1005
|
-
# @param payor_id [String] The Payor ID to find associated Payments
|
|
1006
|
-
# @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
1007
|
-
# @param [Hash] opts the optional parameters
|
|
1008
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
|
1009
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
|
1010
|
-
# @return [Array<(PaymentDeltaResponse, Integer, Hash)>] PaymentDeltaResponse data, response status code and response headers
|
|
1011
|
-
def list_payment_changes_with_http_info(payor_id, updated_since, opts = {})
|
|
1012
|
-
if @api_client.config.debugging
|
|
1013
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payment_changes ...'
|
|
1014
|
-
end
|
|
1015
|
-
# verify the required parameter 'payor_id' is set
|
|
1016
|
-
if @api_client.config.client_side_validation && payor_id.nil?
|
|
1017
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.list_payment_changes"
|
|
1018
|
-
end
|
|
1019
|
-
# verify the required parameter 'updated_since' is set
|
|
1020
|
-
if @api_client.config.client_side_validation && updated_since.nil?
|
|
1021
|
-
fail ArgumentError, "Missing the required parameter 'updated_since' when calling PaymentAuditServiceApi.list_payment_changes"
|
|
1022
|
-
end
|
|
1023
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
|
1024
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes, must be smaller than or equal to 1000.'
|
|
1025
|
-
end
|
|
1026
|
-
|
|
1027
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
1028
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes, must be greater than or equal to 1.'
|
|
1029
|
-
end
|
|
1030
|
-
|
|
1031
|
-
# resource path
|
|
1032
|
-
local_var_path = '/v1/deltas/payments'
|
|
1033
|
-
|
|
1034
|
-
# query parameters
|
|
1035
|
-
query_params = opts[:query_params] || {}
|
|
1036
|
-
query_params[:'payorId'] = payor_id
|
|
1037
|
-
query_params[:'updatedSince'] = updated_since
|
|
1038
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
1039
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1040
|
-
|
|
1041
|
-
# header parameters
|
|
1042
|
-
header_params = opts[:header_params] || {}
|
|
1043
|
-
# HTTP header 'Accept' (if needed)
|
|
1044
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1045
|
-
|
|
1046
|
-
# form parameters
|
|
1047
|
-
form_params = opts[:form_params] || {}
|
|
1048
|
-
|
|
1049
|
-
# http body (model)
|
|
1050
|
-
post_body = opts[:debug_body]
|
|
1051
|
-
|
|
1052
|
-
# return_type
|
|
1053
|
-
return_type = opts[:debug_return_type] || 'PaymentDeltaResponse'
|
|
1054
|
-
|
|
1055
|
-
# auth_names
|
|
1056
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
1057
|
-
|
|
1058
|
-
new_options = opts.merge(
|
|
1059
|
-
:operation => :"PaymentAuditServiceApi.list_payment_changes",
|
|
1060
|
-
:header_params => header_params,
|
|
1061
|
-
:query_params => query_params,
|
|
1062
|
-
:form_params => form_params,
|
|
1063
|
-
:body => post_body,
|
|
1064
|
-
:auth_names => auth_names,
|
|
1065
|
-
:return_type => return_type
|
|
1066
|
-
)
|
|
1067
|
-
|
|
1068
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1069
|
-
if @api_client.config.debugging
|
|
1070
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#list_payment_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1071
|
-
end
|
|
1072
|
-
return data, status_code, headers
|
|
1073
|
-
end
|
|
1074
|
-
|
|
1075
|
-
# List Payment Changes
|
|
1076
|
-
# Get a paginated response listing payment changes.
|
|
1077
|
-
# @param payor_id [String] The Payor ID to find associated Payments
|
|
1078
|
-
# @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
1079
|
-
# @param [Hash] opts the optional parameters
|
|
1080
|
-
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
1081
|
-
# @option opts [Integer] :page_size The number of results to return in a page (default to 100)
|
|
1082
|
-
# @return [PaymentDeltaResponseV4]
|
|
1083
527
|
def list_payment_changes_v4(payor_id, updated_since, opts = {})
|
|
1084
528
|
data, _status_code, _headers = list_payment_changes_v4_with_http_info(payor_id, updated_since, opts)
|
|
1085
529
|
data
|
|
@@ -1092,7 +536,7 @@ module VeloPayments
|
|
|
1092
536
|
# @param [Hash] opts the optional parameters
|
|
1093
537
|
# @option opts [Integer] :page Page number. Default is 1.
|
|
1094
538
|
# @option opts [Integer] :page_size The number of results to return in a page
|
|
1095
|
-
# @return [Array<(
|
|
539
|
+
# @return [Array<(PaymentDeltaResponse, Integer, Hash)>] PaymentDeltaResponse data, response status code and response headers
|
|
1096
540
|
def list_payment_changes_v4_with_http_info(payor_id, updated_since, opts = {})
|
|
1097
541
|
if @api_client.config.debugging
|
|
1098
542
|
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payment_changes_v4 ...'
|
|
@@ -1135,7 +579,7 @@ module VeloPayments
|
|
|
1135
579
|
post_body = opts[:debug_body]
|
|
1136
580
|
|
|
1137
581
|
# return_type
|
|
1138
|
-
return_type = opts[:debug_return_type] || '
|
|
582
|
+
return_type = opts[:debug_return_type] || 'PaymentDeltaResponse'
|
|
1139
583
|
|
|
1140
584
|
# auth_names
|
|
1141
585
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
@@ -1164,133 +608,9 @@ module VeloPayments
|
|
|
1164
608
|
# @option opts [String] :payor_id The account owner Payor Id. Required for external users.
|
|
1165
609
|
# @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
|
|
1166
610
|
# @option opts [String] :remote_id The remote id of the payees.
|
|
611
|
+
# @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
|
|
1167
612
|
# @option opts [String] :status Payment Status
|
|
1168
|
-
# @option opts [String] :
|
|
1169
|
-
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
1170
|
-
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
1171
|
-
# @option opts [String] :source_currency The source currency filter. Filters based on an exact match on the currency.
|
|
1172
|
-
# @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
1173
|
-
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
1174
|
-
# @option opts [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency.
|
|
1175
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
1176
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
1177
|
-
# @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
|
|
1178
|
-
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
|
1179
|
-
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
|
1180
|
-
# @option opts [String] :sort 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
|
|
1181
|
-
# @option opts [Boolean] :sensitive 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.
|
|
1182
|
-
# @return [ListPaymentsResponseV3]
|
|
1183
|
-
def list_payments_audit(opts = {})
|
|
1184
|
-
data, _status_code, _headers = list_payments_audit_with_http_info(opts)
|
|
1185
|
-
data
|
|
1186
|
-
end
|
|
1187
|
-
|
|
1188
|
-
# Get List of Payments
|
|
1189
|
-
# Get payments for the given payor Id
|
|
1190
|
-
# @param [Hash] opts the optional parameters
|
|
1191
|
-
# @option opts [String] :payee_id The UUID of the payee.
|
|
1192
|
-
# @option opts [String] :payor_id The account owner Payor Id. Required for external users.
|
|
1193
|
-
# @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
|
|
1194
|
-
# @option opts [String] :remote_id The remote id of the payees.
|
|
1195
|
-
# @option opts [String] :status Payment Status
|
|
1196
|
-
# @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
|
|
1197
|
-
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
1198
|
-
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
1199
|
-
# @option opts [String] :source_currency The source currency filter. Filters based on an exact match on the currency.
|
|
1200
|
-
# @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
|
1201
|
-
# @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
|
1202
|
-
# @option opts [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency.
|
|
1203
|
-
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
|
1204
|
-
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
|
1205
|
-
# @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
|
|
1206
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
|
1207
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
|
1208
|
-
# @option opts [String] :sort 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
|
|
1209
|
-
# @option opts [Boolean] :sensitive 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.
|
|
1210
|
-
# @return [Array<(ListPaymentsResponseV3, Integer, Hash)>] ListPaymentsResponseV3 data, response status code and response headers
|
|
1211
|
-
def list_payments_audit_with_http_info(opts = {})
|
|
1212
|
-
if @api_client.config.debugging
|
|
1213
|
-
@api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payments_audit ...'
|
|
1214
|
-
end
|
|
1215
|
-
allowable_values = ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "RETURNED", "WITHDRAWN"]
|
|
1216
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
1217
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
1218
|
-
end
|
|
1219
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
1220
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit, must be smaller than or equal to 100.'
|
|
1221
|
-
end
|
|
1222
|
-
|
|
1223
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
1224
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit, must be greater than or equal to 1.'
|
|
1225
|
-
end
|
|
1226
|
-
|
|
1227
|
-
# resource path
|
|
1228
|
-
local_var_path = '/v3/paymentaudit/payments'
|
|
1229
|
-
|
|
1230
|
-
# query parameters
|
|
1231
|
-
query_params = opts[:query_params] || {}
|
|
1232
|
-
query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
|
|
1233
|
-
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
|
1234
|
-
query_params[:'payorName'] = opts[:'payor_name'] if !opts[:'payor_name'].nil?
|
|
1235
|
-
query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
1236
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
1237
|
-
query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].nil?
|
|
1238
|
-
query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil?
|
|
1239
|
-
query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil?
|
|
1240
|
-
query_params[:'sourceCurrency'] = opts[:'source_currency'] if !opts[:'source_currency'].nil?
|
|
1241
|
-
query_params[:'paymentAmountFrom'] = opts[:'payment_amount_from'] if !opts[:'payment_amount_from'].nil?
|
|
1242
|
-
query_params[:'paymentAmountTo'] = opts[:'payment_amount_to'] if !opts[:'payment_amount_to'].nil?
|
|
1243
|
-
query_params[:'paymentCurrency'] = opts[:'payment_currency'] if !opts[:'payment_currency'].nil?
|
|
1244
|
-
query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil?
|
|
1245
|
-
query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil?
|
|
1246
|
-
query_params[:'paymentMemo'] = opts[:'payment_memo'] if !opts[:'payment_memo'].nil?
|
|
1247
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
1248
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1249
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
1250
|
-
query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
|
|
1251
|
-
|
|
1252
|
-
# header parameters
|
|
1253
|
-
header_params = opts[:header_params] || {}
|
|
1254
|
-
# HTTP header 'Accept' (if needed)
|
|
1255
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1256
|
-
|
|
1257
|
-
# form parameters
|
|
1258
|
-
form_params = opts[:form_params] || {}
|
|
1259
|
-
|
|
1260
|
-
# http body (model)
|
|
1261
|
-
post_body = opts[:debug_body]
|
|
1262
|
-
|
|
1263
|
-
# return_type
|
|
1264
|
-
return_type = opts[:debug_return_type] || 'ListPaymentsResponseV3'
|
|
1265
|
-
|
|
1266
|
-
# auth_names
|
|
1267
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
|
1268
|
-
|
|
1269
|
-
new_options = opts.merge(
|
|
1270
|
-
:operation => :"PaymentAuditServiceApi.list_payments_audit",
|
|
1271
|
-
:header_params => header_params,
|
|
1272
|
-
:query_params => query_params,
|
|
1273
|
-
:form_params => form_params,
|
|
1274
|
-
:body => post_body,
|
|
1275
|
-
:auth_names => auth_names,
|
|
1276
|
-
:return_type => return_type
|
|
1277
|
-
)
|
|
1278
|
-
|
|
1279
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1280
|
-
if @api_client.config.debugging
|
|
1281
|
-
@api_client.config.logger.debug "API called: PaymentAuditServiceApi#list_payments_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1282
|
-
end
|
|
1283
|
-
return data, status_code, headers
|
|
1284
|
-
end
|
|
1285
|
-
|
|
1286
|
-
# Get List of Payments
|
|
1287
|
-
# Get payments for the given payor Id
|
|
1288
|
-
# @param [Hash] opts the optional parameters
|
|
1289
|
-
# @option opts [String] :payee_id The UUID of the payee.
|
|
1290
|
-
# @option opts [String] :payor_id The account owner Payor Id. Required for external users.
|
|
1291
|
-
# @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
|
|
1292
|
-
# @option opts [String] :remote_id The remote id of the payees.
|
|
1293
|
-
# @option opts [String] :status Payment Status
|
|
613
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
1294
614
|
# @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
|
|
1295
615
|
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
1296
616
|
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
@@ -1318,7 +638,9 @@ module VeloPayments
|
|
|
1318
638
|
# @option opts [String] :payor_id The account owner Payor Id. Required for external users.
|
|
1319
639
|
# @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
|
|
1320
640
|
# @option opts [String] :remote_id The remote id of the payees.
|
|
641
|
+
# @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
|
|
1321
642
|
# @option opts [String] :status Payment Status
|
|
643
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
1322
644
|
# @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
|
|
1323
645
|
# @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
|
1324
646
|
# @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
|
@@ -1342,6 +664,10 @@ module VeloPayments
|
|
|
1342
664
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
1343
665
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
1344
666
|
end
|
|
667
|
+
allowable_values = ["ACH", "SAME_DAY_ACH", "WIRE"]
|
|
668
|
+
if @api_client.config.client_side_validation && opts[:'transmission_type'] && !allowable_values.include?(opts[:'transmission_type'])
|
|
669
|
+
fail ArgumentError, "invalid value for \"transmission_type\", must be one of #{allowable_values}"
|
|
670
|
+
end
|
|
1345
671
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
1346
672
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit_v4, must be smaller than or equal to 100.'
|
|
1347
673
|
end
|
|
@@ -1359,7 +685,9 @@ module VeloPayments
|
|
|
1359
685
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
|
1360
686
|
query_params[:'payorName'] = opts[:'payor_name'] if !opts[:'payor_name'].nil?
|
|
1361
687
|
query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
688
|
+
query_params[:'remoteSystemId'] = opts[:'remote_system_id'] if !opts[:'remote_system_id'].nil?
|
|
1362
689
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
690
|
+
query_params[:'transmissionType'] = opts[:'transmission_type'] if !opts[:'transmission_type'].nil?
|
|
1363
691
|
query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].nil?
|
|
1364
692
|
query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil?
|
|
1365
693
|
query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil?
|