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
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -65,15 +65,16 @@ module VeloPayments
|
|
65
65
|
form_params = opts[:form_params] || {}
|
66
66
|
|
67
67
|
# http body (model)
|
68
|
-
post_body = opts[:
|
68
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(resend_token_request)
|
69
69
|
|
70
70
|
# return_type
|
71
|
-
return_type = opts[:
|
71
|
+
return_type = opts[:debug_return_type]
|
72
72
|
|
73
73
|
# auth_names
|
74
|
-
auth_names = opts[:
|
74
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
75
75
|
|
76
76
|
new_options = opts.merge(
|
77
|
+
:operation => :"TokensApi.resend_token",
|
77
78
|
:header_params => header_params,
|
78
79
|
:query_params => query_params,
|
79
80
|
:form_params => form_params,
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -57,15 +57,16 @@ module VeloPayments
|
|
57
57
|
form_params = opts[:form_params] || {}
|
58
58
|
|
59
59
|
# http body (model)
|
60
|
-
post_body = opts[:
|
60
|
+
post_body = opts[:debug_body]
|
61
61
|
|
62
62
|
# return_type
|
63
|
-
return_type = opts[:
|
63
|
+
return_type = opts[:debug_return_type]
|
64
64
|
|
65
65
|
# auth_names
|
66
|
-
auth_names = opts[:
|
66
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
67
67
|
|
68
68
|
new_options = opts.merge(
|
69
|
+
:operation => :"UsersApi.delete_user_by_id_v2",
|
69
70
|
:header_params => header_params,
|
70
71
|
:query_params => query_params,
|
71
72
|
:form_params => form_params,
|
@@ -119,15 +120,16 @@ module VeloPayments
|
|
119
120
|
form_params = opts[:form_params] || {}
|
120
121
|
|
121
122
|
# http body (model)
|
122
|
-
post_body = opts[:
|
123
|
+
post_body = opts[:debug_body]
|
123
124
|
|
124
125
|
# return_type
|
125
|
-
return_type = opts[:
|
126
|
+
return_type = opts[:debug_return_type]
|
126
127
|
|
127
128
|
# auth_names
|
128
|
-
auth_names = opts[:
|
129
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
129
130
|
|
130
131
|
new_options = opts.merge(
|
132
|
+
:operation => :"UsersApi.disable_user_v2",
|
131
133
|
:header_params => header_params,
|
132
134
|
:query_params => query_params,
|
133
135
|
:form_params => form_params,
|
@@ -181,15 +183,16 @@ module VeloPayments
|
|
181
183
|
form_params = opts[:form_params] || {}
|
182
184
|
|
183
185
|
# http body (model)
|
184
|
-
post_body = opts[:
|
186
|
+
post_body = opts[:debug_body]
|
185
187
|
|
186
188
|
# return_type
|
187
|
-
return_type = opts[:
|
189
|
+
return_type = opts[:debug_return_type]
|
188
190
|
|
189
191
|
# auth_names
|
190
|
-
auth_names = opts[:
|
192
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
191
193
|
|
192
194
|
new_options = opts.merge(
|
195
|
+
:operation => :"UsersApi.enable_user_v2",
|
193
196
|
:header_params => header_params,
|
194
197
|
:query_params => query_params,
|
195
198
|
:form_params => form_params,
|
@@ -208,7 +211,7 @@ module VeloPayments
|
|
208
211
|
# Get Self
|
209
212
|
# Get the user's details
|
210
213
|
# @param [Hash] opts the optional parameters
|
211
|
-
# @return [
|
214
|
+
# @return [UserResponse]
|
212
215
|
def get_self(opts = {})
|
213
216
|
data, _status_code, _headers = get_self_with_http_info(opts)
|
214
217
|
data
|
@@ -217,7 +220,7 @@ module VeloPayments
|
|
217
220
|
# Get Self
|
218
221
|
# Get the user's details
|
219
222
|
# @param [Hash] opts the optional parameters
|
220
|
-
# @return [Array<(
|
223
|
+
# @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
|
221
224
|
def get_self_with_http_info(opts = {})
|
222
225
|
if @api_client.config.debugging
|
223
226
|
@api_client.config.logger.debug 'Calling API: UsersApi.get_self ...'
|
@@ -237,15 +240,16 @@ module VeloPayments
|
|
237
240
|
form_params = opts[:form_params] || {}
|
238
241
|
|
239
242
|
# http body (model)
|
240
|
-
post_body = opts[:
|
243
|
+
post_body = opts[:debug_body]
|
241
244
|
|
242
245
|
# return_type
|
243
|
-
return_type = opts[:
|
246
|
+
return_type = opts[:debug_return_type] || 'UserResponse'
|
244
247
|
|
245
248
|
# auth_names
|
246
|
-
auth_names = opts[:
|
249
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
247
250
|
|
248
251
|
new_options = opts.merge(
|
252
|
+
:operation => :"UsersApi.get_self",
|
249
253
|
:header_params => header_params,
|
250
254
|
:query_params => query_params,
|
251
255
|
:form_params => form_params,
|
@@ -299,15 +303,16 @@ module VeloPayments
|
|
299
303
|
form_params = opts[:form_params] || {}
|
300
304
|
|
301
305
|
# http body (model)
|
302
|
-
post_body = opts[:
|
306
|
+
post_body = opts[:debug_body]
|
303
307
|
|
304
308
|
# return_type
|
305
|
-
return_type = opts[:
|
309
|
+
return_type = opts[:debug_return_type] || 'UserResponse'
|
306
310
|
|
307
311
|
# auth_names
|
308
|
-
auth_names = opts[:
|
312
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
309
313
|
|
310
314
|
new_options = opts.merge(
|
315
|
+
:operation => :"UsersApi.get_user_by_id_v2",
|
311
316
|
:header_params => header_params,
|
312
317
|
:query_params => query_params,
|
313
318
|
:form_params => form_params,
|
@@ -363,15 +368,16 @@ module VeloPayments
|
|
363
368
|
form_params = opts[:form_params] || {}
|
364
369
|
|
365
370
|
# http body (model)
|
366
|
-
post_body = opts[:
|
371
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_user_request)
|
367
372
|
|
368
373
|
# return_type
|
369
|
-
return_type = opts[:
|
374
|
+
return_type = opts[:debug_return_type]
|
370
375
|
|
371
376
|
# auth_names
|
372
|
-
auth_names = opts[:
|
377
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
373
378
|
|
374
379
|
new_options = opts.merge(
|
380
|
+
:operation => :"UsersApi.invite_user",
|
375
381
|
:header_params => header_params,
|
376
382
|
:query_params => query_params,
|
377
383
|
:form_params => form_params,
|
@@ -394,7 +400,7 @@ module VeloPayments
|
|
394
400
|
# @option opts [UserStatus] :status The status of the User.
|
395
401
|
# @option opts [String] :entity_id The entityId of the User.
|
396
402
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
397
|
-
# @option opts [Integer] :page_size
|
403
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
398
404
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. (default to 'email:asc')
|
399
405
|
# @return [PagedUserResponse]
|
400
406
|
def list_users(opts = {})
|
@@ -409,13 +415,21 @@ module VeloPayments
|
|
409
415
|
# @option opts [UserStatus] :status The status of the User.
|
410
416
|
# @option opts [String] :entity_id The entityId of the User.
|
411
417
|
# @option opts [Integer] :page Page number. Default is 1.
|
412
|
-
# @option opts [Integer] :page_size
|
418
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
413
419
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.
|
414
420
|
# @return [Array<(PagedUserResponse, Integer, Hash)>] PagedUserResponse data, response status code and response headers
|
415
421
|
def list_users_with_http_info(opts = {})
|
416
422
|
if @api_client.config.debugging
|
417
423
|
@api_client.config.logger.debug 'Calling API: UsersApi.list_users ...'
|
418
424
|
end
|
425
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
426
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UsersApi.list_users, must be smaller than or equal to 100.'
|
427
|
+
end
|
428
|
+
|
429
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
430
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UsersApi.list_users, must be greater than or equal to 1.'
|
431
|
+
end
|
432
|
+
|
419
433
|
pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
|
420
434
|
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
421
435
|
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling UsersApi.list_users, must conform to the pattern #{pattern}."
|
@@ -442,15 +456,16 @@ module VeloPayments
|
|
442
456
|
form_params = opts[:form_params] || {}
|
443
457
|
|
444
458
|
# http body (model)
|
445
|
-
post_body = opts[:
|
459
|
+
post_body = opts[:debug_body]
|
446
460
|
|
447
461
|
# return_type
|
448
|
-
return_type = opts[:
|
462
|
+
return_type = opts[:debug_return_type] || 'PagedUserResponse'
|
449
463
|
|
450
464
|
# auth_names
|
451
|
-
auth_names = opts[:
|
465
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
452
466
|
|
453
467
|
new_options = opts.merge(
|
468
|
+
:operation => :"UsersApi.list_users",
|
454
469
|
:header_params => header_params,
|
455
470
|
:query_params => query_params,
|
456
471
|
:form_params => form_params,
|
@@ -506,15 +521,16 @@ module VeloPayments
|
|
506
521
|
form_params = opts[:form_params] || {}
|
507
522
|
|
508
523
|
# http body (model)
|
509
|
-
post_body = opts[:
|
524
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(register_sms_request)
|
510
525
|
|
511
526
|
# return_type
|
512
|
-
return_type = opts[:
|
527
|
+
return_type = opts[:debug_return_type]
|
513
528
|
|
514
529
|
# auth_names
|
515
|
-
auth_names = opts[:
|
530
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
516
531
|
|
517
532
|
new_options = opts.merge(
|
533
|
+
:operation => :"UsersApi.register_sms",
|
518
534
|
:header_params => header_params,
|
519
535
|
:query_params => query_params,
|
520
536
|
:form_params => form_params,
|
@@ -576,15 +592,16 @@ module VeloPayments
|
|
576
592
|
form_params = opts[:form_params] || {}
|
577
593
|
|
578
594
|
# http body (model)
|
579
|
-
post_body = opts[:
|
595
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(resend_token_request)
|
580
596
|
|
581
597
|
# return_type
|
582
|
-
return_type = opts[:
|
598
|
+
return_type = opts[:debug_return_type]
|
583
599
|
|
584
600
|
# auth_names
|
585
|
-
auth_names = opts[:
|
601
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
586
602
|
|
587
603
|
new_options = opts.merge(
|
604
|
+
:operation => :"UsersApi.resend_token",
|
588
605
|
:header_params => header_params,
|
589
606
|
:query_params => query_params,
|
590
607
|
:form_params => form_params,
|
@@ -646,15 +663,16 @@ module VeloPayments
|
|
646
663
|
form_params = opts[:form_params] || {}
|
647
664
|
|
648
665
|
# http body (model)
|
649
|
-
post_body = opts[:
|
666
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(role_update_request)
|
650
667
|
|
651
668
|
# return_type
|
652
|
-
return_type = opts[:
|
669
|
+
return_type = opts[:debug_return_type]
|
653
670
|
|
654
671
|
# auth_names
|
655
|
-
auth_names = opts[:
|
672
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
656
673
|
|
657
674
|
new_options = opts.merge(
|
675
|
+
:operation => :"UsersApi.role_update",
|
658
676
|
:header_params => header_params,
|
659
677
|
:query_params => query_params,
|
660
678
|
:form_params => form_params,
|
@@ -708,15 +726,16 @@ module VeloPayments
|
|
708
726
|
form_params = opts[:form_params] || {}
|
709
727
|
|
710
728
|
# http body (model)
|
711
|
-
post_body = opts[:
|
729
|
+
post_body = opts[:debug_body]
|
712
730
|
|
713
731
|
# return_type
|
714
|
-
return_type = opts[:
|
732
|
+
return_type = opts[:debug_return_type]
|
715
733
|
|
716
734
|
# auth_names
|
717
|
-
auth_names = opts[:
|
735
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
718
736
|
|
719
737
|
new_options = opts.merge(
|
738
|
+
:operation => :"UsersApi.unlock_user_v2",
|
720
739
|
:header_params => header_params,
|
721
740
|
:query_params => query_params,
|
722
741
|
:form_params => form_params,
|
@@ -778,15 +797,16 @@ module VeloPayments
|
|
778
797
|
form_params = opts[:form_params] || {}
|
779
798
|
|
780
799
|
# http body (model)
|
781
|
-
post_body = opts[:
|
800
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(unregister_mfa_request)
|
782
801
|
|
783
802
|
# return_type
|
784
|
-
return_type = opts[:
|
803
|
+
return_type = opts[:debug_return_type]
|
785
804
|
|
786
805
|
# auth_names
|
787
|
-
auth_names = opts[:
|
806
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
788
807
|
|
789
808
|
new_options = opts.merge(
|
809
|
+
:operation => :"UsersApi.unregister_mfa",
|
790
810
|
:header_params => header_params,
|
791
811
|
:query_params => query_params,
|
792
812
|
:form_params => form_params,
|
@@ -806,6 +826,7 @@ module VeloPayments
|
|
806
826
|
# <p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
|
807
827
|
# @param self_mfa_type_unregister_request [SelfMFATypeUnregisterRequest] The MFA Type to unregister
|
808
828
|
# @param [Hash] opts the optional parameters
|
829
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
809
830
|
# @return [nil]
|
810
831
|
def unregister_mfa_for_self(self_mfa_type_unregister_request, opts = {})
|
811
832
|
unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts)
|
@@ -816,6 +837,7 @@ module VeloPayments
|
|
816
837
|
# <p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
|
817
838
|
# @param self_mfa_type_unregister_request [SelfMFATypeUnregisterRequest] The MFA Type to unregister
|
818
839
|
# @param [Hash] opts the optional parameters
|
840
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
819
841
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
820
842
|
def unregister_mfa_for_self_with_http_info(self_mfa_type_unregister_request, opts = {})
|
821
843
|
if @api_client.config.debugging
|
@@ -837,20 +859,22 @@ module VeloPayments
|
|
837
859
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
838
860
|
# HTTP header 'Content-Type'
|
839
861
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
862
|
+
header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
|
840
863
|
|
841
864
|
# form parameters
|
842
865
|
form_params = opts[:form_params] || {}
|
843
866
|
|
844
867
|
# http body (model)
|
845
|
-
post_body = opts[:
|
868
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(self_mfa_type_unregister_request)
|
846
869
|
|
847
870
|
# return_type
|
848
|
-
return_type = opts[:
|
871
|
+
return_type = opts[:debug_return_type]
|
849
872
|
|
850
873
|
# auth_names
|
851
|
-
auth_names = opts[:
|
874
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
852
875
|
|
853
876
|
new_options = opts.merge(
|
877
|
+
:operation => :"UsersApi.unregister_mfa_for_self",
|
854
878
|
:header_params => header_params,
|
855
879
|
:query_params => query_params,
|
856
880
|
:form_params => form_params,
|
@@ -906,15 +930,16 @@ module VeloPayments
|
|
906
930
|
form_params = opts[:form_params] || {}
|
907
931
|
|
908
932
|
# http body (model)
|
909
|
-
post_body = opts[:
|
933
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(self_update_password_request)
|
910
934
|
|
911
935
|
# return_type
|
912
|
-
return_type = opts[:
|
936
|
+
return_type = opts[:debug_return_type]
|
913
937
|
|
914
938
|
# auth_names
|
915
|
-
auth_names = opts[:
|
939
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
916
940
|
|
917
941
|
new_options = opts.merge(
|
942
|
+
:operation => :"UsersApi.update_password_self",
|
918
943
|
:header_params => header_params,
|
919
944
|
:query_params => query_params,
|
920
945
|
:form_params => form_params,
|
@@ -976,15 +1001,16 @@ module VeloPayments
|
|
976
1001
|
form_params = opts[:form_params] || {}
|
977
1002
|
|
978
1003
|
# http body (model)
|
979
|
-
post_body = opts[:
|
1004
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_details_update_request)
|
980
1005
|
|
981
1006
|
# return_type
|
982
|
-
return_type = opts[:
|
1007
|
+
return_type = opts[:debug_return_type]
|
983
1008
|
|
984
1009
|
# auth_names
|
985
|
-
auth_names = opts[:
|
1010
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
986
1011
|
|
987
1012
|
new_options = opts.merge(
|
1013
|
+
:operation => :"UsersApi.user_details_update",
|
988
1014
|
:header_params => header_params,
|
989
1015
|
:query_params => query_params,
|
990
1016
|
:form_params => form_params,
|
@@ -1000,6 +1026,71 @@ module VeloPayments
|
|
1000
1026
|
return data, status_code, headers
|
1001
1027
|
end
|
1002
1028
|
|
1029
|
+
# Update User Details for self
|
1030
|
+
# <p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p>
|
1031
|
+
# @param payee_user_self_update_request [PayeeUserSelfUpdateRequest] The details of the user to update
|
1032
|
+
# @param [Hash] opts the optional parameters
|
1033
|
+
# @return [nil]
|
1034
|
+
def user_details_update_for_self(payee_user_self_update_request, opts = {})
|
1035
|
+
user_details_update_for_self_with_http_info(payee_user_self_update_request, opts)
|
1036
|
+
nil
|
1037
|
+
end
|
1038
|
+
|
1039
|
+
# Update User Details for self
|
1040
|
+
# <p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p>
|
1041
|
+
# @param payee_user_self_update_request [PayeeUserSelfUpdateRequest] The details of the user to update
|
1042
|
+
# @param [Hash] opts the optional parameters
|
1043
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1044
|
+
def user_details_update_for_self_with_http_info(payee_user_self_update_request, opts = {})
|
1045
|
+
if @api_client.config.debugging
|
1046
|
+
@api_client.config.logger.debug 'Calling API: UsersApi.user_details_update_for_self ...'
|
1047
|
+
end
|
1048
|
+
# verify the required parameter 'payee_user_self_update_request' is set
|
1049
|
+
if @api_client.config.client_side_validation && payee_user_self_update_request.nil?
|
1050
|
+
fail ArgumentError, "Missing the required parameter 'payee_user_self_update_request' when calling UsersApi.user_details_update_for_self"
|
1051
|
+
end
|
1052
|
+
# resource path
|
1053
|
+
local_var_path = '/v2/users/self/userDetailsUpdate'
|
1054
|
+
|
1055
|
+
# query parameters
|
1056
|
+
query_params = opts[:query_params] || {}
|
1057
|
+
|
1058
|
+
# header parameters
|
1059
|
+
header_params = opts[:header_params] || {}
|
1060
|
+
# HTTP header 'Accept' (if needed)
|
1061
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1062
|
+
# HTTP header 'Content-Type'
|
1063
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1064
|
+
|
1065
|
+
# form parameters
|
1066
|
+
form_params = opts[:form_params] || {}
|
1067
|
+
|
1068
|
+
# http body (model)
|
1069
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payee_user_self_update_request)
|
1070
|
+
|
1071
|
+
# return_type
|
1072
|
+
return_type = opts[:debug_return_type]
|
1073
|
+
|
1074
|
+
# auth_names
|
1075
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
1076
|
+
|
1077
|
+
new_options = opts.merge(
|
1078
|
+
:operation => :"UsersApi.user_details_update_for_self",
|
1079
|
+
:header_params => header_params,
|
1080
|
+
:query_params => query_params,
|
1081
|
+
:form_params => form_params,
|
1082
|
+
:body => post_body,
|
1083
|
+
:auth_names => auth_names,
|
1084
|
+
:return_type => return_type
|
1085
|
+
)
|
1086
|
+
|
1087
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1088
|
+
if @api_client.config.debugging
|
1089
|
+
@api_client.config.logger.debug "API called: UsersApi#user_details_update_for_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1090
|
+
end
|
1091
|
+
return data, status_code, headers
|
1092
|
+
end
|
1093
|
+
|
1003
1094
|
# Validate the proposed password
|
1004
1095
|
# validate the password and return a score
|
1005
1096
|
# @param password_request [PasswordRequest] The password
|
@@ -1040,15 +1131,16 @@ module VeloPayments
|
|
1040
1131
|
form_params = opts[:form_params] || {}
|
1041
1132
|
|
1042
1133
|
# http body (model)
|
1043
|
-
post_body = opts[:
|
1134
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(password_request)
|
1044
1135
|
|
1045
1136
|
# return_type
|
1046
|
-
return_type = opts[:
|
1137
|
+
return_type = opts[:debug_return_type] || 'ValidatePasswordResponse'
|
1047
1138
|
|
1048
1139
|
# auth_names
|
1049
|
-
auth_names = opts[:
|
1140
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
1050
1141
|
|
1051
1142
|
new_options = opts.merge(
|
1143
|
+
:operation => :"UsersApi.validate_password_self",
|
1052
1144
|
:header_params => header_params,
|
1053
1145
|
:query_params => query_params,
|
1054
1146
|
:form_params => form_params,
|