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
@@ -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
|
|
@@ -19,25 +19,25 @@ module VeloPayments
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# List
|
23
|
-
# List the
|
22
|
+
# List Payment Channel Country Rules
|
23
|
+
# List the country specific payment channel rules.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @return [
|
26
|
-
def
|
27
|
-
data, _status_code, _headers =
|
25
|
+
# @return [PaymentChannelRulesResponse]
|
26
|
+
def list_payment_channel_rules_v1(opts = {})
|
27
|
+
data, _status_code, _headers = list_payment_channel_rules_v1_with_http_info(opts)
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
31
|
-
# List
|
32
|
-
# List the
|
31
|
+
# List Payment Channel Country Rules
|
32
|
+
# List the country specific payment channel rules.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
|
-
# @return [Array<(
|
35
|
-
def
|
34
|
+
# @return [Array<(PaymentChannelRulesResponse, Integer, Hash)>] PaymentChannelRulesResponse data, response status code and response headers
|
35
|
+
def list_payment_channel_rules_v1_with_http_info(opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: CountriesApi.
|
37
|
+
@api_client.config.logger.debug 'Calling API: CountriesApi.list_payment_channel_rules_v1 ...'
|
38
38
|
end
|
39
39
|
# resource path
|
40
|
-
local_var_path = '/
|
40
|
+
local_var_path = '/v1/paymentChannelRules'
|
41
41
|
|
42
42
|
# query parameters
|
43
43
|
query_params = opts[:query_params] || {}
|
@@ -51,15 +51,16 @@ module VeloPayments
|
|
51
51
|
form_params = opts[:form_params] || {}
|
52
52
|
|
53
53
|
# http body (model)
|
54
|
-
post_body = opts[:
|
54
|
+
post_body = opts[:debug_body]
|
55
55
|
|
56
56
|
# return_type
|
57
|
-
return_type = opts[:
|
57
|
+
return_type = opts[:debug_return_type] || 'PaymentChannelRulesResponse'
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:
|
60
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
|
+
:operation => :"CountriesApi.list_payment_channel_rules_v1",
|
63
64
|
:header_params => header_params,
|
64
65
|
:query_params => query_params,
|
65
66
|
:form_params => form_params,
|
@@ -70,13 +71,13 @@ module VeloPayments
|
|
70
71
|
|
71
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
72
73
|
if @api_client.config.debugging
|
73
|
-
@api_client.config.logger.debug "API called: CountriesApi#
|
74
|
+
@api_client.config.logger.debug "API called: CountriesApi#list_payment_channel_rules_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
75
|
end
|
75
76
|
return data, status_code, headers
|
76
77
|
end
|
77
78
|
|
78
79
|
# List Supported Countries
|
79
|
-
# List the supported countries.
|
80
|
+
# <p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
|
80
81
|
# @param [Hash] opts the optional parameters
|
81
82
|
# @return [SupportedCountriesResponse]
|
82
83
|
def list_supported_countries_v1(opts = {})
|
@@ -85,7 +86,7 @@ module VeloPayments
|
|
85
86
|
end
|
86
87
|
|
87
88
|
# List Supported Countries
|
88
|
-
# List the supported countries.
|
89
|
+
# <p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
|
89
90
|
# @param [Hash] opts the optional parameters
|
90
91
|
# @return [Array<(SupportedCountriesResponse, Integer, Hash)>] SupportedCountriesResponse data, response status code and response headers
|
91
92
|
def list_supported_countries_v1_with_http_info(opts = {})
|
@@ -107,15 +108,16 @@ module VeloPayments
|
|
107
108
|
form_params = opts[:form_params] || {}
|
108
109
|
|
109
110
|
# http body (model)
|
110
|
-
post_body = opts[:
|
111
|
+
post_body = opts[:debug_body]
|
111
112
|
|
112
113
|
# return_type
|
113
|
-
return_type = opts[:
|
114
|
+
return_type = opts[:debug_return_type] || 'SupportedCountriesResponse'
|
114
115
|
|
115
116
|
# auth_names
|
116
|
-
auth_names = opts[:
|
117
|
+
auth_names = opts[:debug_auth_names] || []
|
117
118
|
|
118
119
|
new_options = opts.merge(
|
120
|
+
:operation => :"CountriesApi.list_supported_countries_v1",
|
119
121
|
:header_params => header_params,
|
120
122
|
:query_params => query_params,
|
121
123
|
:form_params => form_params,
|
@@ -131,25 +133,25 @@ module VeloPayments
|
|
131
133
|
return data, status_code, headers
|
132
134
|
end
|
133
135
|
|
134
|
-
# List
|
135
|
-
# List the
|
136
|
+
# List Supported Countries
|
137
|
+
# List the supported countries.
|
136
138
|
# @param [Hash] opts the optional parameters
|
137
|
-
# @return [
|
138
|
-
def
|
139
|
-
data, _status_code, _headers =
|
139
|
+
# @return [SupportedCountriesResponseV2]
|
140
|
+
def list_supported_countries_v2(opts = {})
|
141
|
+
data, _status_code, _headers = list_supported_countries_v2_with_http_info(opts)
|
140
142
|
data
|
141
143
|
end
|
142
144
|
|
143
|
-
# List
|
144
|
-
# List the
|
145
|
+
# List Supported Countries
|
146
|
+
# List the supported countries.
|
145
147
|
# @param [Hash] opts the optional parameters
|
146
|
-
# @return [Array<(
|
147
|
-
def
|
148
|
+
# @return [Array<(SupportedCountriesResponseV2, Integer, Hash)>] SupportedCountriesResponseV2 data, response status code and response headers
|
149
|
+
def list_supported_countries_v2_with_http_info(opts = {})
|
148
150
|
if @api_client.config.debugging
|
149
|
-
@api_client.config.logger.debug 'Calling API: CountriesApi.
|
151
|
+
@api_client.config.logger.debug 'Calling API: CountriesApi.list_supported_countries_v2 ...'
|
150
152
|
end
|
151
153
|
# resource path
|
152
|
-
local_var_path = '/
|
154
|
+
local_var_path = '/v2/supportedCountries'
|
153
155
|
|
154
156
|
# query parameters
|
155
157
|
query_params = opts[:query_params] || {}
|
@@ -163,15 +165,16 @@ module VeloPayments
|
|
163
165
|
form_params = opts[:form_params] || {}
|
164
166
|
|
165
167
|
# http body (model)
|
166
|
-
post_body = opts[:
|
168
|
+
post_body = opts[:debug_body]
|
167
169
|
|
168
170
|
# return_type
|
169
|
-
return_type = opts[:
|
171
|
+
return_type = opts[:debug_return_type] || 'SupportedCountriesResponseV2'
|
170
172
|
|
171
173
|
# auth_names
|
172
|
-
auth_names = opts[:
|
174
|
+
auth_names = opts[:debug_auth_names] || []
|
173
175
|
|
174
176
|
new_options = opts.merge(
|
177
|
+
:operation => :"CountriesApi.list_supported_countries_v2",
|
175
178
|
:header_params => header_params,
|
176
179
|
:query_params => query_params,
|
177
180
|
:form_params => form_params,
|
@@ -182,7 +185,7 @@ module VeloPayments
|
|
182
185
|
|
183
186
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
184
187
|
if @api_client.config.debugging
|
185
|
-
@api_client.config.logger.debug "API called: CountriesApi#
|
188
|
+
@api_client.config.logger.debug "API called: CountriesApi#list_supported_countries_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
186
189
|
end
|
187
190
|
return data, status_code, headers
|
188
191
|
end
|
@@ -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
|
|
@@ -22,19 +22,19 @@ module VeloPayments
|
|
22
22
|
# List Supported Currencies
|
23
23
|
# List the supported currencies.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @return [
|
26
|
-
def
|
27
|
-
data, _status_code, _headers =
|
25
|
+
# @return [SupportedCurrencyResponseV2]
|
26
|
+
def list_supported_currencies_v2(opts = {})
|
27
|
+
data, _status_code, _headers = list_supported_currencies_v2_with_http_info(opts)
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
31
31
|
# List Supported Currencies
|
32
32
|
# List the supported currencies.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
|
-
# @return [Array<(
|
35
|
-
def
|
34
|
+
# @return [Array<(SupportedCurrencyResponseV2, Integer, Hash)>] SupportedCurrencyResponseV2 data, response status code and response headers
|
35
|
+
def list_supported_currencies_v2_with_http_info(opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: CurrenciesApi.
|
37
|
+
@api_client.config.logger.debug 'Calling API: CurrenciesApi.list_supported_currencies_v2 ...'
|
38
38
|
end
|
39
39
|
# resource path
|
40
40
|
local_var_path = '/v2/currencies'
|
@@ -51,15 +51,16 @@ module VeloPayments
|
|
51
51
|
form_params = opts[:form_params] || {}
|
52
52
|
|
53
53
|
# http body (model)
|
54
|
-
post_body = opts[:
|
54
|
+
post_body = opts[:debug_body]
|
55
55
|
|
56
56
|
# return_type
|
57
|
-
return_type = opts[:
|
57
|
+
return_type = opts[:debug_return_type] || 'SupportedCurrencyResponseV2'
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:
|
60
|
+
auth_names = opts[:debug_auth_names] || []
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
|
+
:operation => :"CurrenciesApi.list_supported_currencies_v2",
|
63
64
|
:header_params => header_params,
|
64
65
|
:query_params => query_params,
|
65
66
|
:form_params => form_params,
|
@@ -70,7 +71,7 @@ module VeloPayments
|
|
70
71
|
|
71
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
72
73
|
if @api_client.config.debugging
|
73
|
-
@api_client.config.logger.debug "API called: CurrenciesApi#
|
74
|
+
@api_client.config.logger.debug "API called: CurrenciesApi#list_supported_currencies_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
75
|
end
|
75
76
|
return data, status_code, headers
|
76
77
|
end
|
@@ -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
|
|
@@ -22,7 +22,7 @@ module VeloPayments
|
|
22
22
|
# Create Funding Request
|
23
23
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
|
24
24
|
# @param source_account_id [String] Source account id
|
25
|
-
# @param funding_request_v1 [FundingRequestV1] Body to included
|
25
|
+
# @param funding_request_v1 [FundingRequestV1] Body to included amount to be funded
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [nil]
|
28
28
|
def create_ach_funding_request(source_account_id, funding_request_v1, opts = {})
|
@@ -33,7 +33,7 @@ module VeloPayments
|
|
33
33
|
# Create Funding Request
|
34
34
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
|
35
35
|
# @param source_account_id [String] Source account id
|
36
|
-
# @param funding_request_v1 [FundingRequestV1] Body to included
|
36
|
+
# @param funding_request_v1 [FundingRequestV1] Body to included amount to be funded
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
39
|
def create_ach_funding_request_with_http_info(source_account_id, funding_request_v1, opts = {})
|
@@ -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(funding_request_v1)
|
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 => :"FundingManagerApi.create_ach_funding_request",
|
77
78
|
:header_params => header_params,
|
78
79
|
:query_params => query_params,
|
79
80
|
:form_params => form_params,
|
@@ -92,7 +93,7 @@ module VeloPayments
|
|
92
93
|
# Create Funding Request
|
93
94
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
94
95
|
# @param source_account_id [String] Source account id
|
95
|
-
# @param funding_request_v2 [FundingRequestV2] Body to included
|
96
|
+
# @param funding_request_v2 [FundingRequestV2] Body to included amount to be funded
|
96
97
|
# @param [Hash] opts the optional parameters
|
97
98
|
# @return [nil]
|
98
99
|
def create_funding_request(source_account_id, funding_request_v2, opts = {})
|
@@ -103,7 +104,7 @@ module VeloPayments
|
|
103
104
|
# Create Funding Request
|
104
105
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
105
106
|
# @param source_account_id [String] Source account id
|
106
|
-
# @param funding_request_v2 [FundingRequestV2] Body to included
|
107
|
+
# @param funding_request_v2 [FundingRequestV2] Body to included amount to be funded
|
107
108
|
# @param [Hash] opts the optional parameters
|
108
109
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
109
110
|
def create_funding_request_with_http_info(source_account_id, funding_request_v2, opts = {})
|
@@ -135,15 +136,16 @@ module VeloPayments
|
|
135
136
|
form_params = opts[:form_params] || {}
|
136
137
|
|
137
138
|
# http body (model)
|
138
|
-
post_body = opts[:
|
139
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(funding_request_v2)
|
139
140
|
|
140
141
|
# return_type
|
141
|
-
return_type = opts[:
|
142
|
+
return_type = opts[:debug_return_type]
|
142
143
|
|
143
144
|
# auth_names
|
144
|
-
auth_names = opts[:
|
145
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
145
146
|
|
146
147
|
new_options = opts.merge(
|
148
|
+
:operation => :"FundingManagerApi.create_funding_request",
|
147
149
|
:header_params => header_params,
|
148
150
|
:query_params => query_params,
|
149
151
|
:form_params => form_params,
|
@@ -159,6 +161,77 @@ module VeloPayments
|
|
159
161
|
return data, status_code, headers
|
160
162
|
end
|
161
163
|
|
164
|
+
# Create Funding Request
|
165
|
+
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
166
|
+
# @param source_account_id [String] Source account id
|
167
|
+
# @param funding_request_v3 [FundingRequestV3] Body to included amount to be funded
|
168
|
+
# @param [Hash] opts the optional parameters
|
169
|
+
# @return [nil]
|
170
|
+
def create_funding_request_v3(source_account_id, funding_request_v3, opts = {})
|
171
|
+
create_funding_request_v3_with_http_info(source_account_id, funding_request_v3, opts)
|
172
|
+
nil
|
173
|
+
end
|
174
|
+
|
175
|
+
# Create Funding Request
|
176
|
+
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
177
|
+
# @param source_account_id [String] Source account id
|
178
|
+
# @param funding_request_v3 [FundingRequestV3] Body to included amount to be funded
|
179
|
+
# @param [Hash] opts the optional parameters
|
180
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
181
|
+
def create_funding_request_v3_with_http_info(source_account_id, funding_request_v3, opts = {})
|
182
|
+
if @api_client.config.debugging
|
183
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.create_funding_request_v3 ...'
|
184
|
+
end
|
185
|
+
# verify the required parameter 'source_account_id' is set
|
186
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
187
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.create_funding_request_v3"
|
188
|
+
end
|
189
|
+
# verify the required parameter 'funding_request_v3' is set
|
190
|
+
if @api_client.config.client_side_validation && funding_request_v3.nil?
|
191
|
+
fail ArgumentError, "Missing the required parameter 'funding_request_v3' when calling FundingManagerApi.create_funding_request_v3"
|
192
|
+
end
|
193
|
+
# resource path
|
194
|
+
local_var_path = '/v3/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
|
195
|
+
|
196
|
+
# query parameters
|
197
|
+
query_params = opts[:query_params] || {}
|
198
|
+
|
199
|
+
# header parameters
|
200
|
+
header_params = opts[:header_params] || {}
|
201
|
+
# HTTP header 'Accept' (if needed)
|
202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
|
+
# HTTP header 'Content-Type'
|
204
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
205
|
+
|
206
|
+
# form parameters
|
207
|
+
form_params = opts[:form_params] || {}
|
208
|
+
|
209
|
+
# http body (model)
|
210
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(funding_request_v3)
|
211
|
+
|
212
|
+
# return_type
|
213
|
+
return_type = opts[:debug_return_type]
|
214
|
+
|
215
|
+
# auth_names
|
216
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
217
|
+
|
218
|
+
new_options = opts.merge(
|
219
|
+
:operation => :"FundingManagerApi.create_funding_request_v3",
|
220
|
+
:header_params => header_params,
|
221
|
+
:query_params => query_params,
|
222
|
+
:form_params => form_params,
|
223
|
+
:body => post_body,
|
224
|
+
:auth_names => auth_names,
|
225
|
+
:return_type => return_type
|
226
|
+
)
|
227
|
+
|
228
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
229
|
+
if @api_client.config.debugging
|
230
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#create_funding_request_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
231
|
+
end
|
232
|
+
return data, status_code, headers
|
233
|
+
end
|
234
|
+
|
162
235
|
# Get Funding Account
|
163
236
|
# Get Funding Account by ID
|
164
237
|
# @param funding_account_id [String]
|
@@ -200,15 +273,16 @@ module VeloPayments
|
|
200
273
|
form_params = opts[:form_params] || {}
|
201
274
|
|
202
275
|
# http body (model)
|
203
|
-
post_body = opts[:
|
276
|
+
post_body = opts[:debug_body]
|
204
277
|
|
205
278
|
# return_type
|
206
|
-
return_type = opts[:
|
279
|
+
return_type = opts[:debug_return_type] || 'FundingAccountResponse'
|
207
280
|
|
208
281
|
# auth_names
|
209
|
-
auth_names = opts[:
|
282
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
210
283
|
|
211
284
|
new_options = opts.merge(
|
285
|
+
:operation => :"FundingManagerApi.get_funding_account",
|
212
286
|
:header_params => header_params,
|
213
287
|
:query_params => query_params,
|
214
288
|
:form_params => form_params,
|
@@ -224,14 +298,80 @@ module VeloPayments
|
|
224
298
|
return data, status_code, headers
|
225
299
|
end
|
226
300
|
|
301
|
+
# Get Funding Account
|
302
|
+
# Get Funding Account by ID
|
303
|
+
# @param funding_account_id [String]
|
304
|
+
# @param [Hash] opts the optional parameters
|
305
|
+
# @option opts [Boolean] :sensitive (default to false)
|
306
|
+
# @return [FundingAccountResponse2]
|
307
|
+
def get_funding_account_v2(funding_account_id, opts = {})
|
308
|
+
data, _status_code, _headers = get_funding_account_v2_with_http_info(funding_account_id, opts)
|
309
|
+
data
|
310
|
+
end
|
311
|
+
|
312
|
+
# Get Funding Account
|
313
|
+
# Get Funding Account by ID
|
314
|
+
# @param funding_account_id [String]
|
315
|
+
# @param [Hash] opts the optional parameters
|
316
|
+
# @option opts [Boolean] :sensitive
|
317
|
+
# @return [Array<(FundingAccountResponse2, Integer, Hash)>] FundingAccountResponse2 data, response status code and response headers
|
318
|
+
def get_funding_account_v2_with_http_info(funding_account_id, opts = {})
|
319
|
+
if @api_client.config.debugging
|
320
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_funding_account_v2 ...'
|
321
|
+
end
|
322
|
+
# verify the required parameter 'funding_account_id' is set
|
323
|
+
if @api_client.config.client_side_validation && funding_account_id.nil?
|
324
|
+
fail ArgumentError, "Missing the required parameter 'funding_account_id' when calling FundingManagerApi.get_funding_account_v2"
|
325
|
+
end
|
326
|
+
# resource path
|
327
|
+
local_var_path = '/v2/fundingAccounts/{fundingAccountId}'.sub('{' + 'fundingAccountId' + '}', CGI.escape(funding_account_id.to_s))
|
328
|
+
|
329
|
+
# query parameters
|
330
|
+
query_params = opts[:query_params] || {}
|
331
|
+
query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
|
332
|
+
|
333
|
+
# header parameters
|
334
|
+
header_params = opts[:header_params] || {}
|
335
|
+
# HTTP header 'Accept' (if needed)
|
336
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
337
|
+
|
338
|
+
# form parameters
|
339
|
+
form_params = opts[:form_params] || {}
|
340
|
+
|
341
|
+
# http body (model)
|
342
|
+
post_body = opts[:debug_body]
|
343
|
+
|
344
|
+
# return_type
|
345
|
+
return_type = opts[:debug_return_type] || 'FundingAccountResponse2'
|
346
|
+
|
347
|
+
# auth_names
|
348
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
349
|
+
|
350
|
+
new_options = opts.merge(
|
351
|
+
:operation => :"FundingManagerApi.get_funding_account_v2",
|
352
|
+
:header_params => header_params,
|
353
|
+
:query_params => query_params,
|
354
|
+
:form_params => form_params,
|
355
|
+
:body => post_body,
|
356
|
+
:auth_names => auth_names,
|
357
|
+
:return_type => return_type
|
358
|
+
)
|
359
|
+
|
360
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
361
|
+
if @api_client.config.debugging
|
362
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_funding_account_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
363
|
+
end
|
364
|
+
return data, status_code, headers
|
365
|
+
end
|
366
|
+
|
227
367
|
# Get Funding Accounts
|
228
|
-
# Get the
|
368
|
+
# Get the funding accounts.
|
229
369
|
# @param [Hash] opts the optional parameters
|
230
370
|
# @option opts [String] :payor_id
|
231
371
|
# @option opts [String] :source_account_id
|
232
372
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
233
|
-
# @option opts [Integer] :page_size
|
234
|
-
# @option opts [String] :sort
|
373
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
374
|
+
# @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name and currency. (default to 'accountName:asc')
|
235
375
|
# @option opts [Boolean] :sensitive (default to false)
|
236
376
|
# @return [ListFundingAccountsResponse]
|
237
377
|
def get_funding_accounts(opts = {})
|
@@ -240,19 +380,32 @@ module VeloPayments
|
|
240
380
|
end
|
241
381
|
|
242
382
|
# Get Funding Accounts
|
243
|
-
# Get the
|
383
|
+
# Get the funding accounts.
|
244
384
|
# @param [Hash] opts the optional parameters
|
245
385
|
# @option opts [String] :payor_id
|
246
386
|
# @option opts [String] :source_account_id
|
247
387
|
# @option opts [Integer] :page Page number. Default is 1.
|
248
|
-
# @option opts [Integer] :page_size
|
249
|
-
# @option opts [String] :sort
|
388
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
389
|
+
# @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name and currency.
|
250
390
|
# @option opts [Boolean] :sensitive
|
251
391
|
# @return [Array<(ListFundingAccountsResponse, Integer, Hash)>] ListFundingAccountsResponse data, response status code and response headers
|
252
392
|
def get_funding_accounts_with_http_info(opts = {})
|
253
393
|
if @api_client.config.debugging
|
254
394
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_funding_accounts ...'
|
255
395
|
end
|
396
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
397
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_funding_accounts, must be smaller than or equal to 100.'
|
398
|
+
end
|
399
|
+
|
400
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
401
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_funding_accounts, must be greater than or equal to 1.'
|
402
|
+
end
|
403
|
+
|
404
|
+
pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
|
405
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
406
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_funding_accounts, must conform to the pattern #{pattern}."
|
407
|
+
end
|
408
|
+
|
256
409
|
# resource path
|
257
410
|
local_var_path = '/v1/fundingAccounts'
|
258
411
|
|
@@ -274,15 +427,16 @@ module VeloPayments
|
|
274
427
|
form_params = opts[:form_params] || {}
|
275
428
|
|
276
429
|
# http body (model)
|
277
|
-
post_body = opts[:
|
430
|
+
post_body = opts[:debug_body]
|
278
431
|
|
279
432
|
# return_type
|
280
|
-
return_type = opts[:
|
433
|
+
return_type = opts[:debug_return_type] || 'ListFundingAccountsResponse'
|
281
434
|
|
282
435
|
# auth_names
|
283
|
-
auth_names = opts[:
|
436
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
284
437
|
|
285
438
|
new_options = opts.merge(
|
439
|
+
:operation => :"FundingManagerApi.get_funding_accounts",
|
286
440
|
:header_params => header_params,
|
287
441
|
:query_params => query_params,
|
288
442
|
:form_params => form_params,
|
@@ -298,40 +452,68 @@ module VeloPayments
|
|
298
452
|
return data, status_code, headers
|
299
453
|
end
|
300
454
|
|
301
|
-
# Get
|
302
|
-
# Get
|
455
|
+
# Get Funding Accounts
|
456
|
+
# Get the funding accounts.
|
303
457
|
# @param [Hash] opts the optional parameters
|
304
|
-
# @option opts [String] :payor_id
|
458
|
+
# @option opts [String] :payor_id
|
459
|
+
# @option opts [String] :name The descriptive funding account name
|
460
|
+
# @option opts [String] :country The 2 letter ISO 3166-1 country code (upper case)
|
461
|
+
# @option opts [String] :currency The ISO 4217 currency code
|
462
|
+
# @option opts [FundingAccountType] :type The type of funding account.
|
305
463
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
306
|
-
# @option opts [Integer] :page_size
|
307
|
-
# @option opts [String] :sort List of sort fields.
|
308
|
-
# @
|
309
|
-
|
310
|
-
|
464
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
465
|
+
# @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name. (default to 'accountName:asc')
|
466
|
+
# @option opts [Boolean] :sensitive (default to false)
|
467
|
+
# @return [ListFundingAccountsResponse2]
|
468
|
+
def get_funding_accounts_v2(opts = {})
|
469
|
+
data, _status_code, _headers = get_funding_accounts_v2_with_http_info(opts)
|
311
470
|
data
|
312
471
|
end
|
313
472
|
|
314
|
-
# Get
|
315
|
-
# Get
|
473
|
+
# Get Funding Accounts
|
474
|
+
# Get the funding accounts.
|
316
475
|
# @param [Hash] opts the optional parameters
|
317
|
-
# @option opts [String] :payor_id
|
476
|
+
# @option opts [String] :payor_id
|
477
|
+
# @option opts [String] :name The descriptive funding account name
|
478
|
+
# @option opts [String] :country The 2 letter ISO 3166-1 country code (upper case)
|
479
|
+
# @option opts [String] :currency The ISO 4217 currency code
|
480
|
+
# @option opts [FundingAccountType] :type The type of funding account.
|
318
481
|
# @option opts [Integer] :page Page number. Default is 1.
|
319
|
-
# @option opts [Integer] :page_size
|
320
|
-
# @option opts [String] :sort List of sort fields.
|
321
|
-
# @
|
322
|
-
|
482
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
483
|
+
# @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name.
|
484
|
+
# @option opts [Boolean] :sensitive
|
485
|
+
# @return [Array<(ListFundingAccountsResponse2, Integer, Hash)>] ListFundingAccountsResponse2 data, response status code and response headers
|
486
|
+
def get_funding_accounts_v2_with_http_info(opts = {})
|
323
487
|
if @api_client.config.debugging
|
324
|
-
@api_client.config.logger.debug 'Calling API: FundingManagerApi.
|
488
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_funding_accounts_v2 ...'
|
489
|
+
end
|
490
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
491
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_funding_accounts_v2, must be smaller than or equal to 100.'
|
492
|
+
end
|
493
|
+
|
494
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
495
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_funding_accounts_v2, must be greater than or equal to 1.'
|
496
|
+
end
|
497
|
+
|
498
|
+
pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
|
499
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
500
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_funding_accounts_v2, must conform to the pattern #{pattern}."
|
325
501
|
end
|
502
|
+
|
326
503
|
# resource path
|
327
|
-
local_var_path = '/
|
504
|
+
local_var_path = '/v2/fundingAccounts'
|
328
505
|
|
329
506
|
# query parameters
|
330
507
|
query_params = opts[:query_params] || {}
|
331
508
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
509
|
+
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
510
|
+
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
511
|
+
query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
|
512
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
332
513
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
333
514
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
334
515
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
516
|
+
query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
|
335
517
|
|
336
518
|
# header parameters
|
337
519
|
header_params = opts[:header_params] || {}
|
@@ -342,15 +524,16 @@ module VeloPayments
|
|
342
524
|
form_params = opts[:form_params] || {}
|
343
525
|
|
344
526
|
# http body (model)
|
345
|
-
post_body = opts[:
|
527
|
+
post_body = opts[:debug_body]
|
346
528
|
|
347
529
|
# return_type
|
348
|
-
return_type = opts[:
|
530
|
+
return_type = opts[:debug_return_type] || 'ListFundingAccountsResponse2'
|
349
531
|
|
350
532
|
# auth_names
|
351
|
-
auth_names = opts[:
|
533
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
352
534
|
|
353
535
|
new_options = opts.merge(
|
536
|
+
:operation => :"FundingManagerApi.get_funding_accounts_v2",
|
354
537
|
:header_params => header_params,
|
355
538
|
:query_params => query_params,
|
356
539
|
:form_params => form_params,
|
@@ -361,7 +544,7 @@ module VeloPayments
|
|
361
544
|
|
362
545
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
363
546
|
if @api_client.config.debugging
|
364
|
-
@api_client.config.logger.debug "API called: FundingManagerApi#
|
547
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_funding_accounts_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
365
548
|
end
|
366
549
|
return data, status_code, headers
|
367
550
|
end
|
@@ -404,15 +587,16 @@ module VeloPayments
|
|
404
587
|
form_params = opts[:form_params] || {}
|
405
588
|
|
406
589
|
# http body (model)
|
407
|
-
post_body = opts[:
|
590
|
+
post_body = opts[:debug_body]
|
408
591
|
|
409
592
|
# return_type
|
410
|
-
return_type = opts[:
|
593
|
+
return_type = opts[:debug_return_type] || 'SourceAccountResponse'
|
411
594
|
|
412
595
|
# auth_names
|
413
|
-
auth_names = opts[:
|
596
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
414
597
|
|
415
598
|
new_options = opts.merge(
|
599
|
+
:operation => :"FundingManagerApi.get_source_account",
|
416
600
|
:header_params => header_params,
|
417
601
|
:query_params => query_params,
|
418
602
|
:form_params => form_params,
|
@@ -466,15 +650,16 @@ module VeloPayments
|
|
466
650
|
form_params = opts[:form_params] || {}
|
467
651
|
|
468
652
|
# http body (model)
|
469
|
-
post_body = opts[:
|
653
|
+
post_body = opts[:debug_body]
|
470
654
|
|
471
655
|
# return_type
|
472
|
-
return_type = opts[:
|
656
|
+
return_type = opts[:debug_return_type] || 'SourceAccountResponseV2'
|
473
657
|
|
474
658
|
# auth_names
|
475
|
-
auth_names = opts[:
|
659
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
476
660
|
|
477
661
|
new_options = opts.merge(
|
662
|
+
:operation => :"FundingManagerApi.get_source_account_v2",
|
478
663
|
:header_params => header_params,
|
479
664
|
:query_params => query_params,
|
480
665
|
:form_params => form_params,
|
@@ -490,14 +675,77 @@ module VeloPayments
|
|
490
675
|
return data, status_code, headers
|
491
676
|
end
|
492
677
|
|
678
|
+
# Get details about given source account.
|
679
|
+
# Get details about given source account.
|
680
|
+
# @param source_account_id [String] Source account id
|
681
|
+
# @param [Hash] opts the optional parameters
|
682
|
+
# @return [SourceAccountResponseV3]
|
683
|
+
def get_source_account_v3(source_account_id, opts = {})
|
684
|
+
data, _status_code, _headers = get_source_account_v3_with_http_info(source_account_id, opts)
|
685
|
+
data
|
686
|
+
end
|
687
|
+
|
688
|
+
# Get details about given source account.
|
689
|
+
# Get details about given source account.
|
690
|
+
# @param source_account_id [String] Source account id
|
691
|
+
# @param [Hash] opts the optional parameters
|
692
|
+
# @return [Array<(SourceAccountResponseV3, Integer, Hash)>] SourceAccountResponseV3 data, response status code and response headers
|
693
|
+
def get_source_account_v3_with_http_info(source_account_id, opts = {})
|
694
|
+
if @api_client.config.debugging
|
695
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_account_v3 ...'
|
696
|
+
end
|
697
|
+
# verify the required parameter 'source_account_id' is set
|
698
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
699
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.get_source_account_v3"
|
700
|
+
end
|
701
|
+
# resource path
|
702
|
+
local_var_path = '/v3/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
|
703
|
+
|
704
|
+
# query parameters
|
705
|
+
query_params = opts[:query_params] || {}
|
706
|
+
|
707
|
+
# header parameters
|
708
|
+
header_params = opts[:header_params] || {}
|
709
|
+
# HTTP header 'Accept' (if needed)
|
710
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
711
|
+
|
712
|
+
# form parameters
|
713
|
+
form_params = opts[:form_params] || {}
|
714
|
+
|
715
|
+
# http body (model)
|
716
|
+
post_body = opts[:debug_body]
|
717
|
+
|
718
|
+
# return_type
|
719
|
+
return_type = opts[:debug_return_type] || 'SourceAccountResponseV3'
|
720
|
+
|
721
|
+
# auth_names
|
722
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
723
|
+
|
724
|
+
new_options = opts.merge(
|
725
|
+
:operation => :"FundingManagerApi.get_source_account_v3",
|
726
|
+
:header_params => header_params,
|
727
|
+
:query_params => query_params,
|
728
|
+
:form_params => form_params,
|
729
|
+
:body => post_body,
|
730
|
+
:auth_names => auth_names,
|
731
|
+
:return_type => return_type
|
732
|
+
)
|
733
|
+
|
734
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
735
|
+
if @api_client.config.debugging
|
736
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_account_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
737
|
+
end
|
738
|
+
return data, status_code, headers
|
739
|
+
end
|
740
|
+
|
493
741
|
# Get list of source accounts
|
494
742
|
# List source accounts.
|
495
743
|
# @param [Hash] opts the optional parameters
|
496
744
|
# @option opts [String] :physical_account_name Physical Account Name
|
497
745
|
# @option opts [String] :payor_id The account owner Payor ID
|
498
746
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
499
|
-
# @option opts [Integer] :page_size
|
500
|
-
# @option opts [String] :sort
|
747
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
748
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef (default to 'fundingRef:asc')
|
501
749
|
# @return [ListSourceAccountResponse]
|
502
750
|
def get_source_accounts(opts = {})
|
503
751
|
data, _status_code, _headers = get_source_accounts_with_http_info(opts)
|
@@ -510,13 +758,26 @@ module VeloPayments
|
|
510
758
|
# @option opts [String] :physical_account_name Physical Account Name
|
511
759
|
# @option opts [String] :payor_id The account owner Payor ID
|
512
760
|
# @option opts [Integer] :page Page number. Default is 1.
|
513
|
-
# @option opts [Integer] :page_size
|
514
|
-
# @option opts [String] :sort
|
761
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
762
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef
|
515
763
|
# @return [Array<(ListSourceAccountResponse, Integer, Hash)>] ListSourceAccountResponse data, response status code and response headers
|
516
764
|
def get_source_accounts_with_http_info(opts = {})
|
517
765
|
if @api_client.config.debugging
|
518
766
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts ...'
|
519
767
|
end
|
768
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
769
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts, must be smaller than or equal to 100.'
|
770
|
+
end
|
771
|
+
|
772
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
773
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts, must be greater than or equal to 1.'
|
774
|
+
end
|
775
|
+
|
776
|
+
pattern = Regexp.new(/[fundingRef]+[:desc|:asc]/)
|
777
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
778
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts, must conform to the pattern #{pattern}."
|
779
|
+
end
|
780
|
+
|
520
781
|
# resource path
|
521
782
|
local_var_path = '/v1/sourceAccounts'
|
522
783
|
|
@@ -537,15 +798,16 @@ module VeloPayments
|
|
537
798
|
form_params = opts[:form_params] || {}
|
538
799
|
|
539
800
|
# http body (model)
|
540
|
-
post_body = opts[:
|
801
|
+
post_body = opts[:debug_body]
|
541
802
|
|
542
803
|
# return_type
|
543
|
-
return_type = opts[:
|
804
|
+
return_type = opts[:debug_return_type] || 'ListSourceAccountResponse'
|
544
805
|
|
545
806
|
# auth_names
|
546
|
-
auth_names = opts[:
|
807
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
547
808
|
|
548
809
|
new_options = opts.merge(
|
810
|
+
:operation => :"FundingManagerApi.get_source_accounts",
|
549
811
|
:header_params => header_params,
|
550
812
|
:query_params => query_params,
|
551
813
|
:form_params => form_params,
|
@@ -565,10 +827,12 @@ module VeloPayments
|
|
565
827
|
# List source accounts.
|
566
828
|
# @param [Hash] opts the optional parameters
|
567
829
|
# @option opts [String] :physical_account_name Physical Account Name
|
830
|
+
# @option opts [String] :physical_account_id The physical account ID
|
568
831
|
# @option opts [String] :payor_id The account owner Payor ID
|
832
|
+
# @option opts [String] :funding_account_id The funding account ID
|
569
833
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
570
|
-
# @option opts [Integer] :page_size
|
571
|
-
# @option opts [String] :sort
|
834
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
835
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance (default to 'fundingRef:asc')
|
572
836
|
# @return [ListSourceAccountResponseV2]
|
573
837
|
def get_source_accounts_v2(opts = {})
|
574
838
|
data, _status_code, _headers = get_source_accounts_v2_with_http_info(opts)
|
@@ -579,22 +843,39 @@ module VeloPayments
|
|
579
843
|
# List source accounts.
|
580
844
|
# @param [Hash] opts the optional parameters
|
581
845
|
# @option opts [String] :physical_account_name Physical Account Name
|
846
|
+
# @option opts [String] :physical_account_id The physical account ID
|
582
847
|
# @option opts [String] :payor_id The account owner Payor ID
|
848
|
+
# @option opts [String] :funding_account_id The funding account ID
|
583
849
|
# @option opts [Integer] :page Page number. Default is 1.
|
584
|
-
# @option opts [Integer] :page_size
|
585
|
-
# @option opts [String] :sort
|
850
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
851
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
|
586
852
|
# @return [Array<(ListSourceAccountResponseV2, Integer, Hash)>] ListSourceAccountResponseV2 data, response status code and response headers
|
587
853
|
def get_source_accounts_v2_with_http_info(opts = {})
|
588
854
|
if @api_client.config.debugging
|
589
855
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts_v2 ...'
|
590
856
|
end
|
857
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
858
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts_v2, must be smaller than or equal to 100.'
|
859
|
+
end
|
860
|
+
|
861
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
862
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts_v2, must be greater than or equal to 1.'
|
863
|
+
end
|
864
|
+
|
865
|
+
pattern = Regexp.new(/[fundingRef|name|balance]+[:desc|:asc]/)
|
866
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
867
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts_v2, must conform to the pattern #{pattern}."
|
868
|
+
end
|
869
|
+
|
591
870
|
# resource path
|
592
871
|
local_var_path = '/v2/sourceAccounts'
|
593
872
|
|
594
873
|
# query parameters
|
595
874
|
query_params = opts[:query_params] || {}
|
596
875
|
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
|
876
|
+
query_params[:'physicalAccountId'] = opts[:'physical_account_id'] if !opts[:'physical_account_id'].nil?
|
597
877
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
878
|
+
query_params[:'fundingAccountId'] = opts[:'funding_account_id'] if !opts[:'funding_account_id'].nil?
|
598
879
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
599
880
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
600
881
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -608,15 +889,16 @@ module VeloPayments
|
|
608
889
|
form_params = opts[:form_params] || {}
|
609
890
|
|
610
891
|
# http body (model)
|
611
|
-
post_body = opts[:
|
892
|
+
post_body = opts[:debug_body]
|
612
893
|
|
613
894
|
# return_type
|
614
|
-
return_type = opts[:
|
895
|
+
return_type = opts[:debug_return_type] || 'ListSourceAccountResponseV2'
|
615
896
|
|
616
897
|
# auth_names
|
617
|
-
auth_names = opts[:
|
898
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
618
899
|
|
619
900
|
new_options = opts.merge(
|
901
|
+
:operation => :"FundingManagerApi.get_source_accounts_v2",
|
620
902
|
:header_params => header_params,
|
621
903
|
:query_params => query_params,
|
622
904
|
:form_params => form_params,
|
@@ -632,13 +914,107 @@ module VeloPayments
|
|
632
914
|
return data, status_code, headers
|
633
915
|
end
|
634
916
|
|
917
|
+
# Get list of source accounts
|
918
|
+
# List source accounts.
|
919
|
+
# @param [Hash] opts the optional parameters
|
920
|
+
# @option opts [String] :physical_account_name Physical Account Name
|
921
|
+
# @option opts [String] :physical_account_id The physical account ID
|
922
|
+
# @option opts [String] :payor_id The account owner Payor ID
|
923
|
+
# @option opts [String] :funding_account_id The funding account ID
|
924
|
+
# @option opts [SourceAccountType] :type The type of source account.
|
925
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
926
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
927
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance (default to 'fundingRef:asc')
|
928
|
+
# @return [ListSourceAccountResponseV3]
|
929
|
+
def get_source_accounts_v3(opts = {})
|
930
|
+
data, _status_code, _headers = get_source_accounts_v3_with_http_info(opts)
|
931
|
+
data
|
932
|
+
end
|
933
|
+
|
934
|
+
# Get list of source accounts
|
935
|
+
# List source accounts.
|
936
|
+
# @param [Hash] opts the optional parameters
|
937
|
+
# @option opts [String] :physical_account_name Physical Account Name
|
938
|
+
# @option opts [String] :physical_account_id The physical account ID
|
939
|
+
# @option opts [String] :payor_id The account owner Payor ID
|
940
|
+
# @option opts [String] :funding_account_id The funding account ID
|
941
|
+
# @option opts [SourceAccountType] :type The type of source account.
|
942
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
943
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
944
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
|
945
|
+
# @return [Array<(ListSourceAccountResponseV3, Integer, Hash)>] ListSourceAccountResponseV3 data, response status code and response headers
|
946
|
+
def get_source_accounts_v3_with_http_info(opts = {})
|
947
|
+
if @api_client.config.debugging
|
948
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts_v3 ...'
|
949
|
+
end
|
950
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
951
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts_v3, must be smaller than or equal to 100.'
|
952
|
+
end
|
953
|
+
|
954
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
955
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.get_source_accounts_v3, must be greater than or equal to 1.'
|
956
|
+
end
|
957
|
+
|
958
|
+
pattern = Regexp.new(/[fundingRef|name|balance]+[:desc|:asc]/)
|
959
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
960
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts_v3, must conform to the pattern #{pattern}."
|
961
|
+
end
|
962
|
+
|
963
|
+
# resource path
|
964
|
+
local_var_path = '/v3/sourceAccounts'
|
965
|
+
|
966
|
+
# query parameters
|
967
|
+
query_params = opts[:query_params] || {}
|
968
|
+
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
|
969
|
+
query_params[:'physicalAccountId'] = opts[:'physical_account_id'] if !opts[:'physical_account_id'].nil?
|
970
|
+
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
971
|
+
query_params[:'fundingAccountId'] = opts[:'funding_account_id'] if !opts[:'funding_account_id'].nil?
|
972
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
973
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
974
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
975
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
976
|
+
|
977
|
+
# header parameters
|
978
|
+
header_params = opts[:header_params] || {}
|
979
|
+
# HTTP header 'Accept' (if needed)
|
980
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
981
|
+
|
982
|
+
# form parameters
|
983
|
+
form_params = opts[:form_params] || {}
|
984
|
+
|
985
|
+
# http body (model)
|
986
|
+
post_body = opts[:debug_body]
|
987
|
+
|
988
|
+
# return_type
|
989
|
+
return_type = opts[:debug_return_type] || 'ListSourceAccountResponseV3'
|
990
|
+
|
991
|
+
# auth_names
|
992
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
993
|
+
|
994
|
+
new_options = opts.merge(
|
995
|
+
:operation => :"FundingManagerApi.get_source_accounts_v3",
|
996
|
+
:header_params => header_params,
|
997
|
+
:query_params => query_params,
|
998
|
+
:form_params => form_params,
|
999
|
+
:body => post_body,
|
1000
|
+
:auth_names => auth_names,
|
1001
|
+
:return_type => return_type
|
1002
|
+
)
|
1003
|
+
|
1004
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1005
|
+
if @api_client.config.debugging
|
1006
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_accounts_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1007
|
+
end
|
1008
|
+
return data, status_code, headers
|
1009
|
+
end
|
1010
|
+
|
635
1011
|
# Get Funding Audit Delta
|
636
1012
|
# Get funding audit deltas for a payor
|
637
1013
|
# @param payor_id [String]
|
638
|
-
# @param updated_since [
|
1014
|
+
# @param updated_since [Time]
|
639
1015
|
# @param [Hash] opts the optional parameters
|
640
1016
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
641
|
-
# @option opts [Integer] :page_size
|
1017
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
642
1018
|
# @return [PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse]
|
643
1019
|
def list_funding_audit_deltas(payor_id, updated_since, opts = {})
|
644
1020
|
data, _status_code, _headers = list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts)
|
@@ -648,10 +1024,10 @@ module VeloPayments
|
|
648
1024
|
# Get Funding Audit Delta
|
649
1025
|
# Get funding audit deltas for a payor
|
650
1026
|
# @param payor_id [String]
|
651
|
-
# @param updated_since [
|
1027
|
+
# @param updated_since [Time]
|
652
1028
|
# @param [Hash] opts the optional parameters
|
653
1029
|
# @option opts [Integer] :page Page number. Default is 1.
|
654
|
-
# @option opts [Integer] :page_size
|
1030
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
655
1031
|
# @return [Array<(PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse, Integer, Hash)>] PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse data, response status code and response headers
|
656
1032
|
def list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts = {})
|
657
1033
|
if @api_client.config.debugging
|
@@ -665,6 +1041,14 @@ module VeloPayments
|
|
665
1041
|
if @api_client.config.client_side_validation && updated_since.nil?
|
666
1042
|
fail ArgumentError, "Missing the required parameter 'updated_since' when calling FundingManagerApi.list_funding_audit_deltas"
|
667
1043
|
end
|
1044
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1045
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.list_funding_audit_deltas, must be smaller than or equal to 100.'
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1049
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FundingManagerApi.list_funding_audit_deltas, must be greater than or equal to 1.'
|
1050
|
+
end
|
1051
|
+
|
668
1052
|
# resource path
|
669
1053
|
local_var_path = '/v1/deltas/fundings'
|
670
1054
|
|
@@ -684,15 +1068,16 @@ module VeloPayments
|
|
684
1068
|
form_params = opts[:form_params] || {}
|
685
1069
|
|
686
1070
|
# http body (model)
|
687
|
-
post_body = opts[:
|
1071
|
+
post_body = opts[:debug_body]
|
688
1072
|
|
689
1073
|
# return_type
|
690
|
-
return_type = opts[:
|
1074
|
+
return_type = opts[:debug_return_type] || 'PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse'
|
691
1075
|
|
692
1076
|
# auth_names
|
693
|
-
auth_names = opts[:
|
1077
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
694
1078
|
|
695
1079
|
new_options = opts.merge(
|
1080
|
+
:operation => :"FundingManagerApi.list_funding_audit_deltas",
|
696
1081
|
:header_params => header_params,
|
697
1082
|
:query_params => query_params,
|
698
1083
|
:form_params => form_params,
|
@@ -754,15 +1139,16 @@ module VeloPayments
|
|
754
1139
|
form_params = opts[:form_params] || {}
|
755
1140
|
|
756
1141
|
# http body (model)
|
757
|
-
post_body = opts[:
|
1142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_notifications_request)
|
758
1143
|
|
759
1144
|
# return_type
|
760
|
-
return_type = opts[:
|
1145
|
+
return_type = opts[:debug_return_type]
|
761
1146
|
|
762
1147
|
# auth_names
|
763
|
-
auth_names = opts[:
|
1148
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
764
1149
|
|
765
1150
|
new_options = opts.merge(
|
1151
|
+
:operation => :"FundingManagerApi.set_notifications_request",
|
766
1152
|
:header_params => header_params,
|
767
1153
|
:query_params => query_params,
|
768
1154
|
:form_params => form_params,
|
@@ -824,15 +1210,16 @@ module VeloPayments
|
|
824
1210
|
form_params = opts[:form_params] || {}
|
825
1211
|
|
826
1212
|
# http body (model)
|
827
|
-
post_body = opts[:
|
1213
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_request)
|
828
1214
|
|
829
1215
|
# return_type
|
830
|
-
return_type = opts[:
|
1216
|
+
return_type = opts[:debug_return_type]
|
831
1217
|
|
832
1218
|
# auth_names
|
833
|
-
auth_names = opts[:
|
1219
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
834
1220
|
|
835
1221
|
new_options = opts.merge(
|
1222
|
+
:operation => :"FundingManagerApi.transfer_funds",
|
836
1223
|
:header_params => header_params,
|
837
1224
|
:query_params => query_params,
|
838
1225
|
:form_params => form_params,
|
@@ -847,5 +1234,76 @@ module VeloPayments
|
|
847
1234
|
end
|
848
1235
|
return data, status_code, headers
|
849
1236
|
end
|
1237
|
+
|
1238
|
+
# Transfer Funds between source accounts
|
1239
|
+
# Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
|
1240
|
+
# @param source_account_id [String] The 'from' source account id, which will be debited
|
1241
|
+
# @param transfer_request2 [TransferRequest2] Body
|
1242
|
+
# @param [Hash] opts the optional parameters
|
1243
|
+
# @return [nil]
|
1244
|
+
def transfer_funds_v3(source_account_id, transfer_request2, opts = {})
|
1245
|
+
transfer_funds_v3_with_http_info(source_account_id, transfer_request2, opts)
|
1246
|
+
nil
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
# Transfer Funds between source accounts
|
1250
|
+
# Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
|
1251
|
+
# @param source_account_id [String] The 'from' source account id, which will be debited
|
1252
|
+
# @param transfer_request2 [TransferRequest2] Body
|
1253
|
+
# @param [Hash] opts the optional parameters
|
1254
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1255
|
+
def transfer_funds_v3_with_http_info(source_account_id, transfer_request2, opts = {})
|
1256
|
+
if @api_client.config.debugging
|
1257
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.transfer_funds_v3 ...'
|
1258
|
+
end
|
1259
|
+
# verify the required parameter 'source_account_id' is set
|
1260
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
1261
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.transfer_funds_v3"
|
1262
|
+
end
|
1263
|
+
# verify the required parameter 'transfer_request2' is set
|
1264
|
+
if @api_client.config.client_side_validation && transfer_request2.nil?
|
1265
|
+
fail ArgumentError, "Missing the required parameter 'transfer_request2' when calling FundingManagerApi.transfer_funds_v3"
|
1266
|
+
end
|
1267
|
+
# resource path
|
1268
|
+
local_var_path = '/v3/sourceAccounts/{sourceAccountId}/transfers'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
|
1269
|
+
|
1270
|
+
# query parameters
|
1271
|
+
query_params = opts[:query_params] || {}
|
1272
|
+
|
1273
|
+
# header parameters
|
1274
|
+
header_params = opts[:header_params] || {}
|
1275
|
+
# HTTP header 'Accept' (if needed)
|
1276
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1277
|
+
# HTTP header 'Content-Type'
|
1278
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1279
|
+
|
1280
|
+
# form parameters
|
1281
|
+
form_params = opts[:form_params] || {}
|
1282
|
+
|
1283
|
+
# http body (model)
|
1284
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_request2)
|
1285
|
+
|
1286
|
+
# return_type
|
1287
|
+
return_type = opts[:debug_return_type]
|
1288
|
+
|
1289
|
+
# auth_names
|
1290
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
1291
|
+
|
1292
|
+
new_options = opts.merge(
|
1293
|
+
:operation => :"FundingManagerApi.transfer_funds_v3",
|
1294
|
+
:header_params => header_params,
|
1295
|
+
:query_params => query_params,
|
1296
|
+
:form_params => form_params,
|
1297
|
+
:body => post_body,
|
1298
|
+
:auth_names => auth_names,
|
1299
|
+
:return_type => return_type
|
1300
|
+
)
|
1301
|
+
|
1302
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1303
|
+
if @api_client.config.debugging
|
1304
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#transfer_funds_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1305
|
+
end
|
1306
|
+
return data, status_code, headers
|
1307
|
+
end
|
850
1308
|
end
|
851
1309
|
end
|