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