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,17 +3,17 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'cgi'
|
14
14
|
|
15
15
|
module VeloPayments
|
16
|
-
class
|
16
|
+
class FundingManagerPrivateApi
|
17
17
|
attr_accessor :api_client
|
18
18
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
@@ -22,24 +22,24 @@ module VeloPayments
|
|
22
22
|
# Create Funding Account
|
23
23
|
# Create Funding Account
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [
|
25
|
+
# @option opts [CreateFundingAccountRequestV2] :create_funding_account_request_v2
|
26
26
|
# @return [nil]
|
27
|
-
def
|
28
|
-
|
27
|
+
def create_funding_account_v2(opts = {})
|
28
|
+
create_funding_account_v2_with_http_info(opts)
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Funding Account
|
33
33
|
# Create Funding Account
|
34
34
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @option opts [
|
35
|
+
# @option opts [CreateFundingAccountRequestV2] :create_funding_account_request_v2
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
-
def
|
37
|
+
def create_funding_account_v2_with_http_info(opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API:
|
39
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerPrivateApi.create_funding_account_v2 ...'
|
40
40
|
end
|
41
41
|
# resource path
|
42
|
-
local_var_path = '/
|
42
|
+
local_var_path = '/v2/fundingAccounts'
|
43
43
|
|
44
44
|
# query parameters
|
45
45
|
query_params = opts[:query_params] || {}
|
@@ -55,15 +55,16 @@ module VeloPayments
|
|
55
55
|
form_params = opts[:form_params] || {}
|
56
56
|
|
57
57
|
# http body (model)
|
58
|
-
post_body = opts[:
|
58
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_funding_account_request_v2'])
|
59
59
|
|
60
60
|
# return_type
|
61
|
-
return_type = opts[:
|
61
|
+
return_type = opts[:debug_return_type]
|
62
62
|
|
63
63
|
# auth_names
|
64
|
-
auth_names = opts[:
|
64
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
65
65
|
|
66
66
|
new_options = opts.merge(
|
67
|
+
:operation => :"FundingManagerPrivateApi.create_funding_account_v2",
|
67
68
|
:header_params => header_params,
|
68
69
|
:query_params => query_params,
|
69
70
|
:form_params => form_params,
|
@@ -74,7 +75,7 @@ module VeloPayments
|
|
74
75
|
|
75
76
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
77
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called:
|
78
|
+
@api_client.config.logger.debug "API called: FundingManagerPrivateApi#create_funding_account_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
79
|
end
|
79
80
|
return data, status_code, headers
|
80
81
|
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
|
|
@@ -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]
|
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 => :"LoginApi.logout",
|
63
64
|
:header_params => header_params,
|
64
65
|
:query_params => query_params,
|
65
66
|
:form_params => form_params,
|
@@ -115,15 +116,16 @@ module VeloPayments
|
|
115
116
|
form_params = opts[:form_params] || {}
|
116
117
|
|
117
118
|
# http body (model)
|
118
|
-
post_body = opts[:
|
119
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(reset_password_request)
|
119
120
|
|
120
121
|
# return_type
|
121
|
-
return_type = opts[:
|
122
|
+
return_type = opts[:debug_return_type]
|
122
123
|
|
123
124
|
# auth_names
|
124
|
-
auth_names = opts[:
|
125
|
+
auth_names = opts[:debug_auth_names] || []
|
125
126
|
|
126
127
|
new_options = opts.merge(
|
128
|
+
:operation => :"LoginApi.reset_password",
|
127
129
|
:header_params => header_params,
|
128
130
|
:query_params => query_params,
|
129
131
|
:form_params => form_params,
|
@@ -143,6 +145,7 @@ module VeloPayments
|
|
143
145
|
# <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
|
144
146
|
# @param access_token_validation_request [AccessTokenValidationRequest] An OTP from the user's registered MFA Device
|
145
147
|
# @param [Hash] opts the optional parameters
|
148
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
146
149
|
# @return [AccessTokenResponse]
|
147
150
|
def validate_access_token(access_token_validation_request, opts = {})
|
148
151
|
data, _status_code, _headers = validate_access_token_with_http_info(access_token_validation_request, opts)
|
@@ -153,6 +156,7 @@ module VeloPayments
|
|
153
156
|
# <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
|
154
157
|
# @param access_token_validation_request [AccessTokenValidationRequest] An OTP from the user's registered MFA Device
|
155
158
|
# @param [Hash] opts the optional parameters
|
159
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
156
160
|
# @return [Array<(AccessTokenResponse, Integer, Hash)>] AccessTokenResponse data, response status code and response headers
|
157
161
|
def validate_access_token_with_http_info(access_token_validation_request, opts = {})
|
158
162
|
if @api_client.config.debugging
|
@@ -174,20 +178,22 @@ module VeloPayments
|
|
174
178
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
175
179
|
# HTTP header 'Content-Type'
|
176
180
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
181
|
+
header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
|
177
182
|
|
178
183
|
# form parameters
|
179
184
|
form_params = opts[:form_params] || {}
|
180
185
|
|
181
186
|
# http body (model)
|
182
|
-
post_body = opts[:
|
187
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(access_token_validation_request)
|
183
188
|
|
184
189
|
# return_type
|
185
|
-
return_type = opts[:
|
190
|
+
return_type = opts[:debug_return_type] || 'AccessTokenResponse'
|
186
191
|
|
187
192
|
# auth_names
|
188
|
-
auth_names = opts[:
|
193
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
189
194
|
|
190
195
|
new_options = opts.merge(
|
196
|
+
:operation => :"LoginApi.validate_access_token",
|
191
197
|
:header_params => header_params,
|
192
198
|
:query_params => query_params,
|
193
199
|
:form_params => form_params,
|
@@ -238,15 +244,16 @@ module VeloPayments
|
|
238
244
|
form_params = opts[:form_params] || {}
|
239
245
|
|
240
246
|
# http body (model)
|
241
|
-
post_body = opts[:
|
247
|
+
post_body = opts[:debug_body]
|
242
248
|
|
243
249
|
# return_type
|
244
|
-
return_type = opts[:
|
250
|
+
return_type = opts[:debug_return_type] || 'AuthResponse'
|
245
251
|
|
246
252
|
# auth_names
|
247
|
-
auth_names = opts[:
|
253
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
248
254
|
|
249
255
|
new_options = opts.merge(
|
256
|
+
:operation => :"LoginApi.velo_auth",
|
250
257
|
:header_params => header_params,
|
251
258
|
:query_params => query_params,
|
252
259
|
:form_params => form_params,
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,27 +20,27 @@ module VeloPayments
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Payee Invitation Status
|
23
|
-
# Returns a list of payees associated with a payor, along with invitation status and grace period end date
|
23
|
+
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
24
24
|
# @param payor_id [String] The account owner Payor ID
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [InvitationStatusResponse]
|
27
|
-
def
|
28
|
-
data, _status_code, _headers =
|
27
|
+
def get_payees_invitation_status_v1(payor_id, opts = {})
|
28
|
+
data, _status_code, _headers = get_payees_invitation_status_v1_with_http_info(payor_id, opts)
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
32
|
# Get Payee Invitation Status
|
33
|
-
# Returns a list of payees associated with a payor, along with invitation status and grace period end date
|
33
|
+
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
34
34
|
# @param payor_id [String] The account owner Payor ID
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(InvitationStatusResponse, Integer, Hash)>] InvitationStatusResponse data, response status code and response headers
|
37
|
-
def
|
37
|
+
def get_payees_invitation_status_v1_with_http_info(payor_id, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
39
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v1 ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'payor_id' is set
|
42
42
|
if @api_client.config.client_side_validation && payor_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.
|
43
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v1"
|
44
44
|
end
|
45
45
|
# resource path
|
46
46
|
local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
@@ -57,15 +57,16 @@ module VeloPayments
|
|
57
57
|
form_params = opts[:form_params] || {}
|
58
58
|
|
59
59
|
# http body (model)
|
60
|
-
post_body = opts[:
|
60
|
+
post_body = opts[:debug_body]
|
61
61
|
|
62
62
|
# return_type
|
63
|
-
return_type = opts[:
|
63
|
+
return_type = opts[:debug_return_type] || 'InvitationStatusResponse'
|
64
64
|
|
65
65
|
# auth_names
|
66
|
-
auth_names = opts[:
|
66
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
67
67
|
|
68
68
|
new_options = opts.merge(
|
69
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v1",
|
69
70
|
:header_params => header_params,
|
70
71
|
:query_params => query_params,
|
71
72
|
:form_params => form_params,
|
@@ -76,13 +77,13 @@ module VeloPayments
|
|
76
77
|
|
77
78
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
78
79
|
if @api_client.config.debugging
|
79
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
80
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
81
|
end
|
81
82
|
return data, status_code, headers
|
82
83
|
end
|
83
84
|
|
84
85
|
# Get Payee Invitation Status
|
85
|
-
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date
|
86
|
+
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
86
87
|
# @param payor_id [String] The account owner Payor ID
|
87
88
|
# @param [Hash] opts the optional parameters
|
88
89
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -96,7 +97,7 @@ module VeloPayments
|
|
96
97
|
end
|
97
98
|
|
98
99
|
# Get Payee Invitation Status
|
99
|
-
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date
|
100
|
+
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
100
101
|
# @param payor_id [String] The account owner Payor ID
|
101
102
|
# @param [Hash] opts the optional parameters
|
102
103
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -131,15 +132,16 @@ module VeloPayments
|
|
131
132
|
form_params = opts[:form_params] || {}
|
132
133
|
|
133
134
|
# http body (model)
|
134
|
-
post_body = opts[:
|
135
|
+
post_body = opts[:debug_body]
|
135
136
|
|
136
137
|
# return_type
|
137
|
-
return_type = opts[:
|
138
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeInvitationStatusResponse'
|
138
139
|
|
139
140
|
# auth_names
|
140
|
-
auth_names = opts[:
|
141
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
141
142
|
|
142
143
|
new_options = opts.merge(
|
144
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v2",
|
143
145
|
:header_params => header_params,
|
144
146
|
:query_params => query_params,
|
145
147
|
:form_params => form_params,
|
@@ -155,61 +157,66 @@ module VeloPayments
|
|
155
157
|
return data, status_code, headers
|
156
158
|
end
|
157
159
|
|
158
|
-
#
|
159
|
-
#
|
160
|
-
# @param
|
161
|
-
# @param invite_payee_request [InvitePayeeRequest]
|
160
|
+
# Get Payee Invitation Status
|
161
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
162
|
+
# @param payor_id [String] The account owner Payor ID
|
162
163
|
# @param [Hash] opts the optional parameters
|
163
|
-
# @
|
164
|
-
|
165
|
-
|
164
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
165
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
166
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
167
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
168
|
+
# @return [PagedPayeeInvitationStatusResponse2]
|
169
|
+
def get_payees_invitation_status_v3(payor_id, opts = {})
|
170
|
+
data, _status_code, _headers = get_payees_invitation_status_v3_with_http_info(payor_id, opts)
|
166
171
|
data
|
167
172
|
end
|
168
173
|
|
169
|
-
#
|
170
|
-
#
|
171
|
-
# @param
|
172
|
-
# @param invite_payee_request [InvitePayeeRequest]
|
174
|
+
# Get Payee Invitation Status
|
175
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
176
|
+
# @param payor_id [String] The account owner Payor ID
|
173
177
|
# @param [Hash] opts the optional parameters
|
174
|
-
# @
|
175
|
-
|
178
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
179
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
180
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
181
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
182
|
+
# @return [Array<(PagedPayeeInvitationStatusResponse2, Integer, Hash)>] PagedPayeeInvitationStatusResponse2 data, response status code and response headers
|
183
|
+
def get_payees_invitation_status_v3_with_http_info(payor_id, opts = {})
|
176
184
|
if @api_client.config.debugging
|
177
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
178
|
-
end
|
179
|
-
# verify the required parameter 'payee_id' is set
|
180
|
-
if @api_client.config.client_side_validation && payee_id.nil?
|
181
|
-
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite"
|
185
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v3 ...'
|
182
186
|
end
|
183
|
-
# verify the required parameter '
|
184
|
-
if @api_client.config.client_side_validation &&
|
185
|
-
fail ArgumentError, "Missing the required parameter '
|
187
|
+
# verify the required parameter 'payor_id' is set
|
188
|
+
if @api_client.config.client_side_validation && payor_id.nil?
|
189
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v3"
|
186
190
|
end
|
187
191
|
# resource path
|
188
|
-
local_var_path = '/
|
192
|
+
local_var_path = '/v3/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
189
193
|
|
190
194
|
# query parameters
|
191
195
|
query_params = opts[:query_params] || {}
|
196
|
+
query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
|
197
|
+
query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
|
198
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
199
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
192
200
|
|
193
201
|
# header parameters
|
194
202
|
header_params = opts[:header_params] || {}
|
195
203
|
# HTTP header 'Accept' (if needed)
|
196
204
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
197
|
-
# HTTP header 'Content-Type'
|
198
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
199
205
|
|
200
206
|
# form parameters
|
201
207
|
form_params = opts[:form_params] || {}
|
202
208
|
|
203
209
|
# http body (model)
|
204
|
-
post_body = opts[:
|
210
|
+
post_body = opts[:debug_body]
|
205
211
|
|
206
212
|
# return_type
|
207
|
-
return_type = opts[:
|
213
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeInvitationStatusResponse2'
|
208
214
|
|
209
215
|
# auth_names
|
210
|
-
auth_names = opts[:
|
216
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
211
217
|
|
212
218
|
new_options = opts.merge(
|
219
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v3",
|
213
220
|
:header_params => header_params,
|
214
221
|
:query_params => query_params,
|
215
222
|
:form_params => form_params,
|
@@ -218,62 +225,73 @@ module VeloPayments
|
|
218
225
|
:return_type => return_type
|
219
226
|
)
|
220
227
|
|
221
|
-
data, status_code, headers = @api_client.call_api(:
|
228
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
222
229
|
if @api_client.config.debugging
|
223
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
230
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
224
231
|
end
|
225
232
|
return data, status_code, headers
|
226
233
|
end
|
227
234
|
|
228
|
-
#
|
229
|
-
#
|
230
|
-
# @param
|
235
|
+
# Get Payee Invitation Status
|
236
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
237
|
+
# @param payor_id [String] The account owner Payor ID
|
231
238
|
# @param [Hash] opts the optional parameters
|
232
|
-
# @
|
233
|
-
|
234
|
-
|
239
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
240
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
241
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
242
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
243
|
+
# @return [PagedPayeeInvitationStatusResponse2]
|
244
|
+
def get_payees_invitation_status_v4(payor_id, opts = {})
|
245
|
+
data, _status_code, _headers = get_payees_invitation_status_v4_with_http_info(payor_id, opts)
|
235
246
|
data
|
236
247
|
end
|
237
248
|
|
238
|
-
#
|
239
|
-
#
|
240
|
-
# @param
|
249
|
+
# Get Payee Invitation Status
|
250
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
251
|
+
# @param payor_id [String] The account owner Payor ID
|
241
252
|
# @param [Hash] opts the optional parameters
|
242
|
-
# @
|
243
|
-
|
253
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
254
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
255
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
256
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
257
|
+
# @return [Array<(PagedPayeeInvitationStatusResponse2, Integer, Hash)>] PagedPayeeInvitationStatusResponse2 data, response status code and response headers
|
258
|
+
def get_payees_invitation_status_v4_with_http_info(payor_id, opts = {})
|
244
259
|
if @api_client.config.debugging
|
245
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
260
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v4 ...'
|
246
261
|
end
|
247
|
-
# verify the required parameter '
|
248
|
-
if @api_client.config.client_side_validation &&
|
249
|
-
fail ArgumentError, "Missing the required parameter '
|
262
|
+
# verify the required parameter 'payor_id' is set
|
263
|
+
if @api_client.config.client_side_validation && payor_id.nil?
|
264
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v4"
|
250
265
|
end
|
251
266
|
# resource path
|
252
|
-
local_var_path = '/
|
267
|
+
local_var_path = '/v4/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
253
268
|
|
254
269
|
# query parameters
|
255
270
|
query_params = opts[:query_params] || {}
|
271
|
+
query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
|
272
|
+
query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
|
273
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
274
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
256
275
|
|
257
276
|
# header parameters
|
258
277
|
header_params = opts[:header_params] || {}
|
259
278
|
# HTTP header 'Accept' (if needed)
|
260
279
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
261
|
-
# HTTP header 'Content-Type'
|
262
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
263
280
|
|
264
281
|
# form parameters
|
265
282
|
form_params = opts[:form_params] || {}
|
266
283
|
|
267
284
|
# http body (model)
|
268
|
-
post_body = opts[:
|
285
|
+
post_body = opts[:debug_body]
|
269
286
|
|
270
287
|
# return_type
|
271
|
-
return_type = opts[:
|
288
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeInvitationStatusResponse2'
|
272
289
|
|
273
290
|
# auth_names
|
274
|
-
auth_names = opts[:
|
291
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
275
292
|
|
276
293
|
new_options = opts.merge(
|
294
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v4",
|
277
295
|
:header_params => header_params,
|
278
296
|
:query_params => query_params,
|
279
297
|
:form_params => form_params,
|
@@ -282,35 +300,35 @@ module VeloPayments
|
|
282
300
|
:return_type => return_type
|
283
301
|
)
|
284
302
|
|
285
|
-
data, status_code, headers = @api_client.call_api(:
|
303
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
286
304
|
if @api_client.config.debugging
|
287
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
305
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
288
306
|
end
|
289
307
|
return data, status_code, headers
|
290
308
|
end
|
291
309
|
|
292
310
|
# Query Batch Status
|
293
|
-
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found )
|
311
|
+
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
|
294
312
|
# @param batch_id [String] Batch Id
|
295
313
|
# @param [Hash] opts the optional parameters
|
296
314
|
# @return [QueryBatchResponse]
|
297
|
-
def
|
298
|
-
data, _status_code, _headers =
|
315
|
+
def query_batch_status_v2(batch_id, opts = {})
|
316
|
+
data, _status_code, _headers = query_batch_status_v2_with_http_info(batch_id, opts)
|
299
317
|
data
|
300
318
|
end
|
301
319
|
|
302
320
|
# Query Batch Status
|
303
|
-
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found )
|
321
|
+
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
|
304
322
|
# @param batch_id [String] Batch Id
|
305
323
|
# @param [Hash] opts the optional parameters
|
306
324
|
# @return [Array<(QueryBatchResponse, Integer, Hash)>] QueryBatchResponse data, response status code and response headers
|
307
|
-
def
|
325
|
+
def query_batch_status_v2_with_http_info(batch_id, opts = {})
|
308
326
|
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
327
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v2 ...'
|
310
328
|
end
|
311
329
|
# verify the required parameter 'batch_id' is set
|
312
330
|
if @api_client.config.client_side_validation && batch_id.nil?
|
313
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.
|
331
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v2"
|
314
332
|
end
|
315
333
|
# resource path
|
316
334
|
local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
@@ -327,15 +345,16 @@ module VeloPayments
|
|
327
345
|
form_params = opts[:form_params] || {}
|
328
346
|
|
329
347
|
# http body (model)
|
330
|
-
post_body = opts[:
|
348
|
+
post_body = opts[:debug_body]
|
331
349
|
|
332
350
|
# return_type
|
333
|
-
return_type = opts[:
|
351
|
+
return_type = opts[:debug_return_type] || 'QueryBatchResponse'
|
334
352
|
|
335
353
|
# auth_names
|
336
|
-
auth_names = opts[:
|
354
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
337
355
|
|
338
356
|
new_options = opts.merge(
|
357
|
+
:operation => :"PayeeInvitationApi.query_batch_status_v2",
|
339
358
|
:header_params => header_params,
|
340
359
|
:query_params => query_params,
|
341
360
|
:form_params => form_params,
|
@@ -346,36 +365,36 @@ module VeloPayments
|
|
346
365
|
|
347
366
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
348
367
|
if @api_client.config.debugging
|
349
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
368
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
350
369
|
end
|
351
370
|
return data, status_code, headers
|
352
371
|
end
|
353
372
|
|
354
|
-
#
|
355
|
-
#
|
356
|
-
# @param
|
373
|
+
# Query Batch Status
|
374
|
+
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
375
|
+
# @param batch_id [String] Batch Id
|
357
376
|
# @param [Hash] opts the optional parameters
|
358
|
-
# @return [
|
359
|
-
def
|
360
|
-
data, _status_code, _headers =
|
377
|
+
# @return [QueryBatchResponse2]
|
378
|
+
def query_batch_status_v3(batch_id, opts = {})
|
379
|
+
data, _status_code, _headers = query_batch_status_v3_with_http_info(batch_id, opts)
|
361
380
|
data
|
362
381
|
end
|
363
382
|
|
364
|
-
#
|
365
|
-
#
|
366
|
-
# @param
|
383
|
+
# Query Batch Status
|
384
|
+
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
385
|
+
# @param batch_id [String] Batch Id
|
367
386
|
# @param [Hash] opts the optional parameters
|
368
|
-
# @return [Array<(
|
369
|
-
def
|
387
|
+
# @return [Array<(QueryBatchResponse2, Integer, Hash)>] QueryBatchResponse2 data, response status code and response headers
|
388
|
+
def query_batch_status_v3_with_http_info(batch_id, opts = {})
|
370
389
|
if @api_client.config.debugging
|
371
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
390
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v3 ...'
|
372
391
|
end
|
373
|
-
# verify the required parameter '
|
374
|
-
if @api_client.config.client_side_validation &&
|
375
|
-
fail ArgumentError, "Missing the required parameter '
|
392
|
+
# verify the required parameter 'batch_id' is set
|
393
|
+
if @api_client.config.client_side_validation && batch_id.nil?
|
394
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v3"
|
376
395
|
end
|
377
396
|
# resource path
|
378
|
-
local_var_path = '/v3/payees'
|
397
|
+
local_var_path = '/v3/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
379
398
|
|
380
399
|
# query parameters
|
381
400
|
query_params = opts[:query_params] || {}
|
@@ -384,22 +403,21 @@ module VeloPayments
|
|
384
403
|
header_params = opts[:header_params] || {}
|
385
404
|
# HTTP header 'Accept' (if needed)
|
386
405
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
387
|
-
# HTTP header 'Content-Type'
|
388
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
389
406
|
|
390
407
|
# form parameters
|
391
408
|
form_params = opts[:form_params] || {}
|
392
409
|
|
393
410
|
# http body (model)
|
394
|
-
post_body = opts[:
|
411
|
+
post_body = opts[:debug_body]
|
395
412
|
|
396
413
|
# return_type
|
397
|
-
return_type = opts[:
|
414
|
+
return_type = opts[:debug_return_type] || 'QueryBatchResponse2'
|
398
415
|
|
399
416
|
# auth_names
|
400
|
-
auth_names = opts[:
|
417
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
401
418
|
|
402
419
|
new_options = opts.merge(
|
420
|
+
:operation => :"PayeeInvitationApi.query_batch_status_v3",
|
403
421
|
:header_params => header_params,
|
404
422
|
:query_params => query_params,
|
405
423
|
:form_params => form_params,
|
@@ -408,9 +426,9 @@ module VeloPayments
|
|
408
426
|
:return_type => return_type
|
409
427
|
)
|
410
428
|
|
411
|
-
data, status_code, headers = @api_client.call_api(:
|
429
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
412
430
|
if @api_client.config.debugging
|
413
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
431
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
414
432
|
end
|
415
433
|
return data, status_code, headers
|
416
434
|
end
|
@@ -419,9 +437,9 @@ module VeloPayments
|
|
419
437
|
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
420
438
|
# @param batch_id [String] Batch Id
|
421
439
|
# @param [Hash] opts the optional parameters
|
422
|
-
# @return [
|
423
|
-
def
|
424
|
-
data, _status_code, _headers =
|
440
|
+
# @return [QueryBatchResponse2]
|
441
|
+
def query_batch_status_v4(batch_id, opts = {})
|
442
|
+
data, _status_code, _headers = query_batch_status_v4_with_http_info(batch_id, opts)
|
425
443
|
data
|
426
444
|
end
|
427
445
|
|
@@ -429,17 +447,17 @@ module VeloPayments
|
|
429
447
|
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
430
448
|
# @param batch_id [String] Batch Id
|
431
449
|
# @param [Hash] opts the optional parameters
|
432
|
-
# @return [Array<(
|
433
|
-
def
|
450
|
+
# @return [Array<(QueryBatchResponse2, Integer, Hash)>] QueryBatchResponse2 data, response status code and response headers
|
451
|
+
def query_batch_status_v4_with_http_info(batch_id, opts = {})
|
434
452
|
if @api_client.config.debugging
|
435
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
453
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v4 ...'
|
436
454
|
end
|
437
455
|
# verify the required parameter 'batch_id' is set
|
438
456
|
if @api_client.config.client_side_validation && batch_id.nil?
|
439
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.
|
457
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v4"
|
440
458
|
end
|
441
459
|
# resource path
|
442
|
-
local_var_path = '/
|
460
|
+
local_var_path = '/v4/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
443
461
|
|
444
462
|
# query parameters
|
445
463
|
query_params = opts[:query_params] || {}
|
@@ -453,15 +471,16 @@ module VeloPayments
|
|
453
471
|
form_params = opts[:form_params] || {}
|
454
472
|
|
455
473
|
# http body (model)
|
456
|
-
post_body = opts[:
|
474
|
+
post_body = opts[:debug_body]
|
457
475
|
|
458
476
|
# return_type
|
459
|
-
return_type = opts[:
|
477
|
+
return_type = opts[:debug_return_type] || 'QueryBatchResponse2'
|
460
478
|
|
461
479
|
# auth_names
|
462
|
-
auth_names = opts[:
|
480
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
463
481
|
|
464
482
|
new_options = opts.merge(
|
483
|
+
:operation => :"PayeeInvitationApi.query_batch_status_v4",
|
465
484
|
:header_params => header_params,
|
466
485
|
:query_params => query_params,
|
467
486
|
:form_params => form_params,
|
@@ -472,7 +491,403 @@ module VeloPayments
|
|
472
491
|
|
473
492
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
474
493
|
if @api_client.config.debugging
|
475
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
494
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
495
|
+
end
|
496
|
+
return data, status_code, headers
|
497
|
+
end
|
498
|
+
|
499
|
+
# Resend Payee Invite
|
500
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
|
501
|
+
# @param payee_id [String] The UUID of the payee.
|
502
|
+
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @return [nil]
|
505
|
+
def resend_payee_invite_v1(payee_id, invite_payee_request, opts = {})
|
506
|
+
resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts)
|
507
|
+
nil
|
508
|
+
end
|
509
|
+
|
510
|
+
# Resend Payee Invite
|
511
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
|
512
|
+
# @param payee_id [String] The UUID of the payee.
|
513
|
+
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
514
|
+
# @param [Hash] opts the optional parameters
|
515
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
516
|
+
def resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts = {})
|
517
|
+
if @api_client.config.debugging
|
518
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v1 ...'
|
519
|
+
end
|
520
|
+
# verify the required parameter 'payee_id' is set
|
521
|
+
if @api_client.config.client_side_validation && payee_id.nil?
|
522
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v1"
|
523
|
+
end
|
524
|
+
# verify the required parameter 'invite_payee_request' is set
|
525
|
+
if @api_client.config.client_side_validation && invite_payee_request.nil?
|
526
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite_v1"
|
527
|
+
end
|
528
|
+
# resource path
|
529
|
+
local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
530
|
+
|
531
|
+
# query parameters
|
532
|
+
query_params = opts[:query_params] || {}
|
533
|
+
|
534
|
+
# header parameters
|
535
|
+
header_params = opts[:header_params] || {}
|
536
|
+
# HTTP header 'Accept' (if needed)
|
537
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
538
|
+
# HTTP header 'Content-Type'
|
539
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
540
|
+
|
541
|
+
# form parameters
|
542
|
+
form_params = opts[:form_params] || {}
|
543
|
+
|
544
|
+
# http body (model)
|
545
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_payee_request)
|
546
|
+
|
547
|
+
# return_type
|
548
|
+
return_type = opts[:debug_return_type]
|
549
|
+
|
550
|
+
# auth_names
|
551
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
552
|
+
|
553
|
+
new_options = opts.merge(
|
554
|
+
:operation => :"PayeeInvitationApi.resend_payee_invite_v1",
|
555
|
+
:header_params => header_params,
|
556
|
+
:query_params => query_params,
|
557
|
+
:form_params => form_params,
|
558
|
+
:body => post_body,
|
559
|
+
:auth_names => auth_names,
|
560
|
+
:return_type => return_type
|
561
|
+
)
|
562
|
+
|
563
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
564
|
+
if @api_client.config.debugging
|
565
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
566
|
+
end
|
567
|
+
return data, status_code, headers
|
568
|
+
end
|
569
|
+
|
570
|
+
# Resend Payee Invite
|
571
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
572
|
+
# @param payee_id [String] The UUID of the payee.
|
573
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
574
|
+
# @param [Hash] opts the optional parameters
|
575
|
+
# @return [nil]
|
576
|
+
def resend_payee_invite_v3(payee_id, invite_payee_request2, opts = {})
|
577
|
+
resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts)
|
578
|
+
nil
|
579
|
+
end
|
580
|
+
|
581
|
+
# Resend Payee Invite
|
582
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
583
|
+
# @param payee_id [String] The UUID of the payee.
|
584
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
585
|
+
# @param [Hash] opts the optional parameters
|
586
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
587
|
+
def resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts = {})
|
588
|
+
if @api_client.config.debugging
|
589
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v3 ...'
|
590
|
+
end
|
591
|
+
# verify the required parameter 'payee_id' is set
|
592
|
+
if @api_client.config.client_side_validation && payee_id.nil?
|
593
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
594
|
+
end
|
595
|
+
# verify the required parameter 'invite_payee_request2' is set
|
596
|
+
if @api_client.config.client_side_validation && invite_payee_request2.nil?
|
597
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
598
|
+
end
|
599
|
+
# resource path
|
600
|
+
local_var_path = '/v3/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
601
|
+
|
602
|
+
# query parameters
|
603
|
+
query_params = opts[:query_params] || {}
|
604
|
+
|
605
|
+
# header parameters
|
606
|
+
header_params = opts[:header_params] || {}
|
607
|
+
# HTTP header 'Accept' (if needed)
|
608
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
609
|
+
# HTTP header 'Content-Type'
|
610
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
611
|
+
|
612
|
+
# form parameters
|
613
|
+
form_params = opts[:form_params] || {}
|
614
|
+
|
615
|
+
# http body (model)
|
616
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_payee_request2)
|
617
|
+
|
618
|
+
# return_type
|
619
|
+
return_type = opts[:debug_return_type]
|
620
|
+
|
621
|
+
# auth_names
|
622
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
623
|
+
|
624
|
+
new_options = opts.merge(
|
625
|
+
:operation => :"PayeeInvitationApi.resend_payee_invite_v3",
|
626
|
+
:header_params => header_params,
|
627
|
+
:query_params => query_params,
|
628
|
+
:form_params => form_params,
|
629
|
+
:body => post_body,
|
630
|
+
:auth_names => auth_names,
|
631
|
+
:return_type => return_type
|
632
|
+
)
|
633
|
+
|
634
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
635
|
+
if @api_client.config.debugging
|
636
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
637
|
+
end
|
638
|
+
return data, status_code, headers
|
639
|
+
end
|
640
|
+
|
641
|
+
# Resend Payee Invite
|
642
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
643
|
+
# @param payee_id [String] The UUID of the payee.
|
644
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
645
|
+
# @param [Hash] opts the optional parameters
|
646
|
+
# @return [nil]
|
647
|
+
def resend_payee_invite_v4(payee_id, invite_payee_request2, opts = {})
|
648
|
+
resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2, opts)
|
649
|
+
nil
|
650
|
+
end
|
651
|
+
|
652
|
+
# Resend Payee Invite
|
653
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
654
|
+
# @param payee_id [String] The UUID of the payee.
|
655
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
656
|
+
# @param [Hash] opts the optional parameters
|
657
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
658
|
+
def resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2, opts = {})
|
659
|
+
if @api_client.config.debugging
|
660
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v4 ...'
|
661
|
+
end
|
662
|
+
# verify the required parameter 'payee_id' is set
|
663
|
+
if @api_client.config.client_side_validation && payee_id.nil?
|
664
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v4"
|
665
|
+
end
|
666
|
+
# verify the required parameter 'invite_payee_request2' is set
|
667
|
+
if @api_client.config.client_side_validation && invite_payee_request2.nil?
|
668
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.resend_payee_invite_v4"
|
669
|
+
end
|
670
|
+
# resource path
|
671
|
+
local_var_path = '/v4/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
672
|
+
|
673
|
+
# query parameters
|
674
|
+
query_params = opts[:query_params] || {}
|
675
|
+
|
676
|
+
# header parameters
|
677
|
+
header_params = opts[:header_params] || {}
|
678
|
+
# HTTP header 'Accept' (if needed)
|
679
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
680
|
+
# HTTP header 'Content-Type'
|
681
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
682
|
+
|
683
|
+
# form parameters
|
684
|
+
form_params = opts[:form_params] || {}
|
685
|
+
|
686
|
+
# http body (model)
|
687
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_payee_request2)
|
688
|
+
|
689
|
+
# return_type
|
690
|
+
return_type = opts[:debug_return_type]
|
691
|
+
|
692
|
+
# auth_names
|
693
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
694
|
+
|
695
|
+
new_options = opts.merge(
|
696
|
+
:operation => :"PayeeInvitationApi.resend_payee_invite_v4",
|
697
|
+
:header_params => header_params,
|
698
|
+
:query_params => query_params,
|
699
|
+
:form_params => form_params,
|
700
|
+
:body => post_body,
|
701
|
+
:auth_names => auth_names,
|
702
|
+
:return_type => return_type
|
703
|
+
)
|
704
|
+
|
705
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
706
|
+
if @api_client.config.debugging
|
707
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
708
|
+
end
|
709
|
+
return data, status_code, headers
|
710
|
+
end
|
711
|
+
|
712
|
+
# Initiate Payee Creation
|
713
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body
|
714
|
+
# @param [Hash] opts the optional parameters
|
715
|
+
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
716
|
+
# @return [CreatePayeesCSVResponse]
|
717
|
+
def v2_create_payee(opts = {})
|
718
|
+
data, _status_code, _headers = v2_create_payee_with_http_info(opts)
|
719
|
+
data
|
720
|
+
end
|
721
|
+
|
722
|
+
# Initiate Payee Creation
|
723
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body
|
724
|
+
# @param [Hash] opts the optional parameters
|
725
|
+
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
726
|
+
# @return [Array<(CreatePayeesCSVResponse, Integer, Hash)>] CreatePayeesCSVResponse data, response status code and response headers
|
727
|
+
def v2_create_payee_with_http_info(opts = {})
|
728
|
+
if @api_client.config.debugging
|
729
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v2_create_payee ...'
|
730
|
+
end
|
731
|
+
# resource path
|
732
|
+
local_var_path = '/v2/payees'
|
733
|
+
|
734
|
+
# query parameters
|
735
|
+
query_params = opts[:query_params] || {}
|
736
|
+
|
737
|
+
# header parameters
|
738
|
+
header_params = opts[:header_params] || {}
|
739
|
+
# HTTP header 'Accept' (if needed)
|
740
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
741
|
+
# HTTP header 'Content-Type'
|
742
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
743
|
+
|
744
|
+
# form parameters
|
745
|
+
form_params = opts[:form_params] || {}
|
746
|
+
|
747
|
+
# http body (model)
|
748
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_payees_request'])
|
749
|
+
|
750
|
+
# return_type
|
751
|
+
return_type = opts[:debug_return_type] || 'CreatePayeesCSVResponse'
|
752
|
+
|
753
|
+
# auth_names
|
754
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
755
|
+
|
756
|
+
new_options = opts.merge(
|
757
|
+
:operation => :"PayeeInvitationApi.v2_create_payee",
|
758
|
+
:header_params => header_params,
|
759
|
+
:query_params => query_params,
|
760
|
+
:form_params => form_params,
|
761
|
+
:body => post_body,
|
762
|
+
:auth_names => auth_names,
|
763
|
+
:return_type => return_type
|
764
|
+
)
|
765
|
+
|
766
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
767
|
+
if @api_client.config.debugging
|
768
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v2_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
769
|
+
end
|
770
|
+
return data, status_code, headers
|
771
|
+
end
|
772
|
+
|
773
|
+
# Initiate Payee Creation
|
774
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
775
|
+
# @param [Hash] opts the optional parameters
|
776
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
777
|
+
# @return [CreatePayeesCSVResponse2]
|
778
|
+
def v3_create_payee(opts = {})
|
779
|
+
data, _status_code, _headers = v3_create_payee_with_http_info(opts)
|
780
|
+
data
|
781
|
+
end
|
782
|
+
|
783
|
+
# Initiate Payee Creation
|
784
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
785
|
+
# @param [Hash] opts the optional parameters
|
786
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
787
|
+
# @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers
|
788
|
+
def v3_create_payee_with_http_info(opts = {})
|
789
|
+
if @api_client.config.debugging
|
790
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_create_payee ...'
|
791
|
+
end
|
792
|
+
# resource path
|
793
|
+
local_var_path = '/v3/payees'
|
794
|
+
|
795
|
+
# query parameters
|
796
|
+
query_params = opts[:query_params] || {}
|
797
|
+
|
798
|
+
# header parameters
|
799
|
+
header_params = opts[:header_params] || {}
|
800
|
+
# HTTP header 'Accept' (if needed)
|
801
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
802
|
+
# HTTP header 'Content-Type'
|
803
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
804
|
+
|
805
|
+
# form parameters
|
806
|
+
form_params = opts[:form_params] || {}
|
807
|
+
|
808
|
+
# http body (model)
|
809
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_payees_request2'])
|
810
|
+
|
811
|
+
# return_type
|
812
|
+
return_type = opts[:debug_return_type] || 'CreatePayeesCSVResponse2'
|
813
|
+
|
814
|
+
# auth_names
|
815
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
816
|
+
|
817
|
+
new_options = opts.merge(
|
818
|
+
:operation => :"PayeeInvitationApi.v3_create_payee",
|
819
|
+
:header_params => header_params,
|
820
|
+
:query_params => query_params,
|
821
|
+
:form_params => form_params,
|
822
|
+
:body => post_body,
|
823
|
+
:auth_names => auth_names,
|
824
|
+
:return_type => return_type
|
825
|
+
)
|
826
|
+
|
827
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
828
|
+
if @api_client.config.debugging
|
829
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v3_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
830
|
+
end
|
831
|
+
return data, status_code, headers
|
832
|
+
end
|
833
|
+
|
834
|
+
# Initiate Payee Creation
|
835
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
836
|
+
# @param [Hash] opts the optional parameters
|
837
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
838
|
+
# @return [CreatePayeesCSVResponse2]
|
839
|
+
def v4_create_payee(opts = {})
|
840
|
+
data, _status_code, _headers = v4_create_payee_with_http_info(opts)
|
841
|
+
data
|
842
|
+
end
|
843
|
+
|
844
|
+
# Initiate Payee Creation
|
845
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
846
|
+
# @param [Hash] opts the optional parameters
|
847
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
848
|
+
# @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers
|
849
|
+
def v4_create_payee_with_http_info(opts = {})
|
850
|
+
if @api_client.config.debugging
|
851
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v4_create_payee ...'
|
852
|
+
end
|
853
|
+
# resource path
|
854
|
+
local_var_path = '/v4/payees'
|
855
|
+
|
856
|
+
# query parameters
|
857
|
+
query_params = opts[:query_params] || {}
|
858
|
+
|
859
|
+
# header parameters
|
860
|
+
header_params = opts[:header_params] || {}
|
861
|
+
# HTTP header 'Accept' (if needed)
|
862
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
863
|
+
# HTTP header 'Content-Type'
|
864
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
865
|
+
|
866
|
+
# form parameters
|
867
|
+
form_params = opts[:form_params] || {}
|
868
|
+
|
869
|
+
# http body (model)
|
870
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_payees_request2'])
|
871
|
+
|
872
|
+
# return_type
|
873
|
+
return_type = opts[:debug_return_type] || 'CreatePayeesCSVResponse2'
|
874
|
+
|
875
|
+
# auth_names
|
876
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
877
|
+
|
878
|
+
new_options = opts.merge(
|
879
|
+
:operation => :"PayeeInvitationApi.v4_create_payee",
|
880
|
+
:header_params => header_params,
|
881
|
+
:query_params => query_params,
|
882
|
+
:form_params => form_params,
|
883
|
+
:body => post_body,
|
884
|
+
:auth_names => auth_names,
|
885
|
+
:return_type => return_type
|
886
|
+
)
|
887
|
+
|
888
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
889
|
+
if @api_client.config.debugging
|
890
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v4_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
476
891
|
end
|
477
892
|
return data, status_code, headers
|
478
893
|
end
|