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