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
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**page** | [**
|
7
|
+
**page** | [**ListPaymentsResponseV3Page**](ListPaymentsResponseV3Page.md) | | [optional]
|
8
8
|
**links** | [**Array<GetPayoutsResponseV3Links>**](GetPayoutsResponseV3Links.md) | | [optional]
|
9
9
|
**content** | [**Array<PaymentResponseV4>**](PaymentResponseV4.md) | | [optional]
|
10
10
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**page** | [**PagedUserResponsePage**](PagedUserResponsePage.md) | | [optional]
|
8
|
-
**links** | [**Array<
|
8
|
+
**links** | [**Array<ListSourceAccountResponseV2Links>**](ListSourceAccountResponseV2Links.md) | | [optional]
|
9
9
|
**content** | [**Array<SourceAccountResponseV2>**](SourceAccountResponseV2.md) | | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# VeloPayments::ListSourceAccountResponseV2Links
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**rel** | **String** | | [optional]
|
8
|
+
**href** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'VeloPayments'
|
14
|
+
|
15
|
+
instance = VeloPayments::ListSourceAccountResponseV2Links.new(rel: first,
|
16
|
+
href: https://api.sandbox.velopayments.com/v2/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# VeloPayments::ListSourceAccountResponseV3
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**page** | [**PagedUserResponsePage**](PagedUserResponsePage.md) | | [optional]
|
8
|
+
**links** | [**Array<ListSourceAccountResponseV3Links>**](ListSourceAccountResponseV3Links.md) | | [optional]
|
9
|
+
**content** | [**Array<SourceAccountResponseV3>**](SourceAccountResponseV3.md) | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'VeloPayments'
|
15
|
+
|
16
|
+
instance = VeloPayments::ListSourceAccountResponseV3.new(page: null,
|
17
|
+
links: null,
|
18
|
+
content: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# VeloPayments::ListSourceAccountResponseV3Links
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**rel** | **String** | | [optional]
|
8
|
+
**href** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'VeloPayments'
|
14
|
+
|
15
|
+
instance = VeloPayments::ListSourceAccountResponseV3Links.new(rel: first,
|
16
|
+
href: https://api.sandbox.velopayments.com/v3/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/LoginApi.md
CHANGED
@@ -106,7 +106,7 @@ No authorization required
|
|
106
106
|
|
107
107
|
## validate_access_token
|
108
108
|
|
109
|
-
> AccessTokenResponse validate_access_token(access_token_validation_request)
|
109
|
+
> AccessTokenResponse validate_access_token(access_token_validation_request, opts)
|
110
110
|
|
111
111
|
validate
|
112
112
|
|
@@ -125,10 +125,13 @@ end
|
|
125
125
|
|
126
126
|
api_instance = VeloPayments::LoginApi.new
|
127
127
|
access_token_validation_request = VeloPayments::AccessTokenValidationRequest.new # AccessTokenValidationRequest | An OTP from the user's registered MFA Device
|
128
|
+
opts = {
|
129
|
+
authorization: 'authorization_example' # String | Bearer token authorization leg of validate
|
130
|
+
}
|
128
131
|
|
129
132
|
begin
|
130
133
|
#validate
|
131
|
-
result = api_instance.validate_access_token(access_token_validation_request)
|
134
|
+
result = api_instance.validate_access_token(access_token_validation_request, opts)
|
132
135
|
p result
|
133
136
|
rescue VeloPayments::ApiError => e
|
134
137
|
puts "Exception when calling LoginApi->validate_access_token: #{e}"
|
@@ -141,6 +144,7 @@ end
|
|
141
144
|
Name | Type | Description | Notes
|
142
145
|
------------- | ------------- | ------------- | -------------
|
143
146
|
**access_token_validation_request** | [**AccessTokenValidationRequest**](AccessTokenValidationRequest.md)| An OTP from the user's registered MFA Device |
|
147
|
+
**authorization** | **String**| Bearer token authorization leg of validate | [optional]
|
144
148
|
|
145
149
|
### Return type
|
146
150
|
|
data/docs/MarketingOptIn.md
CHANGED
data/docs/Name.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# VeloPayments::Name
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**title** | **String** | | [optional]
|
8
|
+
**first_name** | **String** | | [optional]
|
9
|
+
**other_names** | **String** | | [optional]
|
10
|
+
**last_name** | **String** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'VeloPayments'
|
16
|
+
|
17
|
+
instance = VeloPayments::Name.new(title: Mr,
|
18
|
+
first_name: Bob,
|
19
|
+
other_names: H,
|
20
|
+
last_name: Smith)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# VeloPayments::Notifications2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**minimum_balance** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'VeloPayments'
|
13
|
+
|
14
|
+
instance = VeloPayments::Notifications2.new(minimum_balance: 120000)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/PagedPayeeResponse2.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**summary** | [**PagedPayeeResponse2Summary**](PagedPayeeResponse2Summary.md) | | [optional]
|
8
8
|
**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) | | [optional]
|
9
9
|
**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) | | [optional]
|
10
|
-
**content** | [**Array<
|
10
|
+
**content** | [**Array<GetPayeeListResponse>**](GetPayeeListResponse.md) | | [optional]
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# VeloPayments::PagedPaymentsResponseV3
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional]
|
8
|
+
**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) | | [optional]
|
9
|
+
**content** | [**Array<PaymentV3>**](PaymentV3.md) | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'VeloPayments'
|
15
|
+
|
16
|
+
instance = VeloPayments::PagedPaymentsResponseV3.new(page: null,
|
17
|
+
links: null,
|
18
|
+
content: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/Payee.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** | [**CompanyV1**](CompanyV1.md) | | [optional]
|
20
20
|
**individual** | [**IndividualV1**](IndividualV1.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/Payee2.md
CHANGED
@@ -14,12 +14,12 @@ Name | Type | Description | Notes
|
|
14
14
|
**payment_channel** | [**PayeePaymentChannel2**](PayeePaymentChannel2.md) | | [optional]
|
15
15
|
**challenge** | [**Challenge**](Challenge.md) | | [optional]
|
16
16
|
**language** | [**Language2**](Language2.md) | | [optional]
|
17
|
-
**accept_terms_and_conditions_timestamp** | **
|
17
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
18
18
|
**cellphone_number** | **String** | | [optional]
|
19
19
|
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
20
20
|
**company** | [**CompanyV1**](CompanyV1.md) | | [optional]
|
21
21
|
**individual** | [**IndividualV1**](IndividualV1.md) | | [optional]
|
22
|
-
**created** | **
|
22
|
+
**created** | **Time** | | [optional]
|
23
23
|
**grace_period_end_date** | **Date** | | [optional] [readonly]
|
24
24
|
**watchlist_status_updated_timestamp** | **String** | | [optional] [readonly]
|
25
25
|
**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) | | [optional]
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# VeloPayments::
|
1
|
+
# VeloPayments::PayeeDetailResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -9,16 +9,16 @@ Name | Type | Description | Notes
|
|
9
9
|
**email** | **String** | | [optional]
|
10
10
|
**onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
|
11
11
|
**watchlist_status** | [**WatchlistStatus**](WatchlistStatus.md) | | [optional]
|
12
|
-
**watchlist_override_expires_at_timestamp** | **
|
12
|
+
**watchlist_override_expires_at_timestamp** | **Time** | | [optional]
|
13
13
|
**watchlist_override_comment** | **String** | | [optional]
|
14
14
|
**language** | [**Language2**](Language2.md) | | [optional]
|
15
|
-
**created** | **
|
15
|
+
**created** | **Time** | | [optional]
|
16
16
|
**country** | **String** | | [optional]
|
17
17
|
**display_name** | **String** | | [optional]
|
18
18
|
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
19
19
|
**disabled** | **Boolean** | | [optional]
|
20
20
|
**disabled_comment** | **String** | | [optional]
|
21
|
-
**disabled_updated_timestamp** | **
|
21
|
+
**disabled_updated_timestamp** | **Time** | | [optional]
|
22
22
|
**address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
|
23
23
|
**individual** | [**Individual2**](Individual2.md) | | [optional]
|
24
24
|
**company** | [**Company2**](Company2.md) | | [optional]
|
@@ -31,14 +31,15 @@ Name | Type | Description | Notes
|
|
31
31
|
**pause_payment_timestamp** | **String** | | [optional]
|
32
32
|
**marketing_opt_in_decision** | **Boolean** | | [optional]
|
33
33
|
**marketing_opt_in_timestamp** | **String** | | [optional]
|
34
|
-
**accept_terms_and_conditions_timestamp** | **
|
34
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
35
|
+
**challenge** | [**Challenge2**](Challenge2.md) | | [optional]
|
35
36
|
|
36
37
|
## Code Sample
|
37
38
|
|
38
39
|
```ruby
|
39
40
|
require 'VeloPayments'
|
40
41
|
|
41
|
-
instance = VeloPayments::
|
42
|
+
instance = VeloPayments::PayeeDetailResponse.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
42
43
|
payor_refs: null,
|
43
44
|
email: bob@example.com,
|
44
45
|
onboarded_status: null,
|
@@ -65,7 +66,8 @@ instance = VeloPayments::PayeeResponseV3.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1
|
|
65
66
|
pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
|
66
67
|
marketing_opt_in_decision: null,
|
67
68
|
marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
|
68
|
-
accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z
|
69
|
+
accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
|
70
|
+
challenge: null)
|
69
71
|
```
|
70
72
|
|
71
73
|
|
@@ -0,0 +1,73 @@
|
|
1
|
+
# VeloPayments::PayeeDetailResponse2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**payee_id** | **String** | | [optional] [readonly]
|
8
|
+
**payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) | | [optional] [readonly]
|
9
|
+
**email** | **String** | | [optional]
|
10
|
+
**onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
|
11
|
+
**watchlist_status** | [**WatchlistStatus2**](WatchlistStatus2.md) | | [optional]
|
12
|
+
**watchlist_override_expires_at_timestamp** | **Time** | | [optional]
|
13
|
+
**watchlist_override_comment** | **String** | | [optional]
|
14
|
+
**language** | [**Language2**](Language2.md) | | [optional]
|
15
|
+
**created** | **Time** | | [optional]
|
16
|
+
**country** | **String** | | [optional]
|
17
|
+
**display_name** | **String** | | [optional]
|
18
|
+
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
19
|
+
**disabled** | **Boolean** | | [optional]
|
20
|
+
**disabled_comment** | **String** | | [optional]
|
21
|
+
**disabled_updated_timestamp** | **Time** | | [optional]
|
22
|
+
**address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
|
23
|
+
**individual** | [**Individual2**](Individual2.md) | | [optional]
|
24
|
+
**company** | [**Company2**](Company2.md) | | [optional]
|
25
|
+
**cellphone_number** | **String** | | [optional]
|
26
|
+
**watchlist_status_updated_timestamp** | **String** | | [optional] [readonly]
|
27
|
+
**grace_period_end_date** | **Date** | | [optional] [readonly]
|
28
|
+
**enhanced_kyc_completed** | **Boolean** | | [optional]
|
29
|
+
**kyc_completed_timestamp** | **String** | | [optional]
|
30
|
+
**pause_payment** | **Boolean** | | [optional]
|
31
|
+
**pause_payment_timestamp** | **String** | | [optional]
|
32
|
+
**marketing_opt_in_decision** | **Boolean** | | [optional]
|
33
|
+
**marketing_opt_in_timestamp** | **String** | | [optional]
|
34
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
35
|
+
**challenge** | [**Challenge2**](Challenge2.md) | | [optional]
|
36
|
+
|
37
|
+
## Code Sample
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
require 'VeloPayments'
|
41
|
+
|
42
|
+
instance = VeloPayments::PayeeDetailResponse2.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
43
|
+
payor_refs: null,
|
44
|
+
email: bob@example.com,
|
45
|
+
onboarded_status: null,
|
46
|
+
watchlist_status: null,
|
47
|
+
watchlist_override_expires_at_timestamp: 2019-01-20T09:00Z,
|
48
|
+
watchlist_override_comment: watchlist override comment,
|
49
|
+
language: null,
|
50
|
+
created: 2019-01-20T09:00Z,
|
51
|
+
country: US,
|
52
|
+
display_name: Bob,
|
53
|
+
payee_type: null,
|
54
|
+
disabled: null,
|
55
|
+
disabled_comment: reason for disabled,
|
56
|
+
disabled_updated_timestamp: 2019-01-20T09:00Z,
|
57
|
+
address: null,
|
58
|
+
individual: null,
|
59
|
+
company: null,
|
60
|
+
cellphone_number: 1234567890,
|
61
|
+
watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
|
62
|
+
grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
|
63
|
+
enhanced_kyc_completed: null,
|
64
|
+
kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
|
65
|
+
pause_payment: null,
|
66
|
+
pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
|
67
|
+
marketing_opt_in_decision: null,
|
68
|
+
marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
|
69
|
+
accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
|
70
|
+
challenge: null)
|
71
|
+
```
|
72
|
+
|
73
|
+
|
data/docs/PayeeInvitationApi.md
CHANGED
@@ -7,12 +7,16 @@ Method | HTTP request | Description
|
|
7
7
|
[**get_payees_invitation_status_v1**](PayeeInvitationApi.md#get_payees_invitation_status_v1) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
8
8
|
[**get_payees_invitation_status_v2**](PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
9
9
|
[**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
10
|
+
[**get_payees_invitation_status_v4**](PayeeInvitationApi.md#get_payees_invitation_status_v4) | **GET** /v4/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
|
10
11
|
[**query_batch_status_v2**](PayeeInvitationApi.md#query_batch_status_v2) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
|
11
12
|
[**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
|
13
|
+
[**query_batch_status_v4**](PayeeInvitationApi.md#query_batch_status_v4) | **GET** /v4/payees/batch/{batchId} | Query Batch Status
|
12
14
|
[**resend_payee_invite_v1**](PayeeInvitationApi.md#resend_payee_invite_v1) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
|
13
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
|
14
17
|
[**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Initiate Payee Creation
|
15
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
|
16
20
|
|
17
21
|
|
18
22
|
|
@@ -192,6 +196,68 @@ Name | Type | Description | Notes
|
|
192
196
|
- **Accept**: application/json
|
193
197
|
|
194
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
|
208
|
+
|
209
|
+
```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
|
+
begin
|
228
|
+
#Get Payee Invitation Status
|
229
|
+
result = api_instance.get_payees_invitation_status_v4(payor_id, opts)
|
230
|
+
p result
|
231
|
+
rescue VeloPayments::ApiError => e
|
232
|
+
puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v4: #{e}"
|
233
|
+
end
|
234
|
+
```
|
235
|
+
|
236
|
+
### Parameters
|
237
|
+
|
238
|
+
|
239
|
+
Name | Type | Description | Notes
|
240
|
+
------------- | ------------- | ------------- | -------------
|
241
|
+
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
242
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
|
243
|
+
**invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
|
244
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
245
|
+
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
246
|
+
|
247
|
+
### Return type
|
248
|
+
|
249
|
+
[**PagedPayeeInvitationStatusResponse2**](PagedPayeeInvitationStatusResponse2.md)
|
250
|
+
|
251
|
+
### Authorization
|
252
|
+
|
253
|
+
[OAuth2](../README.md#OAuth2)
|
254
|
+
|
255
|
+
### HTTP request headers
|
256
|
+
|
257
|
+
- **Content-Type**: Not defined
|
258
|
+
- **Accept**: application/json
|
259
|
+
|
260
|
+
|
195
261
|
## query_batch_status_v2
|
196
262
|
|
197
263
|
> QueryBatchResponse query_batch_status_v2(batch_id)
|
@@ -296,6 +362,58 @@ Name | Type | Description | Notes
|
|
296
362
|
- **Accept**: application/json
|
297
363
|
|
298
364
|
|
365
|
+
## query_batch_status_v4
|
366
|
+
|
367
|
+
> QueryBatchResponse2 query_batch_status_v4(batch_id)
|
368
|
+
|
369
|
+
Query Batch Status
|
370
|
+
|
371
|
+
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
|
+
|
373
|
+
### Example
|
374
|
+
|
375
|
+
```ruby
|
376
|
+
# load the gem
|
377
|
+
require 'velopayments'
|
378
|
+
# setup authorization
|
379
|
+
VeloPayments.configure do |config|
|
380
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
381
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
382
|
+
end
|
383
|
+
|
384
|
+
api_instance = VeloPayments::PayeeInvitationApi.new
|
385
|
+
batch_id = 'batch_id_example' # String | Batch Id
|
386
|
+
|
387
|
+
begin
|
388
|
+
#Query Batch Status
|
389
|
+
result = api_instance.query_batch_status_v4(batch_id)
|
390
|
+
p result
|
391
|
+
rescue VeloPayments::ApiError => e
|
392
|
+
puts "Exception when calling PayeeInvitationApi->query_batch_status_v4: #{e}"
|
393
|
+
end
|
394
|
+
```
|
395
|
+
|
396
|
+
### Parameters
|
397
|
+
|
398
|
+
|
399
|
+
Name | Type | Description | Notes
|
400
|
+
------------- | ------------- | ------------- | -------------
|
401
|
+
**batch_id** | [**String**](.md)| Batch Id |
|
402
|
+
|
403
|
+
### Return type
|
404
|
+
|
405
|
+
[**QueryBatchResponse2**](QueryBatchResponse2.md)
|
406
|
+
|
407
|
+
### Authorization
|
408
|
+
|
409
|
+
[OAuth2](../README.md#OAuth2)
|
410
|
+
|
411
|
+
### HTTP request headers
|
412
|
+
|
413
|
+
- **Content-Type**: Not defined
|
414
|
+
- **Accept**: application/json
|
415
|
+
|
416
|
+
|
299
417
|
## resend_payee_invite_v1
|
300
418
|
|
301
419
|
> resend_payee_invite_v1(payee_id, invite_payee_request)
|
@@ -402,13 +520,66 @@ nil (empty response body)
|
|
402
520
|
- **Accept**: application/json
|
403
521
|
|
404
522
|
|
523
|
+
## resend_payee_invite_v4
|
524
|
+
|
525
|
+
> resend_payee_invite_v4(payee_id, invite_payee_request2)
|
526
|
+
|
527
|
+
Resend Payee Invite
|
528
|
+
|
529
|
+
<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
|
+
|
531
|
+
### Example
|
532
|
+
|
533
|
+
```ruby
|
534
|
+
# load the gem
|
535
|
+
require 'velopayments'
|
536
|
+
# setup authorization
|
537
|
+
VeloPayments.configure do |config|
|
538
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
539
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
540
|
+
end
|
541
|
+
|
542
|
+
api_instance = VeloPayments::PayeeInvitationApi.new
|
543
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
544
|
+
invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
|
545
|
+
|
546
|
+
begin
|
547
|
+
#Resend Payee Invite
|
548
|
+
api_instance.resend_payee_invite_v4(payee_id, invite_payee_request2)
|
549
|
+
rescue VeloPayments::ApiError => e
|
550
|
+
puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v4: #{e}"
|
551
|
+
end
|
552
|
+
```
|
553
|
+
|
554
|
+
### Parameters
|
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)
|
569
|
+
|
570
|
+
### HTTP request headers
|
571
|
+
|
572
|
+
- **Content-Type**: application/json
|
573
|
+
- **Accept**: application/json
|
574
|
+
|
575
|
+
|
405
576
|
## v2_create_payee
|
406
577
|
|
407
578
|
> CreatePayeesCSVResponse v2_create_payee(opts)
|
408
579
|
|
409
580
|
Initiate Payee Creation
|
410
581
|
|
411
|
-
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
|
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
|
412
583
|
|
413
584
|
### Example
|
414
585
|
|
@@ -462,7 +633,7 @@ Name | Type | Description | Notes
|
|
462
633
|
|
463
634
|
Initiate Payee Creation
|
464
635
|
|
465
|
-
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,
|
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.
|
466
637
|
|
467
638
|
### Example
|
468
639
|
|
@@ -509,3 +680,57 @@ Name | Type | Description | Notes
|
|
509
680
|
- **Content-Type**: application/json, multipart/form-data
|
510
681
|
- **Accept**: application/json
|
511
682
|
|
683
|
+
|
684
|
+
## v4_create_payee
|
685
|
+
|
686
|
+
> CreatePayeesCSVResponse2 v4_create_payee(opts)
|
687
|
+
|
688
|
+
Initiate Payee Creation
|
689
|
+
|
690
|
+
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
|
+
|
692
|
+
### Example
|
693
|
+
|
694
|
+
```ruby
|
695
|
+
# load the gem
|
696
|
+
require 'velopayments'
|
697
|
+
# setup authorization
|
698
|
+
VeloPayments.configure do |config|
|
699
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
700
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
701
|
+
end
|
702
|
+
|
703
|
+
api_instance = VeloPayments::PayeeInvitationApi.new
|
704
|
+
opts = {
|
705
|
+
create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
|
706
|
+
}
|
707
|
+
|
708
|
+
begin
|
709
|
+
#Initiate Payee Creation
|
710
|
+
result = api_instance.v4_create_payee(opts)
|
711
|
+
p result
|
712
|
+
rescue VeloPayments::ApiError => e
|
713
|
+
puts "Exception when calling PayeeInvitationApi->v4_create_payee: #{e}"
|
714
|
+
end
|
715
|
+
```
|
716
|
+
|
717
|
+
### Parameters
|
718
|
+
|
719
|
+
|
720
|
+
Name | Type | Description | Notes
|
721
|
+
------------- | ------------- | ------------- | -------------
|
722
|
+
**create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
|
723
|
+
|
724
|
+
### Return type
|
725
|
+
|
726
|
+
[**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
|
727
|
+
|
728
|
+
### Authorization
|
729
|
+
|
730
|
+
[OAuth2](../README.md#OAuth2)
|
731
|
+
|
732
|
+
### HTTP request headers
|
733
|
+
|
734
|
+
- **Content-Type**: application/json, multipart/form-data
|
735
|
+
- **Accept**: application/json
|
736
|
+
|