velopayments 2.23.78.beta1 → 2.26.124.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Makefile +2 -3
- data/README.md +61 -71
- data/docs/AcceptedPaymentV3.md +22 -17
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +14 -13
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +10 -9
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +74 -21
- data/docs/CreateFundingAccountRequestV2.md +20 -19
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +14 -15
- data/docs/CreateWebhookRequest.md +16 -13
- data/docs/CurrenciesApi.md +26 -9
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -25
- data/docs/FundingAccountResponse2.md +26 -25
- data/docs/FundingAccountType.md +4 -5
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +549 -259
- data/docs/FundingManagerPrivateApi.md +98 -13
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +10 -9
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +10 -9
- data/docs/GetPayeeListResponse.md +40 -39
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +10 -9
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +8 -7
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -43
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +12 -9
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +12 -9
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +4 -5
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +12 -11
- data/docs/ListPaymentsResponseV3.md +12 -11
- data/docs/ListPaymentsResponseV3Page.md +16 -15
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +10 -9
- data/docs/ListSourceAccountResponseV3.md +12 -11
- data/docs/ListSourceAccountResponseV3Links.md +10 -9
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +109 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +14 -13
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +8 -7
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +12 -11
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +64 -63
- data/docs/PayeeDetailResponse2.md +64 -63
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +216 -359
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeUserSelfUpdateRequest.md +18 -17
- data/docs/PayeesApi.md +346 -499
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +242 -631
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +24 -19
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +96 -85
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +32 -27
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorV1.md +50 -49
- data/docs/PayorV2.md +52 -49
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +8 -7
- data/docs/PayoutIndividualV3.md +8 -7
- data/docs/PayoutNameV3.md +10 -9
- data/docs/PayoutPayeeV3.md +12 -11
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +208 -88
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +26 -25
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +28 -27
- data/docs/QuoteResponseV3.md +8 -7
- data/docs/RegionV2.md +10 -9
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +28 -23
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -33
- data/docs/SourceAccountResponseV2.md +38 -37
- data/docs/SourceAccountResponseV3.md +42 -37
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +4 -5
- data/docs/SourceAccountV3.md +14 -13
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +8 -7
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +12 -11
- data/docs/SupportedCurrencyResponseV2.md +8 -7
- data/docs/SupportedCurrencyV2.md +10 -9
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +12 -11
- data/docs/TransmissionType.md +4 -5
- data/docs/TransmissionTypes.md +12 -11
- data/docs/TransmissionTypes2.md +12 -11
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +20 -19
- data/docs/UpdatePayeeDetailsRequest2.md +20 -19
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +14 -11
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +478 -189
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +4 -5
- data/docs/WebhookResponse.md +18 -15
- data/docs/WebhooksApi.md +109 -92
- data/docs/WebhooksResponse.md +12 -11
- data/docs/WithdrawPaymentRequest.md +8 -7
- data/lib/velopayments.rb +50 -48
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +5 -2
- data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +25 -358
- data/lib/velopayments/api/payees_api.rb +28 -468
- data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_service_api.rb +9 -2
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +2 -2
- data/lib/velopayments/api/webhooks_api.rb +2 -61
- data/lib/velopayments/api_client.rb +6 -5
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -7
- data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
- data/lib/velopayments/models/access_token_response.rb +12 -4
- data/lib/velopayments/models/access_token_validation_request.rb +12 -4
- data/lib/velopayments/models/auth_response.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
- data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
- data/lib/velopayments/models/challenge.rb +12 -4
- data/lib/velopayments/models/challenge2.rb +12 -4
- data/lib/velopayments/models/company.rb +12 -4
- data/lib/velopayments/models/company2.rb +12 -4
- data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
- data/lib/velopayments/models/create_individual.rb +13 -5
- data/lib/velopayments/models/create_individual2.rb +13 -5
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
- data/lib/velopayments/models/create_payee.rb +16 -7
- data/lib/velopayments/models/create_payee2.rb +15 -6
- data/lib/velopayments/models/create_payee_address.rb +45 -21
- data/lib/velopayments/models/create_payee_address2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
- data/lib/velopayments/models/create_payees_request.rb +12 -4
- data/lib/velopayments/models/create_payees_request2.rb +12 -4
- data/lib/velopayments/models/create_payment_channel.rb +12 -4
- data/lib/velopayments/models/create_payment_channel2.rb +12 -4
- data/lib/velopayments/models/create_payor_link_request.rb +12 -4
- data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
- data/lib/velopayments/models/create_webhook_request.rb +31 -8
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/error.rb +46 -10
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +41 -10
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +13 -5
- data/lib/velopayments/models/failed_submission2.rb +13 -5
- data/lib/velopayments/models/funding_account_response.rb +12 -4
- data/lib/velopayments/models/funding_account_response2.rb +12 -4
- data/lib/velopayments/models/funding_account_type.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +12 -4
- data/lib/velopayments/models/funding_event.rb +12 -4
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/funding_request_v1.rb +12 -4
- data/lib/velopayments/models/funding_request_v2.rb +12 -4
- data/lib/velopayments/models/funding_request_v3.rb +12 -4
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
- data/lib/velopayments/models/fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/get_fundings_response.rb +12 -4
- data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
- data/lib/velopayments/models/get_payee_list_response.rb +14 -5
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
- data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
- data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
- data/lib/velopayments/models/get_payout_statistics.rb +12 -4
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
- data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
- data/lib/velopayments/models/individual.rb +13 -5
- data/lib/velopayments/models/individual2.rb +13 -5
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
- data/lib/velopayments/models/inline_response400.rb +43 -10
- data/lib/velopayments/models/inline_response401.rb +43 -10
- data/lib/velopayments/models/inline_response403.rb +43 -10
- data/lib/velopayments/models/inline_response404.rb +43 -10
- data/lib/velopayments/models/inline_response409.rb +43 -10
- data/lib/velopayments/models/inline_response412.rb +43 -10
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status2.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +12 -4
- data/lib/velopayments/models/invite_payee_request2.rb +12 -4
- data/lib/velopayments/models/invite_user_request.rb +12 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/link_for_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
- data/lib/velopayments/models/list_source_account_response.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +12 -4
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/name.rb +12 -4
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
- data/lib/velopayments/models/notifications.rb +12 -4
- data/lib/velopayments/models/notifications2.rb +12 -4
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status2.rb +2 -2
- data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
- data/lib/velopayments/models/page_for_response.rb +12 -4
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response.rb +13 -5
- data/lib/velopayments/models/paged_payee_response2.rb +14 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
- data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/paged_user_response.rb +12 -4
- data/lib/velopayments/models/paged_user_response_links.rb +12 -4
- data/lib/velopayments/models/paged_user_response_page.rb +12 -4
- data/lib/velopayments/models/password_request.rb +12 -4
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +12 -4
- data/lib/velopayments/models/payee_address2.rb +12 -4
- data/lib/velopayments/models/payee_delta.rb +13 -5
- data/lib/velopayments/models/payee_delta2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
- data/lib/velopayments/models/payee_detail_response.rb +18 -9
- data/lib/velopayments/models/payee_detail_response2.rb +16 -7
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/payee_payor_ref.rb +58 -8
- data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +12 -4
- data/lib/velopayments/models/payment_channel_rule.rb +12 -4
- data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
- data/lib/velopayments/models/payment_delta.rb +12 -4
- data/lib/velopayments/models/payment_delta_response.rb +12 -4
- data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
- data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/payment_event_all_of.rb +243 -0
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
- data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
- data/lib/velopayments/models/payment_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_response_v4.rb +65 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/payment_v3.rb +34 -8
- data/lib/velopayments/models/payor_address.rb +12 -4
- data/lib/velopayments/models/payor_address_v2.rb +12 -4
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
- data/lib/velopayments/models/payor_branding_response.rb +12 -4
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
- data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
- data/lib/velopayments/models/payor_create_application_request.rb +12 -4
- data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
- data/lib/velopayments/models/payor_links_response.rb +12 -4
- data/lib/velopayments/models/payor_links_response_links.rb +12 -4
- data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
- data/lib/velopayments/models/payor_v1.rb +12 -4
- data/lib/velopayments/models/payor_v2.rb +28 -8
- data/lib/velopayments/models/payout_company_v3.rb +12 -4
- data/lib/velopayments/models/payout_individual_v3.rb +12 -4
- data/lib/velopayments/models/payout_name_v3.rb +12 -4
- data/lib/velopayments/models/payout_payee_v3.rb +12 -4
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
- data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
- data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
- data/lib/velopayments/models/query_batch_response.rb +12 -4
- data/lib/velopayments/models/query_batch_response2.rb +12 -4
- data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/quote_response_v3.rb +12 -4
- data/lib/velopayments/models/region_v2.rb +12 -4
- data/lib/velopayments/models/register_sms_request.rb +12 -4
- data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
- data/lib/velopayments/models/resend_token_request.rb +12 -4
- data/lib/velopayments/models/reset_password_request.rb +12 -4
- data/lib/velopayments/models/role.rb +12 -4
- data/lib/velopayments/models/role_update_request.rb +12 -4
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
- data/lib/velopayments/models/self_update_password_request.rb +12 -4
- data/lib/velopayments/models/set_notifications_request.rb +12 -4
- data/lib/velopayments/models/source_account_response.rb +12 -4
- data/lib/velopayments/models/source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/source_account_response_v3.rb +40 -12
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
- data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
- data/lib/velopayments/models/source_account_type.rb +2 -2
- data/lib/velopayments/models/source_account_v3.rb +12 -4
- data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
- data/lib/velopayments/models/supported_countries_response.rb +12 -4
- data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_country.rb +12 -4
- data/lib/velopayments/models/supported_country_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_v2.rb +12 -4
- data/lib/velopayments/models/transfer_request.rb +12 -4
- data/lib/velopayments/models/transfer_request2.rb +12 -4
- data/lib/velopayments/models/transmission_type.rb +2 -2
- data/lib/velopayments/models/transmission_types.rb +12 -4
- data/lib/velopayments/models/transmission_types2.rb +12 -4
- data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
- data/lib/velopayments/models/update_payee_details_request.rb +19 -10
- data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
- data/lib/velopayments/models/update_remote_id_request.rb +12 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
- data/lib/velopayments/models/update_webhook_request.rb +32 -8
- data/lib/velopayments/models/user_details_update_request.rb +12 -4
- data/lib/velopayments/models/user_info.rb +12 -4
- data/lib/velopayments/models/user_response.rb +27 -4
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +12 -4
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/models/watchlist_status2.rb +2 -2
- data/lib/velopayments/models/webhook_response.rb +27 -8
- data/lib/velopayments/models/webhooks_response.rb +12 -4
- data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +3 -2
- data/spec/api/funding_manager_private_api_spec.rb +14 -2
- data/spec/api/login_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +10 -75
- data/spec/api/payees_api_spec.rb +11 -99
- data/spec/api/payment_audit_service_api_spec.rb +9 -147
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +3 -2
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +2 -12
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +17 -12
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/auto_top_up_config2_spec.rb +5 -12
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/challenge2_spec.rb +5 -12
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/create_funding_account_request_v2_spec.rb +6 -13
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/create_payout_request_v3_spec.rb +5 -18
- data/spec/models/create_webhook_request_spec.rb +11 -12
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
- data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{ping_response_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +5 -12
- data/spec/models/funding_account_response_spec.rb +5 -12
- data/spec/models/funding_account_type_spec.rb +5 -12
- data/spec/models/funding_audit_spec.rb +8 -15
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +5 -12
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +5 -12
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_company_spec.rb +5 -12
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
- data/spec/models/get_payee_list_response_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +5 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/inline_response404_spec.rb +11 -12
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +11 -12
- data/spec/models/invitation_status2_spec.rb +5 -12
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_spec.rb +5 -12
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_spec.rb +5 -12
- data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +5 -12
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +5 -12
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{payee_payor_ref2_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/paged_payments_response_v3_spec.rb +5 -12
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/payee_detail_response2_spec.rb +5 -12
- data/spec/models/payee_detail_response_spec.rb +5 -12
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response401_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -12
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/payee_user_self_update_request_spec.rb +5 -12
- data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/{payment_delta_response_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
- data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
- data/spec/models/payment_instruction_v3_spec.rb +17 -12
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +37 -14
- data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
- data/spec/models/payment_v3_spec.rb +18 -13
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +6 -13
- data/spec/models/payor_v2_spec.rb +12 -13
- data/spec/models/payout_company_v3_spec.rb +5 -12
- data/spec/models/payout_individual_v3_spec.rb +5 -12
- data/spec/models/payout_name_v3_spec.rb +5 -12
- data/spec/models/payout_payee_v3_spec.rb +5 -12
- data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/payout_summary_response_v3_spec.rb +5 -12
- data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/quote_fx_summary_v3_spec.rb +7 -14
- data/spec/models/quote_response_v3_spec.rb +5 -12
- data/spec/models/region_v2_spec.rb +5 -12
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +17 -12
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +6 -13
- data/spec/models/source_account_response_v2_spec.rb +6 -13
- data/spec/models/source_account_response_v3_spec.rb +19 -14
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +5 -12
- data/spec/models/source_account_v3_spec.rb +5 -12
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +5 -12
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/supported_country_v2_spec.rb +5 -12
- data/spec/models/supported_currency_response_v2_spec.rb +5 -12
- data/spec/models/supported_currency_v2_spec.rb +5 -12
- data/spec/models/transfer_request2_spec.rb +5 -12
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +5 -12
- data/spec/models/transmission_types2_spec.rb +5 -12
- data/spec/models/transmission_types_spec.rb +5 -12
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +5 -12
- data/spec/models/update_payee_details_request_spec.rb +5 -12
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +11 -12
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +8 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +5 -12
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +11 -12
- data/spec/models/webhooks_response_spec.rb +5 -12
- data/spec/models/withdraw_payment_request_spec.rb +5 -12
- data/spec/spec_helper.rb +2 -2
- data/specs/api/payee_invitation_api_spec.rb +0 -42
- data/specs/api/payees_api_spec.rb +0 -99
- data/specs/api/payment_audit_service_api_spec.rb +0 -150
- data/velopayments.gemspec +2 -2
- metadata +194 -186
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InlineResponse404Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InlineResponse412Errors.md +0 -23
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRef2.md +0 -25
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeType2.md +0 -16
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentDeltaResponseV4.md +0 -21
- data/docs/PaymentDeltaV4.md +0 -31
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -47
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/PingResponse.md +0 -19
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
- data/lib/velopayments/models/inline_response401_errors.rb +0 -240
- data/lib/velopayments/models/inline_response409_errors.rb +0 -240
- data/lib/velopayments/models/inline_response412_errors.rb +0 -240
- data/lib/velopayments/models/language.rb +0 -46
- data/lib/velopayments/models/language2.rb +0 -46
- data/lib/velopayments/models/location_type.rb +0 -40
- data/lib/velopayments/models/ofac_status2.rb +0 -38
- data/lib/velopayments/models/payee2.rb +0 -460
- data/lib/velopayments/models/payee_payment_channel.rb +0 -455
- data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
- data/lib/velopayments/models/payee_response.rb +0 -392
- data/lib/velopayments/models/payee_response_v2.rb +0 -475
- data/lib/velopayments/models/payor_logo_request.rb +0 -210
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response404_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/inline_response412_errors_spec.rb +0 -59
- data/spec/models/location_type_spec.rb +0 -35
- data/spec/models/payee2_spec.rb +0 -165
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payee_response_spec.rb +0 -155
- data/spec/models/payee_response_v2_spec.rb +0 -209
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
@@ -0,0 +1,26 @@
|
|
1
|
+
# VeloPayments::PayeeDetailsChanged
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly | |
|
8
|
+
| **event_id** | **String** | UUID id of the source event in the Velo platform | |
|
9
|
+
| **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created | |
|
10
|
+
| **payee_id** | **String** | ID of this payee within the Velo platform | |
|
11
|
+
| **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'velopayments'
|
17
|
+
|
18
|
+
instance = VeloPayments::PayeeDetailsChanged.new(
|
19
|
+
source_type: payment_status_changed,
|
20
|
+
event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
|
21
|
+
created_at: 2020-06-18T15:09:42Z,
|
22
|
+
payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
|
23
|
+
reasons: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/PayeeEvent.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# VeloPayments::PayeeEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly | |
|
8
|
+
| **event_id** | **String** | UUID id of the source event in the Velo platform | |
|
9
|
+
| **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created | |
|
10
|
+
| **payee_id** | **String** | ID of this payee within the Velo platform | |
|
11
|
+
| **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'velopayments'
|
17
|
+
|
18
|
+
instance = VeloPayments::PayeeEvent.new(
|
19
|
+
source_type: payment_status_changed,
|
20
|
+
event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
|
21
|
+
created_at: 2020-06-18T15:09:42Z,
|
22
|
+
payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
|
23
|
+
reasons: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# VeloPayments::PayeeEventAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payee_id** | **String** | ID of this payee within the Velo platform | |
|
8
|
+
| **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'velopayments'
|
14
|
+
|
15
|
+
instance = VeloPayments::PayeeEventAllOf.new(
|
16
|
+
payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
|
17
|
+
reasons: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# VeloPayments::PayeeEventAllOfReasons
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **String** | | |
|
8
|
+
| **message** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'velopayments'
|
14
|
+
|
15
|
+
instance = VeloPayments::PayeeEventAllOfReasons.new(
|
16
|
+
code: 00001,
|
17
|
+
message: payment channel disabled
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/PayeeInvitationApi.md
CHANGED
@@ -2,36 +2,30 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**
|
8
|
-
[**
|
9
|
-
[**
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite
|
16
|
-
[**resend_payee_invite_v4**](PayeeInvitationApi.md#resend_payee_invite_v4) | **POST** /v4/payees/{payeeId}/invite | Resend Payee Invite
|
17
|
-
[**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Initiate Payee Creation
|
18
|
-
[**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation
|
19
|
-
[**v4_create_payee**](PayeeInvitationApi.md#v4_create_payee) | **POST** /v4/payees | Initiate Payee Creation
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |
|
8
|
+
| [**get_payees_invitation_status_v4**](PayeeInvitationApi.md#get_payees_invitation_status_v4) | **GET** /v4/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |
|
9
|
+
| [**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status |
|
10
|
+
| [**query_batch_status_v4**](PayeeInvitationApi.md#query_batch_status_v4) | **GET** /v4/payees/batch/{batchId} | Query Batch Status |
|
11
|
+
| [**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite |
|
12
|
+
| [**resend_payee_invite_v4**](PayeeInvitationApi.md#resend_payee_invite_v4) | **POST** /v4/payees/{payeeId}/invite | Resend Payee Invite |
|
13
|
+
| [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation |
|
14
|
+
| [**v4_create_payee**](PayeeInvitationApi.md#v4_create_payee) | **POST** /v4/payees | Initiate Payee Creation |
|
20
15
|
|
21
16
|
|
17
|
+
## get_payees_invitation_status_v3
|
22
18
|
|
23
|
-
|
24
|
-
|
25
|
-
> InvitationStatusResponse get_payees_invitation_status_v1(payor_id)
|
19
|
+
> <PagedPayeeInvitationStatusResponse> get_payees_invitation_status_v3(payor_id, opts)
|
26
20
|
|
27
21
|
Get Payee Invitation Status
|
28
22
|
|
29
|
-
<p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
23
|
+
<p>Use v4 instead</p> <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
30
24
|
|
31
|
-
###
|
25
|
+
### Examples
|
32
26
|
|
33
27
|
```ruby
|
34
|
-
|
28
|
+
require 'time'
|
35
29
|
require 'velopayments'
|
36
30
|
# setup authorization
|
37
31
|
VeloPayments.configure do |config|
|
@@ -40,85 +34,50 @@ VeloPayments.configure do |config|
|
|
40
34
|
end
|
41
35
|
|
42
36
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
43
|
-
payor_id =
|
37
|
+
payor_id = TODO # String | The account owner Payor ID
|
38
|
+
opts = {
|
39
|
+
payee_id: TODO, # String | The UUID of the payee.
|
40
|
+
invitation_status: VeloPayments::InvitationStatus::ACCEPTED, # InvitationStatus | The invitation status of the payees.
|
41
|
+
page: 1, # Integer | Page number. Default is 1.
|
42
|
+
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
43
|
+
}
|
44
44
|
|
45
45
|
begin
|
46
|
-
#Get Payee Invitation Status
|
47
|
-
result = api_instance.
|
46
|
+
# Get Payee Invitation Status
|
47
|
+
result = api_instance.get_payees_invitation_status_v3(payor_id, opts)
|
48
48
|
p result
|
49
49
|
rescue VeloPayments::ApiError => e
|
50
|
-
puts "
|
50
|
+
puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v3: #{e}"
|
51
51
|
end
|
52
52
|
```
|
53
53
|
|
54
|
-
|
54
|
+
#### Using the get_payees_invitation_status_v3_with_http_info variant
|
55
55
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
56
57
|
|
57
|
-
|
58
|
-
------------- | ------------- | ------------- | -------------
|
59
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
60
|
-
|
61
|
-
### Return type
|
62
|
-
|
63
|
-
[**InvitationStatusResponse**](InvitationStatusResponse.md)
|
64
|
-
|
65
|
-
### Authorization
|
66
|
-
|
67
|
-
[OAuth2](../README.md#OAuth2)
|
68
|
-
|
69
|
-
### HTTP request headers
|
70
|
-
|
71
|
-
- **Content-Type**: Not defined
|
72
|
-
- **Accept**: application/json
|
73
|
-
|
74
|
-
|
75
|
-
## get_payees_invitation_status_v2
|
76
|
-
|
77
|
-
> PagedPayeeInvitationStatusResponse get_payees_invitation_status_v2(payor_id, opts)
|
78
|
-
|
79
|
-
Get Payee Invitation Status
|
80
|
-
|
81
|
-
<p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
82
|
-
|
83
|
-
### Example
|
58
|
+
> <Array(<PagedPayeeInvitationStatusResponse>, Integer, Hash)> get_payees_invitation_status_v3_with_http_info(payor_id, opts)
|
84
59
|
|
85
60
|
```ruby
|
86
|
-
# load the gem
|
87
|
-
require 'velopayments'
|
88
|
-
# setup authorization
|
89
|
-
VeloPayments.configure do |config|
|
90
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
91
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
92
|
-
end
|
93
|
-
|
94
|
-
api_instance = VeloPayments::PayeeInvitationApi.new
|
95
|
-
payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
|
96
|
-
opts = {
|
97
|
-
payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
|
98
|
-
invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
|
99
|
-
page: 1, # Integer | Page number. Default is 1.
|
100
|
-
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
101
|
-
}
|
102
|
-
|
103
61
|
begin
|
104
|
-
#Get Payee Invitation Status
|
105
|
-
|
106
|
-
p
|
62
|
+
# Get Payee Invitation Status
|
63
|
+
data, status_code, headers = api_instance.get_payees_invitation_status_v3_with_http_info(payor_id, opts)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <PagedPayeeInvitationStatusResponse>
|
107
67
|
rescue VeloPayments::ApiError => e
|
108
|
-
puts "
|
68
|
+
puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v3_with_http_info: #{e}"
|
109
69
|
end
|
110
70
|
```
|
111
71
|
|
112
72
|
### Parameters
|
113
73
|
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
**
|
118
|
-
**
|
119
|
-
**
|
120
|
-
**
|
121
|
-
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **payor_id** | [**String**](.md) | The account owner Payor ID | |
|
77
|
+
| **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
|
78
|
+
| **invitation_status** | [**InvitationStatus**](.md) | The invitation status of the payees. | [optional] |
|
79
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
80
|
+
| **page_size** | **Integer** | Page size. Default is 25. Max allowable is 100. | [optional][default to 25] |
|
122
81
|
|
123
82
|
### Return type
|
124
83
|
|
@@ -134,18 +93,18 @@ Name | Type | Description | Notes
|
|
134
93
|
- **Accept**: application/json
|
135
94
|
|
136
95
|
|
137
|
-
##
|
96
|
+
## get_payees_invitation_status_v4
|
138
97
|
|
139
|
-
> PagedPayeeInvitationStatusResponse2
|
98
|
+
> <PagedPayeeInvitationStatusResponse2> get_payees_invitation_status_v4(payor_id, opts)
|
140
99
|
|
141
100
|
Get Payee Invitation Status
|
142
101
|
|
143
102
|
Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
144
103
|
|
145
|
-
###
|
104
|
+
### Examples
|
146
105
|
|
147
106
|
```ruby
|
148
|
-
|
107
|
+
require 'time'
|
149
108
|
require 'velopayments'
|
150
109
|
# setup authorization
|
151
110
|
VeloPayments.configure do |config|
|
@@ -154,95 +113,50 @@ VeloPayments.configure do |config|
|
|
154
113
|
end
|
155
114
|
|
156
115
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
157
|
-
payor_id =
|
116
|
+
payor_id = TODO # String | The account owner Payor ID
|
158
117
|
opts = {
|
159
|
-
payee_id:
|
160
|
-
invitation_status: VeloPayments::InvitationStatus
|
118
|
+
payee_id: TODO, # String | The UUID of the payee.
|
119
|
+
invitation_status: VeloPayments::InvitationStatus::ACCEPTED, # InvitationStatus | The invitation status of the payees.
|
161
120
|
page: 1, # Integer | Page number. Default is 1.
|
162
121
|
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
163
122
|
}
|
164
123
|
|
165
124
|
begin
|
166
|
-
#Get Payee Invitation Status
|
167
|
-
result = api_instance.
|
125
|
+
# Get Payee Invitation Status
|
126
|
+
result = api_instance.get_payees_invitation_status_v4(payor_id, opts)
|
168
127
|
p result
|
169
128
|
rescue VeloPayments::ApiError => e
|
170
|
-
puts "
|
129
|
+
puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v4: #{e}"
|
171
130
|
end
|
172
131
|
```
|
173
132
|
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
Name | Type | Description | Notes
|
178
|
-
------------- | ------------- | ------------- | -------------
|
179
|
-
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
180
|
-
**payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
|
181
|
-
**invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
|
182
|
-
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
183
|
-
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
184
|
-
|
185
|
-
### Return type
|
186
|
-
|
187
|
-
[**PagedPayeeInvitationStatusResponse2**](PagedPayeeInvitationStatusResponse2.md)
|
133
|
+
#### Using the get_payees_invitation_status_v4_with_http_info variant
|
188
134
|
|
189
|
-
|
135
|
+
This returns an Array which contains the response data, status code and headers.
|
190
136
|
|
191
|
-
|
192
|
-
|
193
|
-
### HTTP request headers
|
194
|
-
|
195
|
-
- **Content-Type**: Not defined
|
196
|
-
- **Accept**: application/json
|
197
|
-
|
198
|
-
|
199
|
-
## get_payees_invitation_status_v4
|
200
|
-
|
201
|
-
> PagedPayeeInvitationStatusResponse2 get_payees_invitation_status_v4(payor_id, opts)
|
202
|
-
|
203
|
-
Get Payee Invitation Status
|
204
|
-
|
205
|
-
Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
206
|
-
|
207
|
-
### Example
|
137
|
+
> <Array(<PagedPayeeInvitationStatusResponse2>, Integer, Hash)> get_payees_invitation_status_v4_with_http_info(payor_id, opts)
|
208
138
|
|
209
139
|
```ruby
|
210
|
-
# load the gem
|
211
|
-
require 'velopayments'
|
212
|
-
# setup authorization
|
213
|
-
VeloPayments.configure do |config|
|
214
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
215
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
216
|
-
end
|
217
|
-
|
218
|
-
api_instance = VeloPayments::PayeeInvitationApi.new
|
219
|
-
payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
|
220
|
-
opts = {
|
221
|
-
payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
|
222
|
-
invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
|
223
|
-
page: 1, # Integer | Page number. Default is 1.
|
224
|
-
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
225
|
-
}
|
226
|
-
|
227
140
|
begin
|
228
|
-
#Get Payee Invitation Status
|
229
|
-
|
230
|
-
p
|
141
|
+
# Get Payee Invitation Status
|
142
|
+
data, status_code, headers = api_instance.get_payees_invitation_status_v4_with_http_info(payor_id, opts)
|
143
|
+
p status_code # => 2xx
|
144
|
+
p headers # => { ... }
|
145
|
+
p data # => <PagedPayeeInvitationStatusResponse2>
|
231
146
|
rescue VeloPayments::ApiError => e
|
232
|
-
puts "
|
147
|
+
puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v4_with_http_info: #{e}"
|
233
148
|
end
|
234
149
|
```
|
235
150
|
|
236
151
|
### Parameters
|
237
152
|
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
**
|
242
|
-
**
|
243
|
-
**
|
244
|
-
**
|
245
|
-
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
153
|
+
| Name | Type | Description | Notes |
|
154
|
+
| ---- | ---- | ----------- | ----- |
|
155
|
+
| **payor_id** | [**String**](.md) | The account owner Payor ID | |
|
156
|
+
| **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
|
157
|
+
| **invitation_status** | [**InvitationStatus**](.md) | The invitation status of the payees. | [optional] |
|
158
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
159
|
+
| **page_size** | **Integer** | Page size. Default is 25. Max allowable is 100. | [optional][default to 25] |
|
246
160
|
|
247
161
|
### Return type
|
248
162
|
|
@@ -258,18 +172,18 @@ Name | Type | Description | Notes
|
|
258
172
|
- **Accept**: application/json
|
259
173
|
|
260
174
|
|
261
|
-
##
|
175
|
+
## query_batch_status_v3
|
262
176
|
|
263
|
-
> QueryBatchResponse
|
177
|
+
> <QueryBatchResponse> query_batch_status_v3(batch_id)
|
264
178
|
|
265
179
|
Query Batch Status
|
266
180
|
|
267
|
-
<p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found )
|
181
|
+
<p>Use v4 instead</p> Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
268
182
|
|
269
|
-
###
|
183
|
+
### Examples
|
270
184
|
|
271
185
|
```ruby
|
272
|
-
|
186
|
+
require 'time'
|
273
187
|
require 'velopayments'
|
274
188
|
# setup authorization
|
275
189
|
VeloPayments.configure do |config|
|
@@ -278,79 +192,44 @@ VeloPayments.configure do |config|
|
|
278
192
|
end
|
279
193
|
|
280
194
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
281
|
-
batch_id =
|
195
|
+
batch_id = TODO # String | Batch Id
|
282
196
|
|
283
197
|
begin
|
284
|
-
#Query Batch Status
|
285
|
-
result = api_instance.
|
198
|
+
# Query Batch Status
|
199
|
+
result = api_instance.query_batch_status_v3(batch_id)
|
286
200
|
p result
|
287
201
|
rescue VeloPayments::ApiError => e
|
288
|
-
puts "
|
202
|
+
puts "Error when calling PayeeInvitationApi->query_batch_status_v3: #{e}"
|
289
203
|
end
|
290
204
|
```
|
291
205
|
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
Name | Type | Description | Notes
|
296
|
-
------------- | ------------- | ------------- | -------------
|
297
|
-
**batch_id** | [**String**](.md)| Batch Id |
|
298
|
-
|
299
|
-
### Return type
|
300
|
-
|
301
|
-
[**QueryBatchResponse**](QueryBatchResponse.md)
|
302
|
-
|
303
|
-
### Authorization
|
304
|
-
|
305
|
-
[OAuth2](../README.md#OAuth2)
|
306
|
-
|
307
|
-
### HTTP request headers
|
308
|
-
|
309
|
-
- **Content-Type**: Not defined
|
310
|
-
- **Accept**: application/json
|
311
|
-
|
312
|
-
|
313
|
-
## query_batch_status_v3
|
314
|
-
|
315
|
-
> QueryBatchResponse2 query_batch_status_v3(batch_id)
|
316
|
-
|
317
|
-
Query Batch Status
|
206
|
+
#### Using the query_batch_status_v3_with_http_info variant
|
318
207
|
|
319
|
-
|
208
|
+
This returns an Array which contains the response data, status code and headers.
|
320
209
|
|
321
|
-
|
210
|
+
> <Array(<QueryBatchResponse>, Integer, Hash)> query_batch_status_v3_with_http_info(batch_id)
|
322
211
|
|
323
212
|
```ruby
|
324
|
-
# load the gem
|
325
|
-
require 'velopayments'
|
326
|
-
# setup authorization
|
327
|
-
VeloPayments.configure do |config|
|
328
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
329
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
330
|
-
end
|
331
|
-
|
332
|
-
api_instance = VeloPayments::PayeeInvitationApi.new
|
333
|
-
batch_id = 'batch_id_example' # String | Batch Id
|
334
|
-
|
335
213
|
begin
|
336
|
-
#Query Batch Status
|
337
|
-
|
338
|
-
p
|
214
|
+
# Query Batch Status
|
215
|
+
data, status_code, headers = api_instance.query_batch_status_v3_with_http_info(batch_id)
|
216
|
+
p status_code # => 2xx
|
217
|
+
p headers # => { ... }
|
218
|
+
p data # => <QueryBatchResponse>
|
339
219
|
rescue VeloPayments::ApiError => e
|
340
|
-
puts "
|
220
|
+
puts "Error when calling PayeeInvitationApi->query_batch_status_v3_with_http_info: #{e}"
|
341
221
|
end
|
342
222
|
```
|
343
223
|
|
344
224
|
### Parameters
|
345
225
|
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
**batch_id** | [**String**](.md)| Batch Id |
|
226
|
+
| Name | Type | Description | Notes |
|
227
|
+
| ---- | ---- | ----------- | ----- |
|
228
|
+
| **batch_id** | [**String**](.md) | Batch Id | |
|
350
229
|
|
351
230
|
### Return type
|
352
231
|
|
353
|
-
[**
|
232
|
+
[**QueryBatchResponse**](QueryBatchResponse.md)
|
354
233
|
|
355
234
|
### Authorization
|
356
235
|
|
@@ -364,16 +243,16 @@ Name | Type | Description | Notes
|
|
364
243
|
|
365
244
|
## query_batch_status_v4
|
366
245
|
|
367
|
-
> QueryBatchResponse2 query_batch_status_v4(batch_id)
|
246
|
+
> <QueryBatchResponse2> query_batch_status_v4(batch_id)
|
368
247
|
|
369
248
|
Query Batch Status
|
370
249
|
|
371
250
|
Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
372
251
|
|
373
|
-
###
|
252
|
+
### Examples
|
374
253
|
|
375
254
|
```ruby
|
376
|
-
|
255
|
+
require 'time'
|
377
256
|
require 'velopayments'
|
378
257
|
# setup authorization
|
379
258
|
VeloPayments.configure do |config|
|
@@ -382,23 +261,40 @@ VeloPayments.configure do |config|
|
|
382
261
|
end
|
383
262
|
|
384
263
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
385
|
-
batch_id =
|
264
|
+
batch_id = TODO # String | Batch Id
|
386
265
|
|
387
266
|
begin
|
388
|
-
#Query Batch Status
|
267
|
+
# Query Batch Status
|
389
268
|
result = api_instance.query_batch_status_v4(batch_id)
|
390
269
|
p result
|
391
270
|
rescue VeloPayments::ApiError => e
|
392
|
-
puts "
|
271
|
+
puts "Error when calling PayeeInvitationApi->query_batch_status_v4: #{e}"
|
393
272
|
end
|
394
273
|
```
|
395
274
|
|
396
|
-
|
275
|
+
#### Using the query_batch_status_v4_with_http_info variant
|
397
276
|
|
277
|
+
This returns an Array which contains the response data, status code and headers.
|
398
278
|
|
399
|
-
|
400
|
-
|
401
|
-
|
279
|
+
> <Array(<QueryBatchResponse2>, Integer, Hash)> query_batch_status_v4_with_http_info(batch_id)
|
280
|
+
|
281
|
+
```ruby
|
282
|
+
begin
|
283
|
+
# Query Batch Status
|
284
|
+
data, status_code, headers = api_instance.query_batch_status_v4_with_http_info(batch_id)
|
285
|
+
p status_code # => 2xx
|
286
|
+
p headers # => { ... }
|
287
|
+
p data # => <QueryBatchResponse2>
|
288
|
+
rescue VeloPayments::ApiError => e
|
289
|
+
puts "Error when calling PayeeInvitationApi->query_batch_status_v4_with_http_info: #{e}"
|
290
|
+
end
|
291
|
+
```
|
292
|
+
|
293
|
+
### Parameters
|
294
|
+
|
295
|
+
| Name | Type | Description | Notes |
|
296
|
+
| ---- | ---- | ----------- | ----- |
|
297
|
+
| **batch_id** | [**String**](.md) | Batch Id | |
|
402
298
|
|
403
299
|
### Return type
|
404
300
|
|
@@ -414,18 +310,18 @@ Name | Type | Description | Notes
|
|
414
310
|
- **Accept**: application/json
|
415
311
|
|
416
312
|
|
417
|
-
##
|
313
|
+
## resend_payee_invite_v3
|
418
314
|
|
419
|
-
>
|
315
|
+
> resend_payee_invite_v3(payee_id, invite_payee_request)
|
420
316
|
|
421
317
|
Resend Payee Invite
|
422
318
|
|
423
|
-
<p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
319
|
+
<p>Use v4 instead</p> <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
424
320
|
|
425
|
-
###
|
321
|
+
### Examples
|
426
322
|
|
427
323
|
```ruby
|
428
|
-
|
324
|
+
require 'time'
|
429
325
|
require 'velopayments'
|
430
326
|
# setup authorization
|
431
327
|
VeloPayments.configure do |config|
|
@@ -434,77 +330,41 @@ VeloPayments.configure do |config|
|
|
434
330
|
end
|
435
331
|
|
436
332
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
437
|
-
payee_id =
|
438
|
-
invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest | Provide Payor Id in body of request
|
333
|
+
payee_id = TODO # String | The UUID of the payee.
|
334
|
+
invite_payee_request = VeloPayments::InvitePayeeRequest.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e'}) # InvitePayeeRequest | Provide Payor Id in body of request
|
439
335
|
|
440
336
|
begin
|
441
|
-
#Resend Payee Invite
|
442
|
-
api_instance.
|
337
|
+
# Resend Payee Invite
|
338
|
+
api_instance.resend_payee_invite_v3(payee_id, invite_payee_request)
|
443
339
|
rescue VeloPayments::ApiError => e
|
444
|
-
puts "
|
340
|
+
puts "Error when calling PayeeInvitationApi->resend_payee_invite_v3: #{e}"
|
445
341
|
end
|
446
342
|
```
|
447
343
|
|
448
|
-
|
449
|
-
|
344
|
+
#### Using the resend_payee_invite_v3_with_http_info variant
|
450
345
|
|
451
|
-
|
452
|
-
------------- | ------------- | ------------- | -------------
|
453
|
-
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
454
|
-
**invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| Provide Payor Id in body of request |
|
346
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
455
347
|
|
456
|
-
|
457
|
-
|
458
|
-
nil (empty response body)
|
459
|
-
|
460
|
-
### Authorization
|
461
|
-
|
462
|
-
[OAuth2](../README.md#OAuth2)
|
463
|
-
|
464
|
-
### HTTP request headers
|
465
|
-
|
466
|
-
- **Content-Type**: application/json
|
467
|
-
- **Accept**: application/json
|
468
|
-
|
469
|
-
|
470
|
-
## resend_payee_invite_v3
|
471
|
-
|
472
|
-
> resend_payee_invite_v3(payee_id, invite_payee_request2)
|
473
|
-
|
474
|
-
Resend Payee Invite
|
475
|
-
|
476
|
-
<p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
477
|
-
|
478
|
-
### Example
|
348
|
+
> <Array(nil, Integer, Hash)> resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request)
|
479
349
|
|
480
350
|
```ruby
|
481
|
-
# load the gem
|
482
|
-
require 'velopayments'
|
483
|
-
# setup authorization
|
484
|
-
VeloPayments.configure do |config|
|
485
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
486
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
487
|
-
end
|
488
|
-
|
489
|
-
api_instance = VeloPayments::PayeeInvitationApi.new
|
490
|
-
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
491
|
-
invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
|
492
|
-
|
493
351
|
begin
|
494
|
-
#Resend Payee Invite
|
495
|
-
api_instance.
|
352
|
+
# Resend Payee Invite
|
353
|
+
data, status_code, headers = api_instance.resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request)
|
354
|
+
p status_code # => 2xx
|
355
|
+
p headers # => { ... }
|
356
|
+
p data # => nil
|
496
357
|
rescue VeloPayments::ApiError => e
|
497
|
-
puts "
|
358
|
+
puts "Error when calling PayeeInvitationApi->resend_payee_invite_v3_with_http_info: #{e}"
|
498
359
|
end
|
499
360
|
```
|
500
361
|
|
501
362
|
### Parameters
|
502
363
|
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
**
|
507
|
-
**invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
|
364
|
+
| Name | Type | Description | Notes |
|
365
|
+
| ---- | ---- | ----------- | ----- |
|
366
|
+
| **payee_id** | [**String**](.md) | The UUID of the payee. | |
|
367
|
+
| **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md) | Provide Payor Id in body of request | |
|
508
368
|
|
509
369
|
### Return type
|
510
370
|
|
@@ -528,10 +388,10 @@ Resend Payee Invite
|
|
528
388
|
|
529
389
|
<p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
530
390
|
|
531
|
-
###
|
391
|
+
### Examples
|
532
392
|
|
533
393
|
```ruby
|
534
|
-
|
394
|
+
require 'time'
|
535
395
|
require 'velopayments'
|
536
396
|
# setup authorization
|
537
397
|
VeloPayments.configure do |config|
|
@@ -540,82 +400,45 @@ VeloPayments.configure do |config|
|
|
540
400
|
end
|
541
401
|
|
542
402
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
543
|
-
payee_id =
|
544
|
-
invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
|
403
|
+
payee_id = TODO # String | The UUID of the payee.
|
404
|
+
invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e'}) # InvitePayeeRequest2 | Provide Payor Id in body of request
|
545
405
|
|
546
406
|
begin
|
547
|
-
#Resend Payee Invite
|
407
|
+
# Resend Payee Invite
|
548
408
|
api_instance.resend_payee_invite_v4(payee_id, invite_payee_request2)
|
549
409
|
rescue VeloPayments::ApiError => e
|
550
|
-
puts "
|
410
|
+
puts "Error when calling PayeeInvitationApi->resend_payee_invite_v4: #{e}"
|
551
411
|
end
|
552
412
|
```
|
553
413
|
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
Name | Type | Description | Notes
|
558
|
-
------------- | ------------- | ------------- | -------------
|
559
|
-
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
560
|
-
**invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
|
561
|
-
|
562
|
-
### Return type
|
563
|
-
|
564
|
-
nil (empty response body)
|
565
|
-
|
566
|
-
### Authorization
|
567
|
-
|
568
|
-
[OAuth2](../README.md#OAuth2)
|
414
|
+
#### Using the resend_payee_invite_v4_with_http_info variant
|
569
415
|
|
570
|
-
|
416
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
571
417
|
|
572
|
-
|
573
|
-
- **Accept**: application/json
|
574
|
-
|
575
|
-
|
576
|
-
## v2_create_payee
|
577
|
-
|
578
|
-
> CreatePayeesCSVResponse v2_create_payee(opts)
|
579
|
-
|
580
|
-
Initiate Payee Creation
|
581
|
-
|
582
|
-
Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body
|
583
|
-
|
584
|
-
### Example
|
418
|
+
> <Array(nil, Integer, Hash)> resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2)
|
585
419
|
|
586
420
|
```ruby
|
587
|
-
# load the gem
|
588
|
-
require 'velopayments'
|
589
|
-
# setup authorization
|
590
|
-
VeloPayments.configure do |config|
|
591
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
592
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
593
|
-
end
|
594
|
-
|
595
|
-
api_instance = VeloPayments::PayeeInvitationApi.new
|
596
|
-
opts = {
|
597
|
-
create_payees_request: VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
|
598
|
-
}
|
599
|
-
|
600
421
|
begin
|
601
|
-
#
|
602
|
-
|
603
|
-
p
|
422
|
+
# Resend Payee Invite
|
423
|
+
data, status_code, headers = api_instance.resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2)
|
424
|
+
p status_code # => 2xx
|
425
|
+
p headers # => { ... }
|
426
|
+
p data # => nil
|
604
427
|
rescue VeloPayments::ApiError => e
|
605
|
-
puts "
|
428
|
+
puts "Error when calling PayeeInvitationApi->resend_payee_invite_v4_with_http_info: #{e}"
|
606
429
|
end
|
607
430
|
```
|
608
431
|
|
609
432
|
### Parameters
|
610
433
|
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
**
|
434
|
+
| Name | Type | Description | Notes |
|
435
|
+
| ---- | ---- | ----------- | ----- |
|
436
|
+
| **payee_id** | [**String**](.md) | The UUID of the payee. | |
|
437
|
+
| **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md) | Provide Payor Id in body of request | |
|
615
438
|
|
616
439
|
### Return type
|
617
440
|
|
618
|
-
|
441
|
+
nil (empty response body)
|
619
442
|
|
620
443
|
### Authorization
|
621
444
|
|
@@ -623,22 +446,22 @@ Name | Type | Description | Notes
|
|
623
446
|
|
624
447
|
### HTTP request headers
|
625
448
|
|
626
|
-
- **Content-Type**: application/json
|
449
|
+
- **Content-Type**: application/json
|
627
450
|
- **Accept**: application/json
|
628
451
|
|
629
452
|
|
630
453
|
## v3_create_payee
|
631
454
|
|
632
|
-
>
|
455
|
+
> <CreatePayeesCSVResponse> v3_create_payee(opts)
|
633
456
|
|
634
457
|
Initiate Payee Creation
|
635
458
|
|
636
|
-
Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
459
|
+
<p>Use v4 instead</p> Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
637
460
|
|
638
|
-
###
|
461
|
+
### Examples
|
639
462
|
|
640
463
|
```ruby
|
641
|
-
|
464
|
+
require 'time'
|
642
465
|
require 'velopayments'
|
643
466
|
# setup authorization
|
644
467
|
VeloPayments.configure do |config|
|
@@ -648,28 +471,45 @@ end
|
|
648
471
|
|
649
472
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
650
473
|
opts = {
|
651
|
-
|
474
|
+
create_payees_request: VeloPayments::CreatePayeesRequest.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', payees: [VeloPayments::CreatePayee.new({email: 'bob@example.com', remote_id: 'Remote ID', type: VeloPayments::PayeeType::INDIVIDUAL, address: VeloPayments::CreatePayeeAddress.new({line1: '500 Duval St', city: 'Key West', country: 'AF'})})]}) # CreatePayeesRequest | Post payees to create.
|
652
475
|
}
|
653
476
|
|
654
477
|
begin
|
655
|
-
#Initiate Payee Creation
|
478
|
+
# Initiate Payee Creation
|
656
479
|
result = api_instance.v3_create_payee(opts)
|
657
480
|
p result
|
658
481
|
rescue VeloPayments::ApiError => e
|
659
|
-
puts "
|
482
|
+
puts "Error when calling PayeeInvitationApi->v3_create_payee: #{e}"
|
660
483
|
end
|
661
484
|
```
|
662
485
|
|
663
|
-
|
486
|
+
#### Using the v3_create_payee_with_http_info variant
|
487
|
+
|
488
|
+
This returns an Array which contains the response data, status code and headers.
|
489
|
+
|
490
|
+
> <Array(<CreatePayeesCSVResponse>, Integer, Hash)> v3_create_payee_with_http_info(opts)
|
491
|
+
|
492
|
+
```ruby
|
493
|
+
begin
|
494
|
+
# Initiate Payee Creation
|
495
|
+
data, status_code, headers = api_instance.v3_create_payee_with_http_info(opts)
|
496
|
+
p status_code # => 2xx
|
497
|
+
p headers # => { ... }
|
498
|
+
p data # => <CreatePayeesCSVResponse>
|
499
|
+
rescue VeloPayments::ApiError => e
|
500
|
+
puts "Error when calling PayeeInvitationApi->v3_create_payee_with_http_info: #{e}"
|
501
|
+
end
|
502
|
+
```
|
664
503
|
|
504
|
+
### Parameters
|
665
505
|
|
666
|
-
Name | Type | Description
|
667
|
-
|
668
|
-
**
|
506
|
+
| Name | Type | Description | Notes |
|
507
|
+
| ---- | ---- | ----------- | ----- |
|
508
|
+
| **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md) | Post payees to create. | [optional] |
|
669
509
|
|
670
510
|
### Return type
|
671
511
|
|
672
|
-
[**
|
512
|
+
[**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
|
673
513
|
|
674
514
|
### Authorization
|
675
515
|
|
@@ -683,16 +523,16 @@ Name | Type | Description | Notes
|
|
683
523
|
|
684
524
|
## v4_create_payee
|
685
525
|
|
686
|
-
> CreatePayeesCSVResponse2 v4_create_payee(opts)
|
526
|
+
> <CreatePayeesCSVResponse2> v4_create_payee(opts)
|
687
527
|
|
688
528
|
Initiate Payee Creation
|
689
529
|
|
690
530
|
Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
691
531
|
|
692
|
-
###
|
532
|
+
### Examples
|
693
533
|
|
694
534
|
```ruby
|
695
|
-
|
535
|
+
require 'time'
|
696
536
|
require 'velopayments'
|
697
537
|
# setup authorization
|
698
538
|
VeloPayments.configure do |config|
|
@@ -702,24 +542,41 @@ end
|
|
702
542
|
|
703
543
|
api_instance = VeloPayments::PayeeInvitationApi.new
|
704
544
|
opts = {
|
705
|
-
create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
|
545
|
+
create_payees_request2: VeloPayments::CreatePayeesRequest2.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', payees: [VeloPayments::CreatePayee2.new({email: 'bob@example.com', remote_id: 'Remote ID', type: VeloPayments::PayeeType::INDIVIDUAL, address: VeloPayments::CreatePayeeAddress2.new({line1: '500 Duval St', city: 'Key West', country: 'AF'})})]}) # CreatePayeesRequest2 | Post payees to create.
|
706
546
|
}
|
707
547
|
|
708
548
|
begin
|
709
|
-
#Initiate Payee Creation
|
549
|
+
# Initiate Payee Creation
|
710
550
|
result = api_instance.v4_create_payee(opts)
|
711
551
|
p result
|
712
552
|
rescue VeloPayments::ApiError => e
|
713
|
-
puts "
|
553
|
+
puts "Error when calling PayeeInvitationApi->v4_create_payee: #{e}"
|
714
554
|
end
|
715
555
|
```
|
716
556
|
|
717
|
-
|
557
|
+
#### Using the v4_create_payee_with_http_info variant
|
558
|
+
|
559
|
+
This returns an Array which contains the response data, status code and headers.
|
560
|
+
|
561
|
+
> <Array(<CreatePayeesCSVResponse2>, Integer, Hash)> v4_create_payee_with_http_info(opts)
|
718
562
|
|
563
|
+
```ruby
|
564
|
+
begin
|
565
|
+
# Initiate Payee Creation
|
566
|
+
data, status_code, headers = api_instance.v4_create_payee_with_http_info(opts)
|
567
|
+
p status_code # => 2xx
|
568
|
+
p headers # => { ... }
|
569
|
+
p data # => <CreatePayeesCSVResponse2>
|
570
|
+
rescue VeloPayments::ApiError => e
|
571
|
+
puts "Error when calling PayeeInvitationApi->v4_create_payee_with_http_info: #{e}"
|
572
|
+
end
|
573
|
+
```
|
574
|
+
|
575
|
+
### Parameters
|
719
576
|
|
720
|
-
Name | Type | Description
|
721
|
-
|
722
|
-
**create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
|
577
|
+
| Name | Type | Description | Notes |
|
578
|
+
| ---- | ---- | ----------- | ----- |
|
579
|
+
| **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md) | Post payees to create. | [optional] |
|
723
580
|
|
724
581
|
### Return type
|
725
582
|
|