velopayments 2.18.113 → 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 +4 -4
- data/Dockerfile +7 -0
- data/Gemfile +1 -1
- data/Makefile +8 -12
- data/README.md +161 -74
- data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +3 -3
- data/docs/AutoTopUpConfig2.md +23 -0
- data/docs/Challenge.md +2 -2
- data/docs/Challenge2.md +19 -0
- data/docs/Company.md +21 -0
- data/docs/Company2.md +21 -0
- data/docs/CompanyResponse.md +2 -2
- data/docs/CompanyV1.md +3 -3
- data/docs/CountriesApi.md +21 -31
- data/docs/CreateFundingAccountRequestV2.md +29 -0
- data/docs/CreateIndividual.md +2 -2
- data/docs/CreateIndividual2.md +3 -3
- data/docs/CreateIndividual2Name.md +23 -0
- data/docs/CreatePayee.md +4 -4
- data/docs/CreatePayee2.md +7 -7
- data/docs/CreatePayeesCSVRequest.md +22 -22
- data/docs/CreatePayeesCSVRequest2.md +23 -23
- data/docs/CreatePayeesCSVResponse.md +2 -2
- data/docs/CreatePayeesCSVResponse2.md +2 -2
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
- data/docs/CreatePayeesRequest.md +1 -1
- data/docs/CreatePayeesRequest2.md +1 -1
- data/docs/CreatePaymentChannel.md +6 -6
- data/docs/CreatePaymentChannel2.md +6 -6
- data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +6 -6
- data/docs/CreateWebhookRequest.md +23 -0
- data/docs/CurrenciesApi.md +7 -12
- data/docs/FailedSubmission.md +2 -2
- data/docs/FailedSubmission2.md +19 -0
- data/docs/FundingAccountResponse.md +15 -7
- data/docs/FundingAccountResponse2.md +35 -0
- data/docs/FundingAccountType.md +16 -0
- data/docs/FundingAudit.md +5 -5
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerApi.md +337 -36
- data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +9 -9
- 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 +2 -2
- 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/GetPaymentsForPayoutResponseV4.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
- data/docs/GetPayoutsResponseV4.md +1 -1
- data/docs/Individual.md +21 -0
- data/docs/Individual2.md +21 -0
- data/docs/IndividualV1.md +2 -2
- data/docs/IndividualV1Name.md +4 -4
- data/docs/InlineResponse400.md +19 -0
- data/docs/InlineResponse400Errors.md +23 -0
- data/docs/InlineResponse401.md +19 -0
- data/docs/InlineResponse401Errors.md +23 -0
- data/docs/InlineResponse403.md +19 -0
- data/docs/InlineResponse403Errors.md +23 -0
- data/docs/InlineResponse404.md +19 -0
- data/docs/InlineResponse404Errors.md +23 -0
- data/docs/InlineResponse409.md +19 -0
- data/docs/InlineResponse409Errors.md +23 -0
- data/docs/InlineResponse412.md +19 -0
- data/docs/InlineResponse412Errors.md +23 -0
- data/docs/InvitationStatus2.md +16 -0
- data/docs/InvitePayeeRequest.md +1 -1
- data/docs/InvitePayeeRequest2.md +17 -0
- data/docs/InviteUserRequest.md +2 -2
- data/docs/{TokenType.md → Language2.md} +2 -2
- 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/{PaymentStatus.md → LocationType.md} +2 -2
- data/docs/LoginApi.md +6 -2
- data/docs/MarketingOptIn.md +2 -2
- data/docs/Name.md +23 -0
- data/docs/Notifications2.md +17 -0
- data/docs/{MFAStatus.md → OfacStatus2.md} +2 -2
- data/docs/OnboardedStatus2.md +16 -0
- data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
- data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
- data/docs/{PagedResponsePage.md → PagedPayeeInvitationStatusResponsePage.md} +2 -2
- data/docs/PagedPayeeResponse2.md +1 -1
- data/docs/PagedPayeeResponse2Summary.md +5 -5
- data/docs/PagedPayeeResponsePage.md +5 -5
- data/docs/PagedPayeeResponseSummary.md +5 -5
- data/docs/PagedPaymentsResponseV3.md +21 -0
- data/docs/Payee.md +11 -11
- data/docs/{PayeeResponse2.md → Payee2.md} +22 -20
- data/docs/PayeeAddress2.md +31 -0
- data/docs/PayeeDelta.md +1 -1
- data/docs/PayeeDelta2.md +29 -0
- data/docs/PayeeDeltaResponse2.md +21 -0
- data/docs/PayeeDeltaResponse2Links.md +19 -0
- data/docs/PayeeDetailResponse.md +73 -0
- data/docs/PayeeDetailResponse2.md +73 -0
- data/docs/PayeeInvitationApi.md +405 -60
- data/docs/PayeeInvitationStatus.md +1 -1
- data/docs/PayeeInvitationStatusResponse.md +3 -3
- data/docs/PayeeInvitationStatusResponse2.md +21 -0
- data/docs/PayeePaymentChannel.md +8 -8
- data/docs/PayeePaymentChannel2.md +29 -0
- data/docs/PayeePayorRef.md +1 -1
- data/docs/PayeePayorRef2.md +6 -2
- data/docs/PayeePayorRefV2.md +25 -0
- data/docs/PayeePayorRefV3.md +25 -0
- data/docs/PayeeResponse.md +11 -11
- data/docs/PayeeResponseV2.md +73 -0
- data/docs/{OTPType.md → PayeeType2.md} +2 -2
- data/docs/PayeeUserSelfUpdateRequest.md +27 -0
- data/docs/PayeesApi.md +753 -59
- data/docs/PaymentAuditServiceApi.md +271 -39
- data/docs/PaymentChannelCountry.md +3 -3
- data/docs/PaymentChannelRule.md +11 -11
- data/docs/PaymentDelta.md +1 -1
- data/docs/PaymentDeltaResponse.md +1 -1
- 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} +7 -5
- 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/{CurrencyType.md → PayoutCompanyV3.md} +3 -3
- data/docs/{GenerateOTPRequest.md → PayoutIndividualV3.md} +3 -3
- 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/QueryBatchResponse2.md +23 -0
- data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +6 -6
- data/docs/QuoteResponseV3.md +17 -0
- data/docs/{Region.md → RegionV2.md} +2 -2
- data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +3 -3
- data/docs/ResendTokenRequest.md +1 -1
- data/docs/RoleUpdateRequest.md +19 -0
- 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} +3 -3
- data/docs/{SupportedCountriesResponse2.md → SupportedCountriesResponseV2.md} +2 -2
- data/docs/SupportedCountry.md +2 -2
- data/docs/SupportedCountryV2.md +3 -3
- data/docs/SupportedCurrencyResponseV2.md +17 -0
- data/docs/SupportedCurrencyV2.md +19 -0
- data/docs/TokensApi.md +0 -498
- 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/UnregisterMFARequest.md +1 -1
- data/docs/UpdatePayeeDetailsRequest.md +29 -0
- data/docs/UpdatePayeeDetailsRequest2.md +29 -0
- data/docs/UpdateRemoteIdRequest.md +2 -2
- data/docs/UpdateWebhookRequest.md +21 -0
- data/docs/UserDetailsUpdateRequest.md +31 -0
- data/docs/UserResponse.md +1 -1
- data/docs/UsersApi.md +170 -60
- 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 +102 -42
- data/lib/velopayments/api/countries_api.rb +40 -37
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +536 -78
- data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +15 -14
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +531 -116
- data/lib/velopayments/api/payees_api.rb +945 -73
- data/lib/velopayments/api/payment_audit_service_api.rb +448 -82
- 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 -698
- data/lib/velopayments/api/users_api.rb +280 -118
- 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} +36 -10
- data/lib/velopayments/models/access_token_response.rb +21 -7
- data/lib/velopayments/models/access_token_validation_request.rb +21 -7
- data/lib/velopayments/models/auth_response.rb +21 -7
- data/lib/velopayments/models/auto_top_up_config.rb +23 -7
- data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
- data/lib/velopayments/models/challenge.rb +21 -7
- data/lib/velopayments/models/challenge2.rb +285 -0
- data/lib/velopayments/models/company.rb +312 -0
- data/lib/velopayments/models/company2.rb +312 -0
- data/lib/velopayments/models/company_response.rb +22 -7
- data/lib/velopayments/models/company_v1.rb +28 -12
- data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
- data/lib/velopayments/models/create_individual.rb +21 -7
- data/lib/velopayments/models/create_individual2.rb +22 -8
- data/lib/velopayments/models/create_individual2_name.rb +351 -0
- data/lib/velopayments/models/create_payee.rb +24 -8
- data/lib/velopayments/models/create_payee2.rb +27 -11
- data/lib/velopayments/models/create_payee_address.rb +26 -7
- data/lib/velopayments/models/create_payee_address2.rb +26 -7
- data/lib/velopayments/models/create_payees_csv_request.rb +21 -7
- data/lib/velopayments/models/create_payees_csv_request2.rb +35 -15
- data/lib/velopayments/models/create_payees_csv_response.rb +22 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +22 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +228 -0
- data/lib/velopayments/models/create_payees_request.rb +21 -7
- data/lib/velopayments/models/create_payees_request2.rb +21 -7
- data/lib/velopayments/models/create_payment_channel.rb +21 -7
- data/lib/velopayments/models/create_payment_channel2.rb +21 -7
- data/lib/velopayments/models/create_payor_link_request.rb +21 -7
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +40 -11
- data/lib/velopayments/models/create_webhook_request.rb +315 -0
- data/lib/velopayments/models/error.rb +23 -9
- data/lib/velopayments/models/error_response.rb +23 -7
- data/lib/velopayments/models/failed_submission.rb +22 -8
- data/lib/velopayments/models/failed_submission2.rb +219 -0
- data/lib/velopayments/models/funding_account_response.rb +116 -11
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +117 -96
- data/lib/velopayments/models/{token_type.rb → funding_account_type.rb} +8 -9
- data/lib/velopayments/models/funding_audit.rb +34 -18
- data/lib/velopayments/models/funding_event.rb +22 -8
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +58 -8
- data/lib/velopayments/models/funding_request_v1.rb +21 -7
- data/lib/velopayments/models/funding_request_v2.rb +21 -7
- data/lib/velopayments/models/funding_request_v3.rb +259 -0
- data/lib/velopayments/models/fx_summary_v3.rb +22 -8
- data/lib/velopayments/models/fx_summary_v4.rb +22 -8
- data/lib/velopayments/models/get_fundings_response.rb +22 -15
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +40 -19
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +100 -112
- 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} +25 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +21 -7
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +21 -7
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +24 -10
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +22 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +36 -12
- data/lib/velopayments/models/get_payout_statistics.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +21 -7
- data/lib/velopayments/models/get_payouts_response_v4.rb +22 -8
- data/lib/velopayments/models/individual.rb +264 -0
- data/lib/velopayments/models/individual2.rb +264 -0
- data/lib/velopayments/models/individual_response.rb +21 -7
- data/lib/velopayments/models/individual_v1.rb +45 -7
- data/lib/velopayments/models/individual_v1_name.rb +21 -7
- data/lib/velopayments/models/inline_response400.rb +225 -0
- data/lib/velopayments/models/inline_response400_errors.rb +240 -0
- data/lib/velopayments/models/inline_response401.rb +225 -0
- data/lib/velopayments/models/inline_response401_errors.rb +240 -0
- data/lib/velopayments/models/inline_response403.rb +225 -0
- data/lib/velopayments/models/inline_response403_errors.rb +240 -0
- 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 +225 -0
- data/lib/velopayments/models/inline_response409_errors.rb +240 -0
- 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/{payment_status.rb → invitation_status2.rb} +8 -12
- data/lib/velopayments/models/invitation_status_response.rb +21 -7
- data/lib/velopayments/models/invite_payee_request.rb +21 -7
- data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +36 -28
- data/lib/velopayments/models/invite_user_request.rb +34 -17
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/language.rb +3 -2
- data/lib/velopayments/models/language2.rb +46 -0
- data/lib/velopayments/models/link_for_response.rb +21 -7
- data/lib/velopayments/models/list_funding_accounts_response.rb +21 -7
- data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +25 -11
- data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +24 -10
- data/lib/velopayments/models/list_payments_response_v4.rb +22 -8
- data/lib/velopayments/models/list_source_account_response.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_links.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_page.rb +21 -7
- data/lib/velopayments/models/list_source_account_response_v2.rb +22 -8
- 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 +40 -0
- data/lib/velopayments/models/marketing_opt_in.rb +22 -8
- data/lib/velopayments/models/mfa_details.rb +22 -7
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +333 -0
- data/lib/velopayments/models/notifications.rb +21 -7
- data/lib/velopayments/models/{paged_response.rb → notifications2.rb} +31 -28
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/{otp_type.rb → ofac_status2.rb} +9 -6
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +39 -0
- data/lib/velopayments/models/page_for_response.rb +21 -7
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +21 -7
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +22 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +233 -0
- data/lib/velopayments/models/{paged_response_page.rb → paged_payee_invitation_status_response_page.rb} +24 -10
- data/lib/velopayments/models/paged_payee_response.rb +21 -7
- data/lib/velopayments/models/paged_payee_response2.rb +22 -8
- data/lib/velopayments/models/paged_payee_response2_summary.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_links.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_page.rb +21 -7
- data/lib/velopayments/models/paged_payee_response_summary.rb +21 -7
- data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
- data/lib/velopayments/models/paged_user_response.rb +21 -7
- data/lib/velopayments/models/paged_user_response_links.rb +21 -7
- data/lib/velopayments/models/paged_user_response_page.rb +21 -7
- data/lib/velopayments/models/password_request.rb +21 -7
- data/lib/velopayments/models/payee.rb +29 -9
- data/lib/velopayments/models/payee2.rb +460 -0
- data/lib/velopayments/models/payee_address.rb +26 -7
- data/lib/velopayments/models/payee_address2.rb +497 -0
- data/lib/velopayments/models/payee_delta.rb +22 -7
- data/lib/velopayments/models/payee_delta2.rb +303 -0
- data/lib/velopayments/models/payee_delta_response.rb +21 -7
- data/lib/velopayments/models/payee_delta_response2.rb +233 -0
- data/lib/velopayments/models/payee_delta_response2_links.rb +219 -0
- data/lib/velopayments/models/payee_delta_response_links.rb +21 -7
- data/lib/velopayments/models/payee_delta_response_page.rb +21 -7
- data/lib/velopayments/models/payee_detail_response.rb +475 -0
- data/lib/velopayments/models/payee_detail_response2.rb +475 -0
- data/lib/velopayments/models/payee_invitation_status.rb +21 -7
- data/lib/velopayments/models/payee_invitation_status_response.rb +56 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +272 -0
- data/lib/velopayments/models/payee_payment_channel.rb +68 -43
- data/lib/velopayments/models/payee_payment_channel2.rb +455 -0
- data/lib/velopayments/models/payee_payor_ref.rb +21 -7
- data/lib/velopayments/models/payee_payor_ref2.rb +45 -11
- data/lib/velopayments/models/payee_payor_ref_v2.rb +282 -0
- data/lib/velopayments/models/payee_payor_ref_v3.rb +248 -0
- data/lib/velopayments/models/payee_response.rb +29 -9
- data/lib/velopayments/models/payee_response_v2.rb +475 -0
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/{mfa_status.rb → payee_type2.rb} +8 -7
- data/lib/velopayments/models/payee_user_self_update_request.rb +365 -0
- 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 +33 -7
- data/lib/velopayments/models/payment_channel_rule.rb +48 -7
- data/lib/velopayments/models/payment_channel_rules_response.rb +21 -7
- data/lib/velopayments/models/payment_delta.rb +28 -8
- data/lib/velopayments/models/payment_delta_response.rb +22 -8
- 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 +22 -8
- data/lib/velopayments/models/payment_event_response_v4.rb +22 -8
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +73 -53
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_response_v3.rb +22 -8
- data/lib/velopayments/models/payment_response_v4.rb +50 -9
- data/lib/velopayments/models/payment_response_v4_payout.rb +21 -7
- data/lib/velopayments/models/payment_v3.rb +363 -0
- data/lib/velopayments/models/payor_address.rb +26 -7
- data/lib/velopayments/models/payor_address_v2.rb +26 -7
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -7
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +21 -7
- data/lib/velopayments/models/payor_branding_response.rb +24 -7
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -7
- data/lib/velopayments/models/payor_create_api_key_response.rb +21 -7
- data/lib/velopayments/models/payor_create_application_request.rb +22 -7
- data/lib/velopayments/models/payor_email_opt_out_request.rb +21 -7
- data/lib/velopayments/models/payor_links_response.rb +21 -7
- data/lib/velopayments/models/payor_links_response_links.rb +21 -7
- data/lib/velopayments/models/payor_links_response_payors.rb +21 -7
- data/lib/velopayments/models/payor_logo_request.rb +21 -7
- data/lib/velopayments/models/payor_v1.rb +34 -11
- data/lib/velopayments/models/payor_v2.rb +44 -11
- data/lib/velopayments/models/payout_company_v3.rb +215 -0
- data/lib/velopayments/models/{generate_otp_request.rb → payout_individual_v3.rb} +34 -20
- data/lib/velopayments/models/payout_name_v3.rb +229 -0
- data/lib/velopayments/models/{validate_otp_request.rb → payout_payee_v3.rb} +53 -49
- data/lib/velopayments/models/payout_payor_v4.rb +21 -7
- data/lib/velopayments/models/payout_principal_v4.rb +21 -7
- 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 +21 -7
- data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -10
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +43 -15
- data/lib/velopayments/models/payout_type_v4.rb +3 -2
- data/lib/velopayments/models/{supported_currency.rb → ping_response.rb} +37 -24
- data/lib/velopayments/models/query_batch_response.rb +21 -7
- data/lib/velopayments/models/query_batch_response2.rb +274 -0
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +50 -12
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +25 -11
- data/lib/velopayments/models/{region.rb → region_v2.rb} +24 -10
- data/lib/velopayments/models/register_sms_request.rb +24 -10
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +36 -10
- data/lib/velopayments/models/resend_token_request.rb +23 -8
- data/lib/velopayments/models/reset_password_request.rb +21 -7
- data/lib/velopayments/models/role.rb +21 -7
- data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +39 -22
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +21 -7
- data/lib/velopayments/models/self_update_password_request.rb +21 -7
- data/lib/velopayments/models/set_notifications_request.rb +21 -7
- data/lib/velopayments/models/source_account_response.rb +36 -11
- data/lib/velopayments/models/source_account_response_v2.rb +39 -14
- data/lib/velopayments/models/source_account_response_v3.rb +437 -0
- data/lib/velopayments/models/source_account_summary_v3.rb +21 -7
- data/lib/velopayments/models/source_account_summary_v4.rb +21 -7
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +64 -10
- data/lib/velopayments/models/supported_countries_response.rb +21 -7
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -10
- data/lib/velopayments/models/supported_country.rb +52 -36
- data/lib/velopayments/models/supported_country_v2.rb +56 -38
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +25 -11
- data/lib/velopayments/models/supported_currency_v2.rb +256 -0
- data/lib/velopayments/models/transfer_request.rb +21 -7
- data/lib/velopayments/models/transfer_request2.rb +301 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/transmission_types.rb +246 -0
- data/lib/velopayments/models/{validate_mfa_request.rb → transmission_types2.rb} +61 -45
- data/lib/velopayments/models/unregister_mfa_request.rb +25 -10
- 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 +21 -7
- data/lib/velopayments/models/update_webhook_request.rb +288 -0
- data/lib/velopayments/models/{user_response2.rb → user_details_update_request.rb} +97 -181
- data/lib/velopayments/models/user_info.rb +21 -7
- data/lib/velopayments/models/user_response.rb +32 -17
- 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 +21 -7
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/watchlist_status2.rb +40 -0
- data/lib/velopayments/models/{currency_type.rb → webhook_response.rb} +66 -49
- data/lib/velopayments/models/webhooks_response.rb +233 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +244 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +13 -13
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +97 -20
- data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +11 -11
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +113 -31
- data/spec/api/payees_api_spec.rb +186 -16
- data/spec/api/payment_audit_service_api_spec.rb +74 -20
- 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 -131
- data/spec/api/users_api_spec.rb +43 -17
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +3 -3
- 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 +53 -0
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +53 -0
- 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 +59 -0
- 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 +53 -0
- 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 +3 -3
- data/spec/models/failed_submission2_spec.rb +47 -0
- 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/{register_mfa_response_spec.rb → get_fundings_response_links_spec.rb} +10 -10
- data/spec/models/get_fundings_response_spec.rb +2 -2
- data/spec/models/get_payee_list_response_company_spec.rb +47 -0
- data/spec/models/{get_fundings_response_all_of_spec.rb → get_payee_list_response_individual_spec.rb} +9 -9
- data/spec/models/get_payee_list_response_spec.rb +137 -0
- 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 +53 -0
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +53 -0
- 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 +59 -0
- data/spec/models/inline_response400_spec.rb +47 -0
- data/spec/models/inline_response401_errors_spec.rb +59 -0
- data/spec/models/inline_response401_spec.rb +47 -0
- data/spec/models/inline_response403_errors_spec.rb +59 -0
- data/spec/models/inline_response403_spec.rb +47 -0
- 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 +59 -0
- data/spec/models/inline_response409_spec.rb +47 -0
- 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/{generate_otp_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
- 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/{otp_type_spec.rb → language2_spec.rb} +8 -8
- 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/{payment_status_spec.rb → location_type_spec.rb} +8 -8
- 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/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status2_spec.rb +35 -0
- 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 +53 -0
- data/spec/models/{paged_response_page_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +8 -8
- 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/{payee_response2_spec.rb → payee2_spec.rb} +20 -10
- data/spec/models/payee_address2_spec.rb +83 -0
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +77 -0
- data/spec/models/payee_delta_response2_links_spec.rb +47 -0
- data/spec/models/payee_delta_response2_spec.rb +53 -0
- 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_detail_response_spec.rb +209 -0
- data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
- data/spec/models/payee_invitation_status_response_spec.rb +6 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +81 -0
- data/spec/models/payee_payment_channel_spec.rb +3 -3
- data/spec/models/payee_payor_ref2_spec.rb +14 -2
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
- data/spec/models/payee_payor_ref_v3_spec.rb +65 -0
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +209 -0
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/{token_type_spec.rb → payee_type2_spec.rb} +8 -8
- 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 -12
- 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/{validate_mfa_request_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 +63 -0
- 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/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
- 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 -10
- data/spec/models/supported_country_v2_spec.rb +2 -10
- 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 +3 -3
- 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 +83 -0
- 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/{check_token_response_spec.rb → webhook_response_spec.rb} +13 -13
- data/spec/models/webhooks_response_spec.rb +53 -0
- data/spec/models/{register_mfa_request_spec.rb → withdraw_payment_request_spec.rb} +9 -9
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +103 -0
- data/{spec/api/get_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
- data/specs/api/funding_manager_api_spec.rb +372 -0
- data/{spec/api/withdraw_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +14 -14
- data/specs/api/login_api_spec.rb +82 -0
- data/specs/api/payee_invitation_api_spec.rb +203 -0
- data/specs/api/payees_api_spec.rb +285 -0
- data/specs/api/payment_audit_service_api_spec.rb +468 -0
- data/specs/api/payors_api_spec.rb +171 -0
- data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/{spec/api/quote_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +16 -15
- data/specs/api/users_api_spec.rb +284 -0
- data/velopayments.gemspec +3 -4
- metadata +556 -322
- data/docs/CheckTokenResponse.md +0 -25
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/EmailUpdateRequest.md +0 -19
- 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/PayoutHistoryApi.md +0 -221
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/RegisterMFARequest.md +0 -17
- data/docs/RegisterMFAResponse.md +0 -19
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/ValidateMFARequest.md +0 -17
- data/docs/ValidateOTPRequest.md +0 -17
- 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 -82
- 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 -84
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -82
- data/lib/velopayments/models/check_token_response.rb +0 -234
- data/lib/velopayments/models/register_mfa_request.rb +0 -201
- data/spec/api/payout_history_api_spec.rb +0 -95
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/models/validate_otp_request_spec.rb +0 -41
data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb}
RENAMED
@@ -3,60 +3,108 @@
|
|
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
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
|
-
class
|
17
|
+
class FundingAccountResponse2
|
18
|
+
# Funding Account Id
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
attr_accessor :payor_id
|
22
|
+
|
23
|
+
# name on the bank account
|
17
24
|
attr_accessor :account_name
|
18
25
|
|
26
|
+
# bank account number
|
19
27
|
attr_accessor :account_number
|
20
28
|
|
29
|
+
# bank account routing number
|
21
30
|
attr_accessor :routing_number
|
22
31
|
|
23
|
-
|
32
|
+
# name of funding account
|
33
|
+
attr_accessor :name
|
34
|
+
|
35
|
+
# ISO 4217 currency code
|
36
|
+
attr_accessor :currency
|
37
|
+
|
38
|
+
# ISO 3166-1 2 letter country code (upper case)
|
39
|
+
attr_accessor :country
|
40
|
+
|
41
|
+
# Funding account type
|
42
|
+
attr_accessor :type
|
43
|
+
|
44
|
+
# A flag for whether the funding account has been archived. Only present in the response if true.
|
45
|
+
attr_accessor :archived
|
24
46
|
|
25
47
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
48
|
def self.attribute_map
|
27
49
|
{
|
50
|
+
:'id' => :'id',
|
51
|
+
:'payor_id' => :'payorId',
|
28
52
|
:'account_name' => :'accountName',
|
29
53
|
:'account_number' => :'accountNumber',
|
30
54
|
:'routing_number' => :'routingNumber',
|
31
|
-
:'
|
55
|
+
:'name' => :'name',
|
56
|
+
:'currency' => :'currency',
|
57
|
+
:'country' => :'country',
|
58
|
+
:'type' => :'type',
|
59
|
+
:'archived' => :'archived'
|
32
60
|
}
|
33
61
|
end
|
34
62
|
|
35
63
|
# Attribute type mapping.
|
36
64
|
def self.openapi_types
|
37
65
|
{
|
66
|
+
:'id' => :'String',
|
67
|
+
:'payor_id' => :'String',
|
38
68
|
:'account_name' => :'String',
|
39
69
|
:'account_number' => :'String',
|
40
70
|
:'routing_number' => :'String',
|
41
|
-
:'
|
71
|
+
:'name' => :'String',
|
72
|
+
:'currency' => :'String',
|
73
|
+
:'country' => :'String',
|
74
|
+
:'type' => :'String',
|
75
|
+
:'archived' => :'Boolean'
|
42
76
|
}
|
43
77
|
end
|
44
78
|
|
79
|
+
# List of attributes with nullable: true
|
80
|
+
def self.openapi_nullable
|
81
|
+
Set.new([
|
82
|
+
])
|
83
|
+
end
|
84
|
+
|
45
85
|
# Initializes the object
|
46
86
|
# @param [Hash] attributes Model attributes in the form of hash
|
47
87
|
def initialize(attributes = {})
|
48
88
|
if (!attributes.is_a?(Hash))
|
49
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
89
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::FundingAccountResponse2` initialize method"
|
50
90
|
end
|
51
91
|
|
52
92
|
# check to see if the attribute exists and convert string to symbol for hash key
|
53
93
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
54
94
|
if (!self.class.attribute_map.key?(k.to_sym))
|
55
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
95
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::FundingAccountResponse2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
56
96
|
end
|
57
97
|
h[k.to_sym] = v
|
58
98
|
}
|
59
99
|
|
100
|
+
if attributes.key?(:'id')
|
101
|
+
self.id = attributes[:'id']
|
102
|
+
end
|
103
|
+
|
104
|
+
if attributes.key?(:'payor_id')
|
105
|
+
self.payor_id = attributes[:'payor_id']
|
106
|
+
end
|
107
|
+
|
60
108
|
if attributes.key?(:'account_name')
|
61
109
|
self.account_name = attributes[:'account_name']
|
62
110
|
end
|
@@ -69,53 +117,45 @@ module VeloPayments
|
|
69
117
|
self.routing_number = attributes[:'routing_number']
|
70
118
|
end
|
71
119
|
|
72
|
-
if attributes.key?(:'
|
73
|
-
self.
|
74
|
-
end
|
75
|
-
end
|
76
|
-
|
77
|
-
# Show invalid properties with the reasons. Usually used together with valid?
|
78
|
-
# @return Array for valid properties with the reasons
|
79
|
-
def list_invalid_properties
|
80
|
-
invalid_properties = Array.new
|
81
|
-
if @account_name.nil?
|
82
|
-
invalid_properties.push('invalid value for "account_name", account_name cannot be nil.')
|
83
|
-
end
|
84
|
-
|
85
|
-
if @account_name.to_s.length > 22
|
86
|
-
invalid_properties.push('invalid value for "account_name", the character length must be smaller than or equal to 22.')
|
120
|
+
if attributes.key?(:'name')
|
121
|
+
self.name = attributes[:'name']
|
87
122
|
end
|
88
123
|
|
89
|
-
if
|
90
|
-
|
124
|
+
if attributes.key?(:'currency')
|
125
|
+
self.currency = attributes[:'currency']
|
91
126
|
end
|
92
127
|
|
93
|
-
if
|
94
|
-
|
128
|
+
if attributes.key?(:'country')
|
129
|
+
self.country = attributes[:'country']
|
95
130
|
end
|
96
131
|
|
97
|
-
if
|
98
|
-
|
132
|
+
if attributes.key?(:'type')
|
133
|
+
self.type = attributes[:'type']
|
99
134
|
end
|
100
135
|
|
101
|
-
if
|
102
|
-
|
136
|
+
if attributes.key?(:'archived')
|
137
|
+
self.archived = attributes[:'archived']
|
103
138
|
end
|
139
|
+
end
|
104
140
|
|
105
|
-
|
106
|
-
|
141
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
142
|
+
# @return Array for valid properties with the reasons
|
143
|
+
def list_invalid_properties
|
144
|
+
invalid_properties = Array.new
|
145
|
+
if !@currency.nil? && @currency.to_s.length > 3
|
146
|
+
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
107
147
|
end
|
108
148
|
|
109
|
-
if @
|
110
|
-
invalid_properties.push('invalid value for "
|
149
|
+
if !@currency.nil? && @currency.to_s.length < 3
|
150
|
+
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
111
151
|
end
|
112
152
|
|
113
|
-
if @
|
114
|
-
invalid_properties.push('invalid value for "
|
153
|
+
if !@country.nil? && @country.to_s.length > 2
|
154
|
+
invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
|
115
155
|
end
|
116
156
|
|
117
|
-
if
|
118
|
-
invalid_properties.push('invalid value for "
|
157
|
+
if !@country.nil? && @country.to_s.length < 2
|
158
|
+
invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
|
119
159
|
end
|
120
160
|
|
121
161
|
invalid_properties
|
@@ -124,71 +164,39 @@ module VeloPayments
|
|
124
164
|
# Check to see if the all the properties in the model are valid
|
125
165
|
# @return true if the model is valid
|
126
166
|
def valid?
|
127
|
-
return false if
|
128
|
-
return false if @
|
129
|
-
return false if @
|
130
|
-
return false if
|
131
|
-
return false if @account_number.to_s.length > 17
|
132
|
-
return false if @account_number.to_s.length < 4
|
133
|
-
return false if @routing_number.nil?
|
134
|
-
return false if @routing_number.to_s.length > 9
|
135
|
-
return false if @routing_number.to_s.length < 9
|
136
|
-
return false if @payor_id.nil?
|
167
|
+
return false if !@currency.nil? && @currency.to_s.length > 3
|
168
|
+
return false if !@currency.nil? && @currency.to_s.length < 3
|
169
|
+
return false if !@country.nil? && @country.to_s.length > 2
|
170
|
+
return false if !@country.nil? && @country.to_s.length < 2
|
137
171
|
true
|
138
172
|
end
|
139
173
|
|
140
174
|
# Custom attribute writer method with validation
|
141
|
-
# @param [Object]
|
142
|
-
def
|
143
|
-
if
|
144
|
-
fail ArgumentError, '
|
145
|
-
end
|
146
|
-
|
147
|
-
if account_name.to_s.length > 22
|
148
|
-
fail ArgumentError, 'invalid value for "account_name", the character length must be smaller than or equal to 22.'
|
149
|
-
end
|
150
|
-
|
151
|
-
if account_name.to_s.length < 1
|
152
|
-
fail ArgumentError, 'invalid value for "account_name", the character length must be great than or equal to 1.'
|
153
|
-
end
|
154
|
-
|
155
|
-
@account_name = account_name
|
156
|
-
end
|
157
|
-
|
158
|
-
# Custom attribute writer method with validation
|
159
|
-
# @param [Object] account_number Value to be assigned
|
160
|
-
def account_number=(account_number)
|
161
|
-
if account_number.nil?
|
162
|
-
fail ArgumentError, 'account_number cannot be nil'
|
163
|
-
end
|
164
|
-
|
165
|
-
if account_number.to_s.length > 17
|
166
|
-
fail ArgumentError, 'invalid value for "account_number", the character length must be smaller than or equal to 17.'
|
175
|
+
# @param [Object] currency Value to be assigned
|
176
|
+
def currency=(currency)
|
177
|
+
if !currency.nil? && currency.to_s.length > 3
|
178
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
167
179
|
end
|
168
180
|
|
169
|
-
if
|
170
|
-
fail ArgumentError, 'invalid value for "
|
181
|
+
if !currency.nil? && currency.to_s.length < 3
|
182
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
171
183
|
end
|
172
184
|
|
173
|
-
@
|
185
|
+
@currency = currency
|
174
186
|
end
|
175
187
|
|
176
188
|
# Custom attribute writer method with validation
|
177
|
-
# @param [Object]
|
178
|
-
def
|
179
|
-
if
|
180
|
-
fail ArgumentError, '
|
181
|
-
end
|
182
|
-
|
183
|
-
if routing_number.to_s.length > 9
|
184
|
-
fail ArgumentError, 'invalid value for "routing_number", the character length must be smaller than or equal to 9.'
|
189
|
+
# @param [Object] country Value to be assigned
|
190
|
+
def country=(country)
|
191
|
+
if !country.nil? && country.to_s.length > 2
|
192
|
+
fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
|
185
193
|
end
|
186
194
|
|
187
|
-
if
|
188
|
-
fail ArgumentError, 'invalid value for "
|
195
|
+
if !country.nil? && country.to_s.length < 2
|
196
|
+
fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
|
189
197
|
end
|
190
198
|
|
191
|
-
@
|
199
|
+
@country = country
|
192
200
|
end
|
193
201
|
|
194
202
|
# Checks equality by comparing each attribute.
|
@@ -196,10 +204,16 @@ module VeloPayments
|
|
196
204
|
def ==(o)
|
197
205
|
return true if self.equal?(o)
|
198
206
|
self.class == o.class &&
|
207
|
+
id == o.id &&
|
208
|
+
payor_id == o.payor_id &&
|
199
209
|
account_name == o.account_name &&
|
200
210
|
account_number == o.account_number &&
|
201
211
|
routing_number == o.routing_number &&
|
202
|
-
|
212
|
+
name == o.name &&
|
213
|
+
currency == o.currency &&
|
214
|
+
country == o.country &&
|
215
|
+
type == o.type &&
|
216
|
+
archived == o.archived
|
203
217
|
end
|
204
218
|
|
205
219
|
# @see the `==` method
|
@@ -211,7 +225,7 @@ module VeloPayments
|
|
211
225
|
# Calculates hash code according to all attributes.
|
212
226
|
# @return [Integer] Hash code
|
213
227
|
def hash
|
214
|
-
[account_name, account_number, routing_number,
|
228
|
+
[id, payor_id, account_name, account_number, routing_number, name, currency, country, type, archived].hash
|
215
229
|
end
|
216
230
|
|
217
231
|
# Builds the object from hash
|
@@ -227,7 +241,9 @@ module VeloPayments
|
|
227
241
|
def build_from_hash(attributes)
|
228
242
|
return nil unless attributes.is_a?(Hash)
|
229
243
|
self.class.openapi_types.each_pair do |key, type|
|
230
|
-
if
|
244
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
245
|
+
self.send("#{key}=", nil)
|
246
|
+
elsif type =~ /\AArray<(.*)>/i
|
231
247
|
# check to ensure the input is an array given that the attribute
|
232
248
|
# is documented as an array but the input is not
|
233
249
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -235,7 +251,7 @@ module VeloPayments
|
|
235
251
|
end
|
236
252
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
237
253
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
238
|
-
end
|
254
|
+
end
|
239
255
|
end
|
240
256
|
|
241
257
|
self
|
@@ -247,8 +263,8 @@ module VeloPayments
|
|
247
263
|
# @return [Object] Deserialized data
|
248
264
|
def _deserialize(type, value)
|
249
265
|
case type.to_sym
|
250
|
-
when :
|
251
|
-
|
266
|
+
when :Time
|
267
|
+
Time.parse(value)
|
252
268
|
when :Date
|
253
269
|
Date.parse(value)
|
254
270
|
when :String
|
@@ -300,7 +316,11 @@ module VeloPayments
|
|
300
316
|
hash = {}
|
301
317
|
self.class.attribute_map.each_pair do |attr, param|
|
302
318
|
value = self.send(attr)
|
303
|
-
|
319
|
+
if value.nil?
|
320
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
321
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
322
|
+
end
|
323
|
+
|
304
324
|
hash[param] = _to_hash(value)
|
305
325
|
end
|
306
326
|
hash
|
@@ -323,5 +343,6 @@ module VeloPayments
|
|
323
343
|
value
|
324
344
|
end
|
325
345
|
end
|
346
|
+
|
326
347
|
end
|
327
348
|
end
|
@@ -3,21 +3,20 @@
|
|
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
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
|
-
class
|
17
|
-
|
18
|
-
|
19
|
-
RESET_PASSWORD = "RESET_PASSWORD".freeze
|
20
|
-
ACCOUNT_LOCKED = "ACCOUNT_LOCKED".freeze
|
17
|
+
class FundingAccountType
|
18
|
+
FBO = "FBO".freeze
|
19
|
+
WUBS_DECOUPLED = "WUBS_DECOUPLED".freeze
|
21
20
|
|
22
21
|
# Builds the enum from string
|
23
22
|
# @param [String] The enum value in the form of the string
|
@@ -30,8 +29,8 @@ module VeloPayments
|
|
30
29
|
# @param [String] The enum value in the form of the string
|
31
30
|
# @return [String] The enum value
|
32
31
|
def build_from_hash(value)
|
33
|
-
constantValues =
|
34
|
-
raise "Invalid ENUM value #{value} for class #
|
32
|
+
constantValues = FundingAccountType.constants.select { |c| FundingAccountType::const_get(c) == value }
|
33
|
+
raise "Invalid ENUM value #{value} for class #FundingAccountType" if constantValues.empty?
|
35
34
|
value
|
36
35
|
end
|
37
36
|
end
|
@@ -3,25 +3,28 @@
|
|
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
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
17
|
class FundingAudit
|
18
|
+
# The amount funded
|
17
19
|
attr_accessor :amount
|
18
20
|
|
21
|
+
# The currency of the funding
|
22
|
+
attr_accessor :currency
|
23
|
+
|
19
24
|
attr_accessor :date_time
|
20
25
|
|
21
26
|
attr_accessor :status
|
22
27
|
|
23
|
-
attr_accessor :currency
|
24
|
-
|
25
28
|
attr_accessor :source_account_name
|
26
29
|
|
27
30
|
attr_accessor :funding_account_name
|
@@ -58,9 +61,9 @@ module VeloPayments
|
|
58
61
|
def self.attribute_map
|
59
62
|
{
|
60
63
|
:'amount' => :'amount',
|
64
|
+
:'currency' => :'currency',
|
61
65
|
:'date_time' => :'dateTime',
|
62
66
|
:'status' => :'status',
|
63
|
-
:'currency' => :'currency',
|
64
67
|
:'source_account_name' => :'sourceAccountName',
|
65
68
|
:'funding_account_name' => :'fundingAccountName',
|
66
69
|
:'funding_type' => :'fundingType',
|
@@ -73,9 +76,9 @@ module VeloPayments
|
|
73
76
|
def self.openapi_types
|
74
77
|
{
|
75
78
|
:'amount' => :'Float',
|
76
|
-
:'date_time' => :'DateTime',
|
77
|
-
:'status' => :'String',
|
78
79
|
:'currency' => :'String',
|
80
|
+
:'date_time' => :'Time',
|
81
|
+
:'status' => :'String',
|
79
82
|
:'source_account_name' => :'String',
|
80
83
|
:'funding_account_name' => :'String',
|
81
84
|
:'funding_type' => :'String',
|
@@ -84,6 +87,12 @@ module VeloPayments
|
|
84
87
|
}
|
85
88
|
end
|
86
89
|
|
90
|
+
# List of attributes with nullable: true
|
91
|
+
def self.openapi_nullable
|
92
|
+
Set.new([
|
93
|
+
])
|
94
|
+
end
|
95
|
+
|
87
96
|
# Initializes the object
|
88
97
|
# @param [Hash] attributes Model attributes in the form of hash
|
89
98
|
def initialize(attributes = {})
|
@@ -103,6 +112,10 @@ module VeloPayments
|
|
103
112
|
self.amount = attributes[:'amount']
|
104
113
|
end
|
105
114
|
|
115
|
+
if attributes.key?(:'currency')
|
116
|
+
self.currency = attributes[:'currency']
|
117
|
+
end
|
118
|
+
|
106
119
|
if attributes.key?(:'date_time')
|
107
120
|
self.date_time = attributes[:'date_time']
|
108
121
|
end
|
@@ -111,10 +124,6 @@ module VeloPayments
|
|
111
124
|
self.status = attributes[:'status']
|
112
125
|
end
|
113
126
|
|
114
|
-
if attributes.key?(:'currency')
|
115
|
-
self.currency = attributes[:'currency']
|
116
|
-
end
|
117
|
-
|
118
127
|
if attributes.key?(:'source_account_name')
|
119
128
|
self.source_account_name = attributes[:'source_account_name']
|
120
129
|
end
|
@@ -193,9 +202,9 @@ module VeloPayments
|
|
193
202
|
return true if self.equal?(o)
|
194
203
|
self.class == o.class &&
|
195
204
|
amount == o.amount &&
|
205
|
+
currency == o.currency &&
|
196
206
|
date_time == o.date_time &&
|
197
207
|
status == o.status &&
|
198
|
-
currency == o.currency &&
|
199
208
|
source_account_name == o.source_account_name &&
|
200
209
|
funding_account_name == o.funding_account_name &&
|
201
210
|
funding_type == o.funding_type &&
|
@@ -212,7 +221,7 @@ module VeloPayments
|
|
212
221
|
# Calculates hash code according to all attributes.
|
213
222
|
# @return [Integer] Hash code
|
214
223
|
def hash
|
215
|
-
[amount, date_time, status,
|
224
|
+
[amount, currency, date_time, status, source_account_name, funding_account_name, funding_type, events, topup_type].hash
|
216
225
|
end
|
217
226
|
|
218
227
|
# Builds the object from hash
|
@@ -228,7 +237,9 @@ module VeloPayments
|
|
228
237
|
def build_from_hash(attributes)
|
229
238
|
return nil unless attributes.is_a?(Hash)
|
230
239
|
self.class.openapi_types.each_pair do |key, type|
|
231
|
-
if
|
240
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
241
|
+
self.send("#{key}=", nil)
|
242
|
+
elsif type =~ /\AArray<(.*)>/i
|
232
243
|
# check to ensure the input is an array given that the attribute
|
233
244
|
# is documented as an array but the input is not
|
234
245
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -236,7 +247,7 @@ module VeloPayments
|
|
236
247
|
end
|
237
248
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
238
249
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
239
|
-
end
|
250
|
+
end
|
240
251
|
end
|
241
252
|
|
242
253
|
self
|
@@ -248,8 +259,8 @@ module VeloPayments
|
|
248
259
|
# @return [Object] Deserialized data
|
249
260
|
def _deserialize(type, value)
|
250
261
|
case type.to_sym
|
251
|
-
when :
|
252
|
-
|
262
|
+
when :Time
|
263
|
+
Time.parse(value)
|
253
264
|
when :Date
|
254
265
|
Date.parse(value)
|
255
266
|
when :String
|
@@ -301,7 +312,11 @@ module VeloPayments
|
|
301
312
|
hash = {}
|
302
313
|
self.class.attribute_map.each_pair do |attr, param|
|
303
314
|
value = self.send(attr)
|
304
|
-
|
315
|
+
if value.nil?
|
316
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
317
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
318
|
+
end
|
319
|
+
|
305
320
|
hash[param] = _to_hash(value)
|
306
321
|
end
|
307
322
|
hash
|
@@ -324,5 +339,6 @@ module VeloPayments
|
|
324
339
|
value
|
325
340
|
end
|
326
341
|
end
|
342
|
+
|
327
343
|
end
|
328
344
|
end
|