velopayments 2.20.119 → 2.23.78.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 +5 -5
- data/Makefile +5 -2
- data/README.md +116 -45
- data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +2 -2
- data/docs/AutoTopUpConfig2.md +23 -0
- data/docs/Challenge2.md +19 -0
- data/docs/CountriesApi.md +25 -25
- data/docs/CreateFundingAccountRequestV2.md +29 -0
- data/docs/CreatePayee2.md +3 -3
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +1 -1
- data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +3 -3
- data/docs/CreateWebhookRequest.md +23 -0
- data/docs/CurrenciesApi.md +6 -6
- data/docs/FundingAccountResponse.md +15 -7
- data/docs/FundingAccountResponse2.md +35 -0
- data/docs/{CurrencyType.md → FundingAccountType.md} +2 -3
- data/docs/FundingAudit.md +5 -5
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerApi.md +329 -32
- data/docs/FundingManagerPrivateApi.md +7 -7
- data/docs/FundingPayorStatusAuditResponse.md +2 -2
- data/docs/FundingRequestV3.md +19 -0
- data/docs/FxSummaryV3.md +1 -1
- data/docs/FxSummaryV4.md +1 -1
- data/docs/GetFundingsResponse.md +5 -1
- data/docs/GetFundingsResponseLinks.md +19 -0
- data/docs/GetPayeeListResponse.md +49 -0
- data/docs/GetPayeeListResponseCompany.md +19 -0
- data/docs/GetPayeeListResponseIndividual.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
- data/docs/InlineResponse404.md +19 -0
- data/docs/InlineResponse404Errors.md +23 -0
- data/docs/InlineResponse412.md +19 -0
- data/docs/InlineResponse412Errors.md +23 -0
- data/docs/{UserResponse2Roles.md → InvitationStatus2.md} +2 -3
- data/docs/ListFundingAccountsResponse2.md +21 -0
- data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
- data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
- data/docs/ListPaymentsResponseV4.md +1 -1
- data/docs/ListSourceAccountResponseV2.md +1 -1
- data/docs/ListSourceAccountResponseV2Links.md +19 -0
- data/docs/ListSourceAccountResponseV3.md +21 -0
- data/docs/ListSourceAccountResponseV3Links.md +19 -0
- data/docs/LoginApi.md +6 -2
- data/docs/MarketingOptIn.md +1 -1
- data/docs/Name.md +23 -0
- data/docs/Notifications2.md +17 -0
- data/docs/PagedPayeeResponse2.md +1 -1
- data/docs/PagedPaymentsResponseV3.md +21 -0
- data/docs/Payee.md +2 -2
- data/docs/Payee2.md +2 -2
- data/docs/{PayeeResponseV3.md → PayeeDetailResponse.md} +9 -7
- data/docs/PayeeDetailResponse2.md +73 -0
- data/docs/PayeeInvitationApi.md +227 -2
- data/docs/PayeePayorRef2.md +25 -0
- data/docs/PayeePayorRefV2.md +1 -1
- data/docs/PayeePayorRefV3.md +3 -3
- data/docs/PayeeResponse.md +2 -2
- data/docs/PayeeResponseV2.md +3 -3
- data/docs/PayeeType2.md +16 -0
- data/docs/PayeeUserSelfUpdateRequest.md +27 -0
- data/docs/PayeesApi.md +421 -8
- data/docs/PaymentAuditServiceApi.md +267 -35
- data/docs/PaymentDeltaResponseV4.md +21 -0
- data/docs/PaymentDeltaV4.md +31 -0
- data/docs/PaymentEventResponseV3.md +1 -1
- data/docs/PaymentEventResponseV4.md +1 -1
- data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +5 -3
- data/docs/PaymentResponseV3.md +1 -1
- data/docs/PaymentResponseV4.md +7 -1
- data/docs/PaymentV3.md +37 -0
- data/docs/PayorV1.md +3 -1
- data/docs/PayorV2.md +5 -1
- data/docs/PayorsApi.md +14 -14
- data/docs/PayoutCompanyV3.md +17 -0
- data/docs/PayoutIndividualV3.md +17 -0
- data/docs/PayoutNameV3.md +19 -0
- data/docs/PayoutPayeeV3.md +21 -0
- data/docs/PayoutServiceApi.md +393 -0
- data/docs/PayoutSummaryAuditV4.md +4 -2
- data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
- data/docs/PingResponse.md +19 -0
- data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +4 -4
- data/docs/QuoteResponseV3.md +17 -0
- data/docs/{Region.md → RegionV2.md} +2 -2
- data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +2 -2
- data/docs/SourceAccountResponse.md +3 -1
- data/docs/SourceAccountResponseV2.md +4 -2
- data/docs/SourceAccountResponseV3.md +47 -0
- data/docs/SourceAccountType.md +16 -0
- data/docs/{SourceAccount.md → SourceAccountV3.md} +2 -2
- data/docs/SupportedCountriesResponseV2.md +17 -0
- data/docs/{SupportedCountry2.md → SupportedCountryV2.md} +3 -3
- data/docs/SupportedCurrencyResponseV2.md +17 -0
- data/docs/{SupportedCurrency.md → SupportedCurrencyV2.md} +2 -2
- data/docs/TransferRequest2.md +21 -0
- data/docs/TransmissionType.md +16 -0
- data/docs/TransmissionTypes.md +21 -0
- data/docs/TransmissionTypes2.md +21 -0
- data/docs/UpdatePayeeDetailsRequest.md +29 -0
- data/docs/UpdatePayeeDetailsRequest2.md +29 -0
- data/docs/UpdateWebhookRequest.md +21 -0
- data/docs/UserResponse.md +1 -1
- data/docs/UsersApi.md +62 -6
- data/docs/WatchlistStatus2.md +16 -0
- data/docs/WebhookResponse.md +25 -0
- data/docs/WebhooksApi.md +280 -0
- data/docs/WebhooksResponse.md +21 -0
- data/docs/WithdrawPaymentRequest.md +17 -0
- data/lib/velopayments.rb +68 -32
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +516 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +14 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +312 -33
- data/lib/velopayments/api/payees_api.rb +582 -46
- data/lib/velopayments/api/payment_audit_service_api.rb +444 -78
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +506 -0
- data/lib/velopayments/api/tokens_api.rb +6 -5
- data/lib/velopayments/api/users_api.rb +146 -54
- data/lib/velopayments/api/webhooks_api.rb +350 -0
- data/lib/velopayments/api_client.rb +47 -44
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +35 -8
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +13 -9
- data/lib/velopayments/models/access_token_response.rb +10 -6
- data/lib/velopayments/models/access_token_validation_request.rb +10 -6
- data/lib/velopayments/models/auth_response.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
- data/lib/velopayments/models/challenge.rb +10 -6
- data/lib/velopayments/models/challenge2.rb +285 -0
- data/lib/velopayments/models/company.rb +15 -11
- data/lib/velopayments/models/company2.rb +15 -11
- data/lib/velopayments/models/company_response.rb +10 -6
- data/lib/velopayments/models/company_v1.rb +15 -11
- data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
- data/lib/velopayments/models/create_individual.rb +10 -6
- data/lib/velopayments/models/create_individual2.rb +10 -6
- data/lib/velopayments/models/create_individual2_name.rb +10 -6
- data/lib/velopayments/models/create_payee.rb +10 -6
- data/lib/velopayments/models/create_payee2.rb +13 -9
- data/lib/velopayments/models/create_payee_address.rb +10 -6
- data/lib/velopayments/models/create_payee_address2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +10 -6
- data/lib/velopayments/models/create_payees_request.rb +10 -6
- data/lib/velopayments/models/create_payees_request2.rb +10 -6
- data/lib/velopayments/models/create_payment_channel.rb +10 -6
- data/lib/velopayments/models/create_payment_channel2.rb +10 -6
- data/lib/velopayments/models/create_payor_link_request.rb +10 -6
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +14 -10
- data/lib/velopayments/models/create_webhook_request.rb +315 -0
- data/lib/velopayments/models/error.rb +10 -6
- data/lib/velopayments/models/error_response.rb +10 -6
- data/lib/velopayments/models/failed_submission.rb +10 -6
- data/lib/velopayments/models/failed_submission2.rb +10 -6
- data/lib/velopayments/models/funding_account_response.rb +105 -10
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +106 -95
- data/lib/velopayments/models/funding_account_type.rb +37 -0
- data/lib/velopayments/models/funding_audit.rb +23 -17
- data/lib/velopayments/models/funding_event.rb +11 -7
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +47 -7
- data/lib/velopayments/models/funding_request_v1.rb +10 -6
- data/lib/velopayments/models/funding_request_v2.rb +10 -6
- data/lib/velopayments/models/funding_request_v3.rb +259 -0
- data/lib/velopayments/models/fx_summary_v3.rb +11 -7
- data/lib/velopayments/models/fx_summary_v4.rb +11 -7
- data/lib/velopayments/models/get_fundings_response.rb +37 -24
- data/lib/velopayments/models/{paged_response.rb → get_fundings_response_links.rb} +26 -24
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +85 -113
- data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +14 -10
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -9
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +25 -11
- data/lib/velopayments/models/get_payout_statistics.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v4.rb +10 -6
- data/lib/velopayments/models/individual.rb +10 -6
- data/lib/velopayments/models/individual2.rb +10 -6
- data/lib/velopayments/models/individual_response.rb +10 -6
- data/lib/velopayments/models/individual_v1.rb +10 -6
- data/lib/velopayments/models/individual_v1_name.rb +10 -6
- data/lib/velopayments/models/inline_response400.rb +10 -6
- data/lib/velopayments/models/inline_response400_errors.rb +10 -6
- data/lib/velopayments/models/inline_response401.rb +10 -6
- data/lib/velopayments/models/inline_response401_errors.rb +10 -6
- data/lib/velopayments/models/inline_response403.rb +10 -6
- data/lib/velopayments/models/inline_response403_errors.rb +10 -6
- data/lib/velopayments/models/inline_response404.rb +225 -0
- data/lib/velopayments/models/inline_response404_errors.rb +240 -0
- data/lib/velopayments/models/inline_response409.rb +10 -6
- data/lib/velopayments/models/inline_response409_errors.rb +10 -6
- data/lib/velopayments/models/inline_response412.rb +225 -0
- data/lib/velopayments/models/inline_response412_errors.rb +240 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invitation_status_response.rb +10 -6
- data/lib/velopayments/models/invite_payee_request.rb +10 -6
- data/lib/velopayments/models/invite_payee_request2.rb +10 -6
- data/lib/velopayments/models/invite_user_request.rb +19 -15
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/language.rb +3 -2
- data/lib/velopayments/models/language2.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +14 -10
- data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +13 -9
- data/lib/velopayments/models/list_payments_response_v4.rb +11 -7
- data/lib/velopayments/models/list_source_account_response.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_links.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_page.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_v2.rb +11 -7
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
- data/lib/velopayments/models/location_type.rb +3 -2
- data/lib/velopayments/models/marketing_opt_in.rb +11 -7
- data/lib/velopayments/models/mfa_details.rb +10 -6
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +333 -0
- data/lib/velopayments/models/notifications.rb +10 -6
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → notifications2.rb} +20 -18
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/ofac_status2.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/page_for_response.rb +10 -6
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_response2.rb +11 -7
- data/lib/velopayments/models/paged_payee_response2_summary.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_summary.rb +10 -6
- data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
- data/lib/velopayments/models/paged_user_response.rb +10 -6
- data/lib/velopayments/models/paged_user_response_links.rb +10 -6
- data/lib/velopayments/models/paged_user_response_page.rb +10 -6
- data/lib/velopayments/models/password_request.rb +10 -6
- data/lib/velopayments/models/payee.rb +12 -8
- data/lib/velopayments/models/payee2.rb +12 -8
- data/lib/velopayments/models/payee_address.rb +10 -6
- data/lib/velopayments/models/payee_address2.rb +10 -6
- data/lib/velopayments/models/payee_delta.rb +10 -6
- data/lib/velopayments/models/payee_delta2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_page.rb +10 -6
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +30 -17
- data/lib/velopayments/models/payee_detail_response2.rb +475 -0
- data/lib/velopayments/models/payee_invitation_status.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel2.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref2.rb +248 -0
- data/lib/velopayments/models/payee_payor_ref_v2.rb +11 -7
- data/lib/velopayments/models/payee_payor_ref_v3.rb +12 -42
- data/lib/velopayments/models/payee_response.rb +12 -8
- data/lib/velopayments/models/payee_response_v2.rb +13 -9
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/payee_type2.rb +37 -0
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +54 -194
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +10 -6
- data/lib/velopayments/models/payment_channel_rule.rb +10 -6
- data/lib/velopayments/models/payment_channel_rules_response.rb +10 -6
- data/lib/velopayments/models/payment_delta.rb +10 -6
- data/lib/velopayments/models/payment_delta_response.rb +10 -6
- data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
- data/lib/velopayments/models/payment_delta_v4.rb +289 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_event_response_v4.rb +11 -7
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +27 -13
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_response_v4.rb +39 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +10 -6
- data/lib/velopayments/models/payment_v3.rb +363 -0
- data/lib/velopayments/models/payor_address.rb +10 -6
- data/lib/velopayments/models/payor_address_v2.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +10 -6
- data/lib/velopayments/models/payor_branding_response.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_request.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_response.rb +10 -6
- data/lib/velopayments/models/payor_create_application_request.rb +10 -6
- data/lib/velopayments/models/payor_email_opt_out_request.rb +10 -6
- data/lib/velopayments/models/payor_links_response.rb +10 -6
- data/lib/velopayments/models/payor_links_response_links.rb +10 -6
- data/lib/velopayments/models/payor_links_response_payors.rb +10 -6
- data/lib/velopayments/models/payor_logo_request.rb +10 -6
- data/lib/velopayments/models/payor_v1.rb +23 -10
- data/lib/velopayments/models/payor_v2.rb +33 -10
- data/lib/velopayments/models/payout_company_v3.rb +215 -0
- data/lib/velopayments/models/payout_individual_v3.rb +215 -0
- data/lib/velopayments/models/payout_name_v3.rb +229 -0
- data/lib/velopayments/models/payout_payee_v3.rb +234 -0
- data/lib/velopayments/models/payout_payor_v4.rb +10 -6
- data/lib/velopayments/models/payout_principal_v4.rb +10 -6
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/payout_status_v4.rb +3 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +10 -6
- data/lib/velopayments/models/payout_summary_audit_v4.rb +22 -9
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +32 -14
- data/lib/velopayments/models/payout_type_v4.rb +3 -2
- data/lib/velopayments/models/ping_response.rb +219 -0
- data/lib/velopayments/models/query_batch_response.rb +10 -6
- data/lib/velopayments/models/query_batch_response2.rb +10 -6
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +15 -11
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +14 -10
- data/lib/velopayments/models/{region.rb → region_v2.rb} +13 -9
- data/lib/velopayments/models/register_sms_request.rb +13 -9
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +13 -9
- data/lib/velopayments/models/resend_token_request.rb +10 -6
- data/lib/velopayments/models/reset_password_request.rb +10 -6
- data/lib/velopayments/models/role.rb +10 -6
- data/lib/velopayments/models/role_update_request.rb +10 -6
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +10 -6
- data/lib/velopayments/models/self_update_password_request.rb +10 -6
- data/lib/velopayments/models/set_notifications_request.rb +10 -6
- data/lib/velopayments/models/source_account_response.rb +24 -11
- data/lib/velopayments/models/source_account_response_v2.rb +26 -13
- data/lib/velopayments/models/source_account_response_v3.rb +437 -0
- data/lib/velopayments/models/source_account_summary_v3.rb +10 -6
- data/lib/velopayments/models/source_account_summary_v4.rb +10 -6
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +13 -9
- data/lib/velopayments/models/supported_countries_response.rb +10 -6
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +14 -10
- data/lib/velopayments/models/supported_country.rb +10 -6
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +13 -9
- data/lib/velopayments/models/transfer_request.rb +10 -6
- data/lib/velopayments/models/transfer_request2.rb +301 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{list_payments_response_page.rb → transmission_types.rb} +50 -46
- data/lib/velopayments/models/transmission_types2.rb +246 -0
- data/lib/velopayments/models/unregister_mfa_request.rb +10 -6
- data/lib/velopayments/models/update_payee_details_request.rb +266 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
- data/lib/velopayments/models/update_remote_id_request.rb +10 -6
- data/lib/velopayments/models/update_webhook_request.rb +288 -0
- data/lib/velopayments/models/user_details_update_request.rb +19 -15
- data/lib/velopayments/models/user_info.rb +10 -6
- data/lib/velopayments/models/user_response.rb +20 -16
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +10 -6
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/watchlist_status2.rb +40 -0
- data/lib/velopayments/models/webhook_response.rb +246 -0
- data/lib/velopayments/models/webhooks_response.rb +233 -0
- data/lib/velopayments/models/{currency_type.rb → withdraw_payment_request.rb} +39 -34
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +93 -18
- data/spec/api/funding_manager_private_api_spec.rb +5 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +57 -4
- data/spec/api/payees_api_spec.rb +108 -4
- data/spec/api/payment_audit_service_api_spec.rb +72 -18
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +127 -0
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +17 -4
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
- data/spec/models/access_token_response_spec.rb +2 -2
- data/spec/models/access_token_validation_request_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +2 -2
- data/spec/models/auto_top_up_config2_spec.rb +59 -0
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company2_spec.rb +2 -2
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +2 -2
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
- data/spec/models/create_individual2_name_spec.rb +2 -2
- data/spec/models/create_individual2_spec.rb +2 -2
- data/spec/models/create_individual_spec.rb +2 -2
- data/spec/models/create_payee2_spec.rb +2 -2
- data/spec/models/create_payee_address2_spec.rb +2 -2
- data/spec/models/create_payee_address_spec.rb +2 -2
- data/spec/models/create_payee_spec.rb +2 -2
- data/spec/models/create_payees_csv_request2_spec.rb +2 -2
- data/spec/models/create_payees_csv_request_spec.rb +2 -2
- data/spec/models/create_payees_csv_response2_spec.rb +2 -2
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payor_link_request_spec.rb +2 -2
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
- data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/failed_submission2_spec.rb +2 -2
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response2_spec.rb +95 -0
- data/spec/models/funding_account_response_spec.rb +26 -2
- data/spec/models/funding_account_type_spec.rb +35 -0
- data/spec/models/funding_audit_spec.rb +8 -8
- data/spec/models/funding_event_spec.rb +2 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/funding_request_v3_spec.rb +47 -0
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/get_fundings_response_links_spec.rb +47 -0
- data/spec/models/get_fundings_response_spec.rb +14 -2
- data/spec/models/get_payee_list_response_company_spec.rb +47 -0
- data/spec/models/get_payee_list_response_individual_spec.rb +41 -0
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response_spec.rb} +21 -39
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual2_spec.rb +2 -2
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +2 -2
- data/spec/models/individual_v1_name_spec.rb +2 -2
- data/spec/models/individual_v1_spec.rb +2 -2
- data/spec/models/inline_response400_errors_spec.rb +2 -2
- data/spec/models/inline_response400_spec.rb +2 -2
- data/spec/models/inline_response401_errors_spec.rb +2 -2
- data/spec/models/inline_response401_spec.rb +2 -2
- data/spec/models/inline_response403_errors_spec.rb +2 -2
- data/spec/models/inline_response403_spec.rb +2 -2
- data/spec/models/inline_response404_errors_spec.rb +59 -0
- data/spec/models/inline_response404_spec.rb +47 -0
- data/spec/models/inline_response409_errors_spec.rb +2 -2
- data/spec/models/inline_response409_spec.rb +2 -2
- data/spec/models/inline_response412_errors_spec.rb +59 -0
- data/spec/models/inline_response412_spec.rb +47 -0
- data/spec/models/invitation_status2_spec.rb +35 -0
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request2_spec.rb +2 -2
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/invite_user_request_spec.rb +2 -2
- data/spec/models/kyc_state_spec.rb +2 -2
- data/spec/models/language2_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/link_for_response_spec.rb +2 -2
- data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
- data/spec/models/list_funding_accounts_response_spec.rb +2 -2
- data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
- data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
- data/spec/models/list_payments_response_v4_spec.rb +2 -2
- data/spec/models/list_source_account_response_links_spec.rb +2 -2
- data/spec/models/list_source_account_response_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v3_spec.rb +53 -0
- data/spec/models/location_type_spec.rb +2 -2
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/mfa_details_spec.rb +2 -2
- data/spec/models/mfa_type_spec.rb +2 -2
- data/spec/models/name_spec.rb +59 -0
- data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status2_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status2_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/page_for_response_spec.rb +2 -2
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/paged_payee_response2_spec.rb +2 -2
- data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
- data/spec/models/paged_payee_response_links_spec.rb +2 -2
- data/spec/models/paged_payee_response_page_spec.rb +2 -2
- data/spec/models/paged_payee_response_spec.rb +2 -2
- data/spec/models/paged_payee_response_summary_spec.rb +2 -2
- data/spec/models/paged_payments_response_v3_spec.rb +53 -0
- data/spec/models/paged_user_response_links_spec.rb +2 -2
- data/spec/models/paged_user_response_page_spec.rb +2 -2
- data/spec/models/paged_user_response_spec.rb +2 -2
- data/spec/models/password_request_spec.rb +2 -2
- data/spec/models/payee2_spec.rb +2 -2
- data/spec/models/payee_address2_spec.rb +2 -2
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +2 -2
- data/spec/models/payee_delta_response2_links_spec.rb +2 -2
- data/spec/models/payee_delta_response2_spec.rb +2 -2
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_detail_response2_spec.rb +209 -0
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -8
- data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
- data/spec/models/payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +2 -2
- data/spec/models/payee_payment_channel_spec.rb +2 -2
- data/spec/models/payee_payor_ref2_spec.rb +65 -0
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v3_spec.rb +2 -6
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +2 -2
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type2_spec.rb +35 -0
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payee_user_self_update_request_spec.rb +71 -0
- data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
- data/spec/models/payment_channel_country_spec.rb +2 -2
- data/spec/models/payment_channel_rule_spec.rb +2 -2
- data/spec/models/payment_channel_rules_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_v4_spec.rb +53 -0
- data/spec/models/payment_delta_spec.rb +2 -2
- data/spec/models/payment_delta_v4_spec.rb +83 -0
- data/spec/models/payment_event_response_v3_spec.rb +2 -2
- data/spec/models/payment_event_response_v4_spec.rb +2 -2
- data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -8
- data/spec/models/payment_rails_spec.rb +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +2 -2
- data/spec/models/payment_response_v4_spec.rb +20 -2
- data/spec/models/payment_v3_spec.rb +105 -0
- data/spec/models/payor_address_spec.rb +2 -2
- data/spec/models/payor_address_v2_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +8 -2
- data/spec/models/payor_v2_spec.rb +14 -2
- data/spec/models/{get_fundings_response_all_of_spec.rb → payout_company_v3_spec.rb} +9 -9
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
- data/spec/models/payout_name_v3_spec.rb +47 -0
- data/spec/models/payout_payee_v3_spec.rb +53 -0
- data/spec/models/payout_payor_v4_spec.rb +2 -2
- data/spec/models/payout_principal_v4_spec.rb +2 -2
- data/spec/models/payout_status_v3_spec.rb +2 -2
- data/spec/models/payout_status_v4_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/ping_response_spec.rb +47 -0
- data/spec/models/query_batch_response2_spec.rb +2 -2
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
- data/spec/models/register_sms_request_spec.rb +2 -2
- data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
- data/spec/models/resend_token_request_spec.rb +2 -2
- data/spec/models/reset_password_request_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_update_request_spec.rb +2 -2
- data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
- data/spec/models/self_update_password_request_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +8 -2
- data/spec/models/source_account_response_v2_spec.rb +8 -2
- data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
- data/spec/models/source_account_summary_v3_spec.rb +2 -2
- data/spec/models/source_account_summary_v4_spec.rb +2 -2
- data/spec/models/source_account_type_spec.rb +35 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
- data/spec/models/transfer_request2_spec.rb +53 -0
- data/spec/models/transfer_request_spec.rb +2 -2
- data/spec/models/transmission_type_spec.rb +35 -0
- data/spec/models/transmission_types2_spec.rb +53 -0
- data/spec/models/transmission_types_spec.rb +53 -0
- data/spec/models/unregister_mfa_request_spec.rb +2 -2
- data/spec/models/update_payee_details_request2_spec.rb +77 -0
- data/spec/models/update_payee_details_request_spec.rb +77 -0
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/update_webhook_request_spec.rb +53 -0
- data/spec/models/user_details_update_request_spec.rb +2 -2
- data/spec/models/user_info_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_status_spec.rb +2 -2
- data/spec/models/user_type2_spec.rb +2 -2
- data/spec/models/user_type_spec.rb +2 -2
- data/spec/models/validate_password_response_spec.rb +2 -2
- data/spec/models/watchlist_status2_spec.rb +35 -0
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/models/{paged_response_page_spec.rb → webhook_response_spec.rb} +13 -13
- data/spec/models/webhooks_response_spec.rb +53 -0
- data/spec/models/withdraw_payment_request_spec.rb +41 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +61 -11
- data/specs/api/payees_api_spec.rb +101 -14
- data/specs/api/payment_audit_service_api_spec.rb +231 -30
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/velopayments.gemspec +3 -4
- metadata +444 -326
- data/Gemfile.lock +0 -70
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/spec/api/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/payout_history_api_spec.rb +0 -95
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/payout_history_api_spec.rb +0 -95
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
- data/velopayments-2.20.118.gem +0 -0
@@ -0,0 +1,25 @@
|
|
1
|
+
# VeloPayments::PayeePayorRef2
|
2
|
+
|
3
|
+
## Properties
|
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]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'VeloPayments'
|
17
|
+
|
18
|
+
instance = VeloPayments::PayeePayorRef2.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
|
19
|
+
remote_id: uniqueIdForRemoteEntity,
|
20
|
+
invitation_status: null,
|
21
|
+
invitation_status_timestamp: 2019-01-20T09:00Z,
|
22
|
+
payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/PayeePayorRefV2.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**payor_id** | **String** | | [optional]
|
8
8
|
**remote_id** | **String** | | [optional]
|
9
9
|
**invitation_status** | **String** | | [optional]
|
10
|
-
**invitation_status_timestamp** | **
|
10
|
+
**invitation_status_timestamp** | **Time** | The timestamp when the invitation status is updated | [optional]
|
11
11
|
**payment_channel_id** | **String** | | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
data/docs/PayeePayorRefV3.md
CHANGED
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**payor_id** | **String** | | [optional]
|
8
8
|
**remote_id** | **String** | | [optional]
|
9
|
-
**invitation_status** | **
|
10
|
-
**invitation_status_timestamp** | **
|
9
|
+
**invitation_status** | [**InvitationStatus2**](InvitationStatus2.md) | | [optional]
|
10
|
+
**invitation_status_timestamp** | **Time** | The timestamp when the invitation status is updated | [optional]
|
11
11
|
**payment_channel_id** | **String** | | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
@@ -17,7 +17,7 @@ require 'VeloPayments'
|
|
17
17
|
|
18
18
|
instance = VeloPayments::PayeePayorRefV3.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
|
19
19
|
remote_id: uniqueIdForRemoteEntity,
|
20
|
-
invitation_status:
|
20
|
+
invitation_status: null,
|
21
21
|
invitation_status_timestamp: 2019-01-20T09:00Z,
|
22
22
|
payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3)
|
23
23
|
```
|
data/docs/PayeeResponse.md
CHANGED
@@ -13,12 +13,12 @@ Name | Type | Description | Notes
|
|
13
13
|
**payment_channel** | [**PayeePaymentChannel**](PayeePaymentChannel.md) | | [optional]
|
14
14
|
**challenge** | [**Challenge**](Challenge.md) | | [optional]
|
15
15
|
**language** | [**Language**](Language.md) | | [optional]
|
16
|
-
**accept_terms_and_conditions_timestamp** | **
|
16
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
17
17
|
**cellphone_number** | **String** | | [optional]
|
18
18
|
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
19
19
|
**company** | [**CompanyResponse**](CompanyResponse.md) | | [optional]
|
20
20
|
**individual** | [**IndividualResponse**](IndividualResponse.md) | | [optional]
|
21
|
-
**created** | **
|
21
|
+
**created** | **Time** | | [optional]
|
22
22
|
**grace_period_end_date** | **Date** | | [optional] [readonly]
|
23
23
|
**last_ofac_check_timestamp** | **String** | | [optional] [readonly]
|
24
24
|
**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) | | [optional]
|
data/docs/PayeeResponseV2.md
CHANGED
@@ -10,13 +10,13 @@ Name | Type | Description | Notes
|
|
10
10
|
**onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
|
11
11
|
**ofac_status** | [**OfacStatus2**](OfacStatus2.md) | | [optional]
|
12
12
|
**language** | [**Language2**](Language2.md) | | [optional]
|
13
|
-
**created** | **
|
13
|
+
**created** | **Time** | | [optional]
|
14
14
|
**country** | **String** | | [optional]
|
15
15
|
**display_name** | **String** | | [optional]
|
16
16
|
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
17
17
|
**disabled** | **Boolean** | | [optional]
|
18
18
|
**disabled_comment** | **String** | | [optional]
|
19
|
-
**disabled_updated_timestamp** | **
|
19
|
+
**disabled_updated_timestamp** | **Time** | | [optional]
|
20
20
|
**address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
|
21
21
|
**individual** | [**Individual**](Individual.md) | | [optional]
|
22
22
|
**company** | [**Company**](Company.md) | | [optional]
|
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
|
|
32
32
|
**pause_payment_timestamp** | **String** | | [optional]
|
33
33
|
**marketing_opt_in_decision** | **Boolean** | | [optional]
|
34
34
|
**marketing_opt_in_timestamp** | **String** | | [optional]
|
35
|
-
**accept_terms_and_conditions_timestamp** | **
|
35
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
36
36
|
|
37
37
|
## Code Sample
|
38
38
|
|
data/docs/PayeeType2.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# VeloPayments::PayeeType2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'VeloPayments'
|
12
|
+
|
13
|
+
instance = VeloPayments::PayeeType2.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# VeloPayments::PayeeUserSelfUpdateRequest
|
2
|
+
|
3
|
+
## Properties
|
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]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'VeloPayments'
|
18
|
+
|
19
|
+
instance = VeloPayments::PayeeUserSelfUpdateRequest.new(primary_contact_number: 11235555555,
|
20
|
+
secondary_contact_number: 11235555550,
|
21
|
+
first_name: John,
|
22
|
+
last_name: Doe,
|
23
|
+
email: foo@example.com,
|
24
|
+
sms_number: 11235555555)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/PayeesApi.md
CHANGED
@@ -6,15 +6,22 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**delete_payee_by_id_v1**](PayeesApi.md#delete_payee_by_id_v1) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
|
8
8
|
[**delete_payee_by_id_v3**](PayeesApi.md#delete_payee_by_id_v3) | **DELETE** /v3/payees/{payeeId} | Delete Payee by Id
|
9
|
+
[**delete_payee_by_id_v4**](PayeesApi.md#delete_payee_by_id_v4) | **DELETE** /v4/payees/{payeeId} | Delete Payee by Id
|
9
10
|
[**get_payee_by_id_v1**](PayeesApi.md#get_payee_by_id_v1) | **GET** /v1/payees/{payeeId} | Get Payee by Id
|
10
11
|
[**get_payee_by_id_v2**](PayeesApi.md#get_payee_by_id_v2) | **GET** /v2/payees/{payeeId} | Get Payee by Id
|
11
12
|
[**get_payee_by_id_v3**](PayeesApi.md#get_payee_by_id_v3) | **GET** /v3/payees/{payeeId} | Get Payee by Id
|
13
|
+
[**get_payee_by_id_v4**](PayeesApi.md#get_payee_by_id_v4) | **GET** /v4/payees/{payeeId} | Get Payee by Id
|
12
14
|
[**list_payee_changes**](PayeesApi.md#list_payee_changes) | **GET** /v1/deltas/payees | List Payee Changes
|
13
15
|
[**list_payee_changes_v3**](PayeesApi.md#list_payee_changes_v3) | **GET** /v3/payees/deltas | List Payee Changes
|
16
|
+
[**list_payee_changes_v4**](PayeesApi.md#list_payee_changes_v4) | **GET** /v4/payees/deltas | List Payee Changes
|
14
17
|
[**list_payees_v1**](PayeesApi.md#list_payees_v1) | **GET** /v1/payees | List Payees V1
|
15
18
|
[**list_payees_v3**](PayeesApi.md#list_payees_v3) | **GET** /v3/payees | List Payees
|
19
|
+
[**list_payees_v4**](PayeesApi.md#list_payees_v4) | **GET** /v4/payees | List Payees
|
20
|
+
[**payee_details_update_v3**](PayeesApi.md#payee_details_update_v3) | **POST** /v3/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details
|
21
|
+
[**payee_details_update_v4**](PayeesApi.md#payee_details_update_v4) | **POST** /v4/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details
|
16
22
|
[**v1_payees_payee_id_remote_id_update_post**](PayeesApi.md#v1_payees_payee_id_remote_id_update_post) | **POST** /v1/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
|
17
23
|
[**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
|
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
|
18
25
|
|
19
26
|
|
20
27
|
|
@@ -120,6 +127,57 @@ nil (empty response body)
|
|
120
127
|
- **Accept**: Not defined
|
121
128
|
|
122
129
|
|
130
|
+
## delete_payee_by_id_v4
|
131
|
+
|
132
|
+
> delete_payee_by_id_v4(payee_id)
|
133
|
+
|
134
|
+
Delete Payee by Id
|
135
|
+
|
136
|
+
<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
|
+
|
138
|
+
### Example
|
139
|
+
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'velopayments'
|
143
|
+
# setup authorization
|
144
|
+
VeloPayments.configure do |config|
|
145
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
146
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
147
|
+
end
|
148
|
+
|
149
|
+
api_instance = VeloPayments::PayeesApi.new
|
150
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
151
|
+
|
152
|
+
begin
|
153
|
+
#Delete Payee by Id
|
154
|
+
api_instance.delete_payee_by_id_v4(payee_id)
|
155
|
+
rescue VeloPayments::ApiError => e
|
156
|
+
puts "Exception when calling PayeesApi->delete_payee_by_id_v4: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
|
163
|
+
Name | Type | Description | Notes
|
164
|
+
------------- | ------------- | ------------- | -------------
|
165
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
166
|
+
|
167
|
+
### Return type
|
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
|
179
|
+
|
180
|
+
|
123
181
|
## get_payee_by_id_v1
|
124
182
|
|
125
183
|
> Payee get_payee_by_id_v1(payee_id, opts)
|
@@ -234,7 +292,7 @@ Name | Type | Description | Notes
|
|
234
292
|
|
235
293
|
## get_payee_by_id_v3
|
236
294
|
|
237
|
-
>
|
295
|
+
> PayeeDetailResponse get_payee_by_id_v3(payee_id, opts)
|
238
296
|
|
239
297
|
Get Payee by Id
|
240
298
|
|
@@ -276,7 +334,63 @@ Name | Type | Description | Notes
|
|
276
334
|
|
277
335
|
### Return type
|
278
336
|
|
279
|
-
[**
|
337
|
+
[**PayeeDetailResponse**](PayeeDetailResponse.md)
|
338
|
+
|
339
|
+
### Authorization
|
340
|
+
|
341
|
+
[OAuth2](../README.md#OAuth2)
|
342
|
+
|
343
|
+
### HTTP request headers
|
344
|
+
|
345
|
+
- **Content-Type**: Not defined
|
346
|
+
- **Accept**: application/json
|
347
|
+
|
348
|
+
|
349
|
+
## get_payee_by_id_v4
|
350
|
+
|
351
|
+
> PayeeDetailResponse2 get_payee_by_id_v4(payee_id, opts)
|
352
|
+
|
353
|
+
Get Payee by Id
|
354
|
+
|
355
|
+
Get Payee by Id
|
356
|
+
|
357
|
+
### Example
|
358
|
+
|
359
|
+
```ruby
|
360
|
+
# load the gem
|
361
|
+
require 'velopayments'
|
362
|
+
# setup authorization
|
363
|
+
VeloPayments.configure do |config|
|
364
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
365
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
366
|
+
end
|
367
|
+
|
368
|
+
api_instance = VeloPayments::PayeesApi.new
|
369
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
370
|
+
opts = {
|
371
|
+
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
|
+
}
|
373
|
+
|
374
|
+
begin
|
375
|
+
#Get Payee by Id
|
376
|
+
result = api_instance.get_payee_by_id_v4(payee_id, opts)
|
377
|
+
p result
|
378
|
+
rescue VeloPayments::ApiError => e
|
379
|
+
puts "Exception when calling PayeesApi->get_payee_by_id_v4: #{e}"
|
380
|
+
end
|
381
|
+
```
|
382
|
+
|
383
|
+
### Parameters
|
384
|
+
|
385
|
+
|
386
|
+
Name | Type | Description | Notes
|
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)
|
280
394
|
|
281
395
|
### Authorization
|
282
396
|
|
@@ -309,7 +423,7 @@ end
|
|
309
423
|
|
310
424
|
api_instance = VeloPayments::PayeesApi.new
|
311
425
|
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
312
|
-
updated_since =
|
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
|
313
427
|
opts = {
|
314
428
|
page: 1, # Integer | Page number. Default is 1.
|
315
429
|
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
@@ -330,7 +444,7 @@ end
|
|
330
444
|
Name | Type | Description | Notes
|
331
445
|
------------- | ------------- | ------------- | -------------
|
332
446
|
**payor_id** | [**String**](.md)| The Payor ID to find associated Payees |
|
333
|
-
**updated_since** | **
|
447
|
+
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
334
448
|
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
335
449
|
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
336
450
|
|
@@ -369,7 +483,7 @@ end
|
|
369
483
|
|
370
484
|
api_instance = VeloPayments::PayeesApi.new
|
371
485
|
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
372
|
-
updated_since =
|
486
|
+
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
|
373
487
|
opts = {
|
374
488
|
page: 1, # Integer | Page number. Default is 1.
|
375
489
|
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
@@ -390,7 +504,67 @@ end
|
|
390
504
|
Name | Type | Description | Notes
|
391
505
|
------------- | ------------- | ------------- | -------------
|
392
506
|
**payor_id** | [**String**](.md)| The Payor ID to find associated Payees |
|
393
|
-
**updated_since** | **
|
507
|
+
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
508
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
509
|
+
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
510
|
+
|
511
|
+
### Return type
|
512
|
+
|
513
|
+
[**PayeeDeltaResponse2**](PayeeDeltaResponse2.md)
|
514
|
+
|
515
|
+
### Authorization
|
516
|
+
|
517
|
+
[OAuth2](../README.md#OAuth2)
|
518
|
+
|
519
|
+
### HTTP request headers
|
520
|
+
|
521
|
+
- **Content-Type**: Not defined
|
522
|
+
- **Accept**: application/json
|
523
|
+
|
524
|
+
|
525
|
+
## list_payee_changes_v4
|
526
|
+
|
527
|
+
> PayeeDeltaResponse2 list_payee_changes_v4(payor_id, updated_since, opts)
|
528
|
+
|
529
|
+
List Payee Changes
|
530
|
+
|
531
|
+
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
|
+
|
533
|
+
### Example
|
534
|
+
|
535
|
+
```ruby
|
536
|
+
# load the gem
|
537
|
+
require 'velopayments'
|
538
|
+
# setup authorization
|
539
|
+
VeloPayments.configure do |config|
|
540
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
541
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
542
|
+
end
|
543
|
+
|
544
|
+
api_instance = VeloPayments::PayeesApi.new
|
545
|
+
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
546
|
+
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
|
+
opts = {
|
548
|
+
page: 1, # Integer | Page number. Default is 1.
|
549
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
550
|
+
}
|
551
|
+
|
552
|
+
begin
|
553
|
+
#List Payee Changes
|
554
|
+
result = api_instance.list_payee_changes_v4(payor_id, updated_since, opts)
|
555
|
+
p result
|
556
|
+
rescue VeloPayments::ApiError => e
|
557
|
+
puts "Exception when calling PayeesApi->list_payee_changes_v4: #{e}"
|
558
|
+
end
|
559
|
+
```
|
560
|
+
|
561
|
+
### Parameters
|
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 |
|
394
568
|
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
395
569
|
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
396
570
|
|
@@ -504,7 +678,8 @@ end
|
|
504
678
|
api_instance = VeloPayments::PayeesApi.new
|
505
679
|
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
506
680
|
opts = {
|
507
|
-
|
681
|
+
watchlist_status: VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
|
682
|
+
disabled: true, # Boolean | Payee disabled
|
508
683
|
onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
509
684
|
email: 'bob@example.com', # String | Email address
|
510
685
|
display_name: 'Bob Smith', # String | The display name of the payees.
|
@@ -531,13 +706,92 @@ end
|
|
531
706
|
Name | Type | Description | Notes
|
532
707
|
------------- | ------------- | ------------- | -------------
|
533
708
|
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
534
|
-
**
|
709
|
+
**watchlist_status** | [**WatchlistStatus**](.md)| The watchlistStatus of the payees. | [optional]
|
710
|
+
**disabled** | **Boolean**| Payee disabled | [optional]
|
711
|
+
**onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional]
|
712
|
+
**email** | [**String**](.md)| Email address | [optional]
|
713
|
+
**display_name** | **String**| The display name of the payees. | [optional]
|
714
|
+
**remote_id** | **String**| The remote id of the payees. | [optional]
|
715
|
+
**payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional]
|
716
|
+
**payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [optional]
|
717
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
718
|
+
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
719
|
+
**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
|
+
|
721
|
+
### Return type
|
722
|
+
|
723
|
+
[**PagedPayeeResponse2**](PagedPayeeResponse2.md)
|
724
|
+
|
725
|
+
### Authorization
|
726
|
+
|
727
|
+
[OAuth2](../README.md#OAuth2)
|
728
|
+
|
729
|
+
### HTTP request headers
|
730
|
+
|
731
|
+
- **Content-Type**: Not defined
|
732
|
+
- **Accept**: application/json
|
733
|
+
|
734
|
+
|
735
|
+
## list_payees_v4
|
736
|
+
|
737
|
+
> PagedPayeeResponse2 list_payees_v4(payor_id, opts)
|
738
|
+
|
739
|
+
List Payees
|
740
|
+
|
741
|
+
Get a paginated response listing the payees for a payor.
|
742
|
+
|
743
|
+
### Example
|
744
|
+
|
745
|
+
```ruby
|
746
|
+
# load the gem
|
747
|
+
require 'velopayments'
|
748
|
+
# setup authorization
|
749
|
+
VeloPayments.configure do |config|
|
750
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
751
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
752
|
+
end
|
753
|
+
|
754
|
+
api_instance = VeloPayments::PayeesApi.new
|
755
|
+
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
756
|
+
opts = {
|
757
|
+
watchlist_status: VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
|
758
|
+
disabled: true, # Boolean | Payee disabled
|
759
|
+
onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
760
|
+
email: 'bob@example.com', # String | Email address
|
761
|
+
display_name: 'Bob Smith', # String | The display name of the payees.
|
762
|
+
remote_id: 'remoteId123', # String | The remote id of the payees.
|
763
|
+
payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
764
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
765
|
+
ofac_status: VeloPayments::OfacStatus.new, # OfacStatus | The ofacStatus of the payees.
|
766
|
+
page: 1, # Integer | Page number. Default is 1.
|
767
|
+
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
768
|
+
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
|
+
}
|
770
|
+
|
771
|
+
begin
|
772
|
+
#List Payees
|
773
|
+
result = api_instance.list_payees_v4(payor_id, opts)
|
774
|
+
p result
|
775
|
+
rescue VeloPayments::ApiError => e
|
776
|
+
puts "Exception when calling PayeesApi->list_payees_v4: #{e}"
|
777
|
+
end
|
778
|
+
```
|
779
|
+
|
780
|
+
### Parameters
|
781
|
+
|
782
|
+
|
783
|
+
Name | Type | Description | Notes
|
784
|
+
------------- | ------------- | ------------- | -------------
|
785
|
+
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
786
|
+
**watchlist_status** | [**WatchlistStatus**](.md)| The watchlistStatus of the payees. | [optional]
|
787
|
+
**disabled** | **Boolean**| Payee disabled | [optional]
|
535
788
|
**onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional]
|
536
789
|
**email** | [**String**](.md)| Email address | [optional]
|
537
790
|
**display_name** | **String**| The display name of the payees. | [optional]
|
538
791
|
**remote_id** | **String**| The remote id of the payees. | [optional]
|
539
792
|
**payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional]
|
540
793
|
**payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [optional]
|
794
|
+
**ofac_status** | [**OfacStatus**](.md)| The ofacStatus of the payees. | [optional]
|
541
795
|
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
542
796
|
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
543
797
|
**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']
|
@@ -556,6 +810,112 @@ Name | Type | Description | Notes
|
|
556
810
|
- **Accept**: application/json
|
557
811
|
|
558
812
|
|
813
|
+
## payee_details_update_v3
|
814
|
+
|
815
|
+
> payee_details_update_v3(payee_id, update_payee_details_request)
|
816
|
+
|
817
|
+
Update Payee Details
|
818
|
+
|
819
|
+
<p>Update payee details for the given Payee Id.<p>
|
820
|
+
|
821
|
+
### Example
|
822
|
+
|
823
|
+
```ruby
|
824
|
+
# load the gem
|
825
|
+
require 'velopayments'
|
826
|
+
# setup authorization
|
827
|
+
VeloPayments.configure do |config|
|
828
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
829
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
830
|
+
end
|
831
|
+
|
832
|
+
api_instance = VeloPayments::PayeesApi.new
|
833
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
834
|
+
update_payee_details_request = VeloPayments::UpdatePayeeDetailsRequest.new # UpdatePayeeDetailsRequest | Request to update payee details
|
835
|
+
|
836
|
+
begin
|
837
|
+
#Update Payee Details
|
838
|
+
api_instance.payee_details_update_v3(payee_id, update_payee_details_request)
|
839
|
+
rescue VeloPayments::ApiError => e
|
840
|
+
puts "Exception when calling PayeesApi->payee_details_update_v3: #{e}"
|
841
|
+
end
|
842
|
+
```
|
843
|
+
|
844
|
+
### Parameters
|
845
|
+
|
846
|
+
|
847
|
+
Name | Type | Description | Notes
|
848
|
+
------------- | ------------- | ------------- | -------------
|
849
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
850
|
+
**update_payee_details_request** | [**UpdatePayeeDetailsRequest**](UpdatePayeeDetailsRequest.md)| Request to update payee details |
|
851
|
+
|
852
|
+
### Return type
|
853
|
+
|
854
|
+
nil (empty response body)
|
855
|
+
|
856
|
+
### Authorization
|
857
|
+
|
858
|
+
[OAuth2](../README.md#OAuth2)
|
859
|
+
|
860
|
+
### HTTP request headers
|
861
|
+
|
862
|
+
- **Content-Type**: application/json
|
863
|
+
- **Accept**: application/json
|
864
|
+
|
865
|
+
|
866
|
+
## payee_details_update_v4
|
867
|
+
|
868
|
+
> payee_details_update_v4(payee_id, update_payee_details_request2)
|
869
|
+
|
870
|
+
Update Payee Details
|
871
|
+
|
872
|
+
<p>Update payee details for the given Payee Id.<p>
|
873
|
+
|
874
|
+
### Example
|
875
|
+
|
876
|
+
```ruby
|
877
|
+
# load the gem
|
878
|
+
require 'velopayments'
|
879
|
+
# setup authorization
|
880
|
+
VeloPayments.configure do |config|
|
881
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
882
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
883
|
+
end
|
884
|
+
|
885
|
+
api_instance = VeloPayments::PayeesApi.new
|
886
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
887
|
+
update_payee_details_request2 = VeloPayments::UpdatePayeeDetailsRequest2.new # UpdatePayeeDetailsRequest2 | Request to update payee details
|
888
|
+
|
889
|
+
begin
|
890
|
+
#Update Payee Details
|
891
|
+
api_instance.payee_details_update_v4(payee_id, update_payee_details_request2)
|
892
|
+
rescue VeloPayments::ApiError => e
|
893
|
+
puts "Exception when calling PayeesApi->payee_details_update_v4: #{e}"
|
894
|
+
end
|
895
|
+
```
|
896
|
+
|
897
|
+
### Parameters
|
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
|
+
|
559
919
|
## v1_payees_payee_id_remote_id_update_post
|
560
920
|
|
561
921
|
> v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
@@ -661,3 +1021,56 @@ nil (empty response body)
|
|
661
1021
|
- **Content-Type**: application/json
|
662
1022
|
- **Accept**: application/json
|
663
1023
|
|
1024
|
+
|
1025
|
+
## v4_payees_payee_id_remote_id_update_post
|
1026
|
+
|
1027
|
+
> v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
1028
|
+
|
1029
|
+
Update Payee Remote Id
|
1030
|
+
|
1031
|
+
<p>Update the remote Id for the given Payee Id.</p>
|
1032
|
+
|
1033
|
+
### Example
|
1034
|
+
|
1035
|
+
```ruby
|
1036
|
+
# load the gem
|
1037
|
+
require 'velopayments'
|
1038
|
+
# setup authorization
|
1039
|
+
VeloPayments.configure do |config|
|
1040
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
1041
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
api_instance = VeloPayments::PayeesApi.new
|
1045
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
1046
|
+
update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v4
|
1047
|
+
|
1048
|
+
begin
|
1049
|
+
#Update Payee Remote Id
|
1050
|
+
api_instance.v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
1051
|
+
rescue VeloPayments::ApiError => e
|
1052
|
+
puts "Exception when calling PayeesApi->v4_payees_payee_id_remote_id_update_post: #{e}"
|
1053
|
+
end
|
1054
|
+
```
|
1055
|
+
|
1056
|
+
### Parameters
|
1057
|
+
|
1058
|
+
|
1059
|
+
Name | Type | Description | Notes
|
1060
|
+
------------- | ------------- | ------------- | -------------
|
1061
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
1062
|
+
**update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v4 |
|
1063
|
+
|
1064
|
+
### Return type
|
1065
|
+
|
1066
|
+
nil (empty response body)
|
1067
|
+
|
1068
|
+
### Authorization
|
1069
|
+
|
1070
|
+
[OAuth2](../README.md#OAuth2)
|
1071
|
+
|
1072
|
+
### HTTP request headers
|
1073
|
+
|
1074
|
+
- **Content-Type**: application/json
|
1075
|
+
- **Accept**: application/json
|
1076
|
+
|