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
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'VeloPayments'
|
|
15
15
|
|
|
16
|
-
instance = VeloPayments::PayeeInvitationStatus.new(payee_id:
|
|
16
|
+
instance = VeloPayments::PayeeInvitationStatus.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
|
17
17
|
invitation_status: ACCEPTED,
|
|
18
18
|
grace_period_end_date: Sun Feb 03 00:00:00 GMT 2019)
|
|
19
19
|
```
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**payee_id** | **String** | |
|
|
8
|
-
**invitation_status** |
|
|
8
|
+
**invitation_status** | **String** | |
|
|
9
9
|
**grace_period_end_date** | **Date** | | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'VeloPayments'
|
|
15
15
|
|
|
16
|
-
instance = VeloPayments::PayeeInvitationStatusResponse.new(payee_id:
|
|
16
|
+
instance = VeloPayments::PayeeInvitationStatusResponse.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
|
17
17
|
invitation_status: null,
|
|
18
|
-
grace_period_end_date:
|
|
18
|
+
grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# VeloPayments::PayeeInvitationStatusResponse2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payee_id** | **String** | |
|
|
8
|
+
**invitation_status** | **String** | |
|
|
9
|
+
**grace_period_end_date** | **Date** | | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'VeloPayments'
|
|
15
|
+
|
|
16
|
+
instance = VeloPayments::PayeeInvitationStatusResponse2.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
|
17
|
+
invitation_status: null,
|
|
18
|
+
grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/PayeePaymentChannel.md
CHANGED
|
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**payment_channel_name** | **String** | | [optional]
|
|
8
8
|
**iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional]
|
|
9
9
|
**account_number** | **String** | |
|
|
10
|
-
**
|
|
11
|
-
**country_code** | **String** |
|
|
10
|
+
**routing_number** | **String** | |
|
|
11
|
+
**country_code** | **String** | Country Code must be a valid 2 letter ISO 3166-1 country code. |
|
|
12
12
|
**currency** | **String** | |
|
|
13
13
|
**account_name** | **String** | |
|
|
14
14
|
|
|
@@ -17,13 +17,13 @@ Name | Type | Description | Notes
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'VeloPayments'
|
|
19
19
|
|
|
20
|
-
instance = VeloPayments::PayeePaymentChannel.new(payment_channel_name:
|
|
21
|
-
iban:
|
|
22
|
-
account_number:
|
|
23
|
-
|
|
24
|
-
country_code:
|
|
20
|
+
instance = VeloPayments::PayeePaymentChannel.new(payment_channel_name: My payment channel,
|
|
21
|
+
iban: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234,
|
|
22
|
+
account_number: XXXXXX5678,
|
|
23
|
+
routing_number: XXXXX6789,
|
|
24
|
+
country_code: UK,
|
|
25
25
|
currency: null,
|
|
26
|
-
account_name:
|
|
26
|
+
account_name: My account)
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# VeloPayments::PayeePaymentChannel2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payment_channel_name** | **String** | | [optional]
|
|
8
|
+
**iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional]
|
|
9
|
+
**account_number** | **String** | |
|
|
10
|
+
**routing_number** | **String** | |
|
|
11
|
+
**country_code** | **String** | Country Code must be a valid 2 letter ISO 3166-1 country code |
|
|
12
|
+
**currency** | **String** | |
|
|
13
|
+
**account_name** | **String** | |
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'VeloPayments'
|
|
19
|
+
|
|
20
|
+
instance = VeloPayments::PayeePaymentChannel2.new(payment_channel_name: null,
|
|
21
|
+
iban: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234,
|
|
22
|
+
account_number: XXXXXX5678,
|
|
23
|
+
routing_number: XXXXX6789,
|
|
24
|
+
country_code: US,
|
|
25
|
+
currency: null,
|
|
26
|
+
account_name: My account)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/PayeePayorRef.md
CHANGED
data/docs/PayeePayorRef2.md
CHANGED
|
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**payor_id** | **String** | | [optional]
|
|
8
8
|
**remote_id** | **String** | | [optional]
|
|
9
|
-
**invitation_status** | **
|
|
9
|
+
**invitation_status** | [**InvitationStatus2**](InvitationStatus2.md) | | [optional]
|
|
10
|
+
**invitation_status_timestamp** | **Time** | The timestamp when the invitation status is updated | [optional]
|
|
11
|
+
**payment_channel_id** | **String** | | [optional]
|
|
10
12
|
|
|
11
13
|
## Code Sample
|
|
12
14
|
|
|
@@ -15,7 +17,9 @@ require 'VeloPayments'
|
|
|
15
17
|
|
|
16
18
|
instance = VeloPayments::PayeePayorRef2.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
|
|
17
19
|
remote_id: uniqueIdForRemoteEntity,
|
|
18
|
-
invitation_status: null
|
|
20
|
+
invitation_status: null,
|
|
21
|
+
invitation_status_timestamp: 2019-01-20T09:00Z,
|
|
22
|
+
payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3)
|
|
19
23
|
```
|
|
20
24
|
|
|
21
25
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# VeloPayments::PayeePayorRefV2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payor_id** | **String** | | [optional]
|
|
8
|
+
**remote_id** | **String** | | [optional]
|
|
9
|
+
**invitation_status** | **String** | | [optional]
|
|
10
|
+
**invitation_status_timestamp** | **Time** | The timestamp when the invitation status is updated | [optional]
|
|
11
|
+
**payment_channel_id** | **String** | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'VeloPayments'
|
|
17
|
+
|
|
18
|
+
instance = VeloPayments::PayeePayorRefV2.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
|
|
19
|
+
remote_id: uniqueIdForRemoteEntity,
|
|
20
|
+
invitation_status: ACCEPTED,
|
|
21
|
+
invitation_status_timestamp: 2019-01-20T09:00Z,
|
|
22
|
+
payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# VeloPayments::PayeePayorRefV3
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payor_id** | **String** | | [optional]
|
|
8
|
+
**remote_id** | **String** | | [optional]
|
|
9
|
+
**invitation_status** | [**InvitationStatus2**](InvitationStatus2.md) | | [optional]
|
|
10
|
+
**invitation_status_timestamp** | **Time** | The timestamp when the invitation status is updated | [optional]
|
|
11
|
+
**payment_channel_id** | **String** | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'VeloPayments'
|
|
17
|
+
|
|
18
|
+
instance = VeloPayments::PayeePayorRefV3.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
|
|
19
|
+
remote_id: uniqueIdForRemoteEntity,
|
|
20
|
+
invitation_status: null,
|
|
21
|
+
invitation_status_timestamp: 2019-01-20T09:00Z,
|
|
22
|
+
payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
data/docs/PayeeResponse.md
CHANGED
|
@@ -13,12 +13,12 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**payment_channel** | [**PayeePaymentChannel**](PayeePaymentChannel.md) | | [optional]
|
|
14
14
|
**challenge** | [**Challenge**](Challenge.md) | | [optional]
|
|
15
15
|
**language** | [**Language**](Language.md) | | [optional]
|
|
16
|
-
**accept_terms_and_conditions_timestamp** | **
|
|
16
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
|
17
17
|
**cellphone_number** | **String** | | [optional]
|
|
18
18
|
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
|
19
19
|
**company** | [**CompanyResponse**](CompanyResponse.md) | | [optional]
|
|
20
20
|
**individual** | [**IndividualResponse**](IndividualResponse.md) | | [optional]
|
|
21
|
-
**created** | **
|
|
21
|
+
**created** | **Time** | | [optional]
|
|
22
22
|
**grace_period_end_date** | **Date** | | [optional] [readonly]
|
|
23
23
|
**last_ofac_check_timestamp** | **String** | | [optional] [readonly]
|
|
24
24
|
**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) | | [optional]
|
|
@@ -30,23 +30,23 @@ Name | Type | Description | Notes
|
|
|
30
30
|
```ruby
|
|
31
31
|
require 'VeloPayments'
|
|
32
32
|
|
|
33
|
-
instance = VeloPayments::PayeeResponse.new(payee_id:
|
|
33
|
+
instance = VeloPayments::PayeeResponse.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
|
34
34
|
payor_refs: null,
|
|
35
|
-
email:
|
|
35
|
+
email: bob@example.com,
|
|
36
36
|
address: null,
|
|
37
|
-
country:
|
|
38
|
-
display_name:
|
|
37
|
+
country: US,
|
|
38
|
+
display_name: ABC,
|
|
39
39
|
payment_channel: null,
|
|
40
40
|
challenge: null,
|
|
41
41
|
language: null,
|
|
42
|
-
accept_terms_and_conditions_timestamp:
|
|
43
|
-
cellphone_number:
|
|
42
|
+
accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
|
|
43
|
+
cellphone_number: 1234567890,
|
|
44
44
|
payee_type: null,
|
|
45
45
|
company: null,
|
|
46
46
|
individual: null,
|
|
47
|
-
created:
|
|
48
|
-
grace_period_end_date:
|
|
49
|
-
last_ofac_check_timestamp:
|
|
47
|
+
created: 2019-01-20T09:00Z,
|
|
48
|
+
grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
|
|
49
|
+
last_ofac_check_timestamp: 2019-01-20T09:00:00+00:00,
|
|
50
50
|
marketing_opt_ins: null,
|
|
51
51
|
ofac_status: null,
|
|
52
52
|
onboarded_status: null)
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# VeloPayments::PayeeResponseV2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**payee_id** | **String** | | [optional] [readonly]
|
|
8
|
+
**payor_refs** | [**Array<PayeePayorRefV2>**](PayeePayorRefV2.md) | | [optional] [readonly]
|
|
9
|
+
**email** | **String** | | [optional]
|
|
10
|
+
**onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
|
|
11
|
+
**ofac_status** | [**OfacStatus2**](OfacStatus2.md) | | [optional]
|
|
12
|
+
**language** | [**Language2**](Language2.md) | | [optional]
|
|
13
|
+
**created** | **Time** | | [optional]
|
|
14
|
+
**country** | **String** | | [optional]
|
|
15
|
+
**display_name** | **String** | | [optional]
|
|
16
|
+
**payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
|
|
17
|
+
**disabled** | **Boolean** | | [optional]
|
|
18
|
+
**disabled_comment** | **String** | | [optional]
|
|
19
|
+
**disabled_updated_timestamp** | **Time** | | [optional]
|
|
20
|
+
**address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
|
|
21
|
+
**individual** | [**Individual**](Individual.md) | | [optional]
|
|
22
|
+
**company** | [**Company**](Company.md) | | [optional]
|
|
23
|
+
**cellphone_number** | **String** | | [optional]
|
|
24
|
+
**last_ofac_check_timestamp** | **String** | | [optional] [readonly]
|
|
25
|
+
**ofac_override** | **Boolean** | | [optional]
|
|
26
|
+
**ofac_override_reason** | **String** | | [optional]
|
|
27
|
+
**ofac_override_timestamp** | **String** | | [optional]
|
|
28
|
+
**grace_period_end_date** | **Date** | | [optional] [readonly]
|
|
29
|
+
**enhanced_kyc_completed** | **Boolean** | | [optional]
|
|
30
|
+
**kyc_completed_timestamp** | **String** | | [optional]
|
|
31
|
+
**pause_payment** | **Boolean** | | [optional]
|
|
32
|
+
**pause_payment_timestamp** | **String** | | [optional]
|
|
33
|
+
**marketing_opt_in_decision** | **Boolean** | | [optional]
|
|
34
|
+
**marketing_opt_in_timestamp** | **String** | | [optional]
|
|
35
|
+
**accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
|
|
36
|
+
|
|
37
|
+
## Code Sample
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
require 'VeloPayments'
|
|
41
|
+
|
|
42
|
+
instance = VeloPayments::PayeeResponseV2.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
|
|
43
|
+
payor_refs: null,
|
|
44
|
+
email: bob@example.com,
|
|
45
|
+
onboarded_status: null,
|
|
46
|
+
ofac_status: null,
|
|
47
|
+
language: null,
|
|
48
|
+
created: 2019-01-20T09:00Z,
|
|
49
|
+
country: US,
|
|
50
|
+
display_name: Bob,
|
|
51
|
+
payee_type: null,
|
|
52
|
+
disabled: null,
|
|
53
|
+
disabled_comment: reason for disabled,
|
|
54
|
+
disabled_updated_timestamp: 2019-01-20T09:00Z,
|
|
55
|
+
address: null,
|
|
56
|
+
individual: null,
|
|
57
|
+
company: null,
|
|
58
|
+
cellphone_number: 1234567890,
|
|
59
|
+
last_ofac_check_timestamp: 2019-01-20T09:00:00+00:00,
|
|
60
|
+
ofac_override: null,
|
|
61
|
+
ofac_override_reason: ofac override reason,
|
|
62
|
+
ofac_override_timestamp: 2019-01-20T09:00:00+00:00,
|
|
63
|
+
grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
|
|
64
|
+
enhanced_kyc_completed: null,
|
|
65
|
+
kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
|
|
66
|
+
pause_payment: null,
|
|
67
|
+
pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
|
|
68
|
+
marketing_opt_in_decision: null,
|
|
69
|
+
marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
|
|
70
|
+
accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z)
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# VeloPayments::
|
|
1
|
+
# VeloPayments::PayeeType2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
```ruby
|
|
11
11
|
require 'VeloPayments'
|
|
12
12
|
|
|
13
|
-
instance = VeloPayments::
|
|
13
|
+
instance = VeloPayments::PayeeType2.new()
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# VeloPayments::PayeeUserSelfUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**primary_contact_number** | **String** | The main contact number for the user | [optional]
|
|
8
|
+
**secondary_contact_number** | **String** | The secondary contact number for the user | [optional]
|
|
9
|
+
**first_name** | **String** | | [optional]
|
|
10
|
+
**last_name** | **String** | | [optional]
|
|
11
|
+
**email** | **String** | the email address of the user | [optional]
|
|
12
|
+
**sms_number** | **String** | The phone number of a device that the user can receive sms messages on | [optional]
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'VeloPayments'
|
|
18
|
+
|
|
19
|
+
instance = VeloPayments::PayeeUserSelfUpdateRequest.new(primary_contact_number: 11235555555,
|
|
20
|
+
secondary_contact_number: 11235555550,
|
|
21
|
+
first_name: John,
|
|
22
|
+
last_name: Doe,
|
|
23
|
+
email: foo@example.com,
|
|
24
|
+
sms_number: 11235555555)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
data/docs/PayeesApi.md
CHANGED
|
@@ -4,22 +4,34 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
7
|
+
[**delete_payee_by_id_v1**](PayeesApi.md#delete_payee_by_id_v1) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
|
|
8
|
+
[**delete_payee_by_id_v3**](PayeesApi.md#delete_payee_by_id_v3) | **DELETE** /v3/payees/{payeeId} | Delete Payee by Id
|
|
9
|
+
[**delete_payee_by_id_v4**](PayeesApi.md#delete_payee_by_id_v4) | **DELETE** /v4/payees/{payeeId} | Delete Payee by Id
|
|
10
|
+
[**get_payee_by_id_v1**](PayeesApi.md#get_payee_by_id_v1) | **GET** /v1/payees/{payeeId} | Get Payee by Id
|
|
11
|
+
[**get_payee_by_id_v2**](PayeesApi.md#get_payee_by_id_v2) | **GET** /v2/payees/{payeeId} | Get Payee by Id
|
|
12
|
+
[**get_payee_by_id_v3**](PayeesApi.md#get_payee_by_id_v3) | **GET** /v3/payees/{payeeId} | Get Payee by Id
|
|
13
|
+
[**get_payee_by_id_v4**](PayeesApi.md#get_payee_by_id_v4) | **GET** /v4/payees/{payeeId} | Get Payee by Id
|
|
9
14
|
[**list_payee_changes**](PayeesApi.md#list_payee_changes) | **GET** /v1/deltas/payees | List Payee Changes
|
|
10
|
-
[**
|
|
15
|
+
[**list_payee_changes_v3**](PayeesApi.md#list_payee_changes_v3) | **GET** /v3/payees/deltas | List Payee Changes
|
|
16
|
+
[**list_payee_changes_v4**](PayeesApi.md#list_payee_changes_v4) | **GET** /v4/payees/deltas | List Payee Changes
|
|
17
|
+
[**list_payees_v1**](PayeesApi.md#list_payees_v1) | **GET** /v1/payees | List Payees V1
|
|
11
18
|
[**list_payees_v3**](PayeesApi.md#list_payees_v3) | **GET** /v3/payees | List Payees
|
|
19
|
+
[**list_payees_v4**](PayeesApi.md#list_payees_v4) | **GET** /v4/payees | List Payees
|
|
20
|
+
[**payee_details_update_v3**](PayeesApi.md#payee_details_update_v3) | **POST** /v3/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details
|
|
21
|
+
[**payee_details_update_v4**](PayeesApi.md#payee_details_update_v4) | **POST** /v4/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details
|
|
12
22
|
[**v1_payees_payee_id_remote_id_update_post**](PayeesApi.md#v1_payees_payee_id_remote_id_update_post) | **POST** /v1/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
|
|
23
|
+
[**v3_payees_payee_id_remote_id_update_post**](PayeesApi.md#v3_payees_payee_id_remote_id_update_post) | **POST** /v3/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
|
|
24
|
+
[**v4_payees_payee_id_remote_id_update_post**](PayeesApi.md#v4_payees_payee_id_remote_id_update_post) | **POST** /v4/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id
|
|
13
25
|
|
|
14
26
|
|
|
15
27
|
|
|
16
|
-
##
|
|
28
|
+
## delete_payee_by_id_v1
|
|
17
29
|
|
|
18
|
-
>
|
|
30
|
+
> delete_payee_by_id_v1(payee_id)
|
|
19
31
|
|
|
20
32
|
Delete Payee by Id
|
|
21
33
|
|
|
22
|
-
This API will delete Payee by Id (UUID). Deletion by ID is not allowed if
|
|
34
|
+
<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> <p>Please use V3 instead.</p>
|
|
23
35
|
|
|
24
36
|
### Example
|
|
25
37
|
|
|
@@ -33,13 +45,13 @@ VeloPayments.configure do |config|
|
|
|
33
45
|
end
|
|
34
46
|
|
|
35
47
|
api_instance = VeloPayments::PayeesApi.new
|
|
36
|
-
payee_id = '
|
|
48
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
37
49
|
|
|
38
50
|
begin
|
|
39
51
|
#Delete Payee by Id
|
|
40
|
-
api_instance.
|
|
52
|
+
api_instance.delete_payee_by_id_v1(payee_id)
|
|
41
53
|
rescue VeloPayments::ApiError => e
|
|
42
|
-
puts "Exception when calling PayeesApi->
|
|
54
|
+
puts "Exception when calling PayeesApi->delete_payee_by_id_v1: #{e}"
|
|
43
55
|
end
|
|
44
56
|
```
|
|
45
57
|
|
|
@@ -64,13 +76,459 @@ nil (empty response body)
|
|
|
64
76
|
- **Accept**: Not defined
|
|
65
77
|
|
|
66
78
|
|
|
67
|
-
##
|
|
79
|
+
## delete_payee_by_id_v3
|
|
68
80
|
|
|
69
|
-
>
|
|
81
|
+
> delete_payee_by_id_v3(payee_id)
|
|
82
|
+
|
|
83
|
+
Delete Payee by Id
|
|
84
|
+
|
|
85
|
+
<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```ruby
|
|
90
|
+
# load the gem
|
|
91
|
+
require 'velopayments'
|
|
92
|
+
# setup authorization
|
|
93
|
+
VeloPayments.configure do |config|
|
|
94
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
95
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
99
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
100
|
+
|
|
101
|
+
begin
|
|
102
|
+
#Delete Payee by Id
|
|
103
|
+
api_instance.delete_payee_by_id_v3(payee_id)
|
|
104
|
+
rescue VeloPayments::ApiError => e
|
|
105
|
+
puts "Exception when calling PayeesApi->delete_payee_by_id_v3: #{e}"
|
|
106
|
+
end
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Parameters
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
Name | Type | Description | Notes
|
|
113
|
+
------------- | ------------- | ------------- | -------------
|
|
114
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
115
|
+
|
|
116
|
+
### Return type
|
|
117
|
+
|
|
118
|
+
nil (empty response body)
|
|
119
|
+
|
|
120
|
+
### Authorization
|
|
121
|
+
|
|
122
|
+
[OAuth2](../README.md#OAuth2)
|
|
123
|
+
|
|
124
|
+
### HTTP request headers
|
|
125
|
+
|
|
126
|
+
- **Content-Type**: Not defined
|
|
127
|
+
- **Accept**: Not defined
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
## delete_payee_by_id_v4
|
|
131
|
+
|
|
132
|
+
> delete_payee_by_id_v4(payee_id)
|
|
133
|
+
|
|
134
|
+
Delete Payee by Id
|
|
135
|
+
|
|
136
|
+
<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
|
|
140
|
+
```ruby
|
|
141
|
+
# load the gem
|
|
142
|
+
require 'velopayments'
|
|
143
|
+
# setup authorization
|
|
144
|
+
VeloPayments.configure do |config|
|
|
145
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
146
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
150
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
151
|
+
|
|
152
|
+
begin
|
|
153
|
+
#Delete Payee by Id
|
|
154
|
+
api_instance.delete_payee_by_id_v4(payee_id)
|
|
155
|
+
rescue VeloPayments::ApiError => e
|
|
156
|
+
puts "Exception when calling PayeesApi->delete_payee_by_id_v4: #{e}"
|
|
157
|
+
end
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
Name | Type | Description | Notes
|
|
164
|
+
------------- | ------------- | ------------- | -------------
|
|
165
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
166
|
+
|
|
167
|
+
### Return type
|
|
168
|
+
|
|
169
|
+
nil (empty response body)
|
|
170
|
+
|
|
171
|
+
### Authorization
|
|
172
|
+
|
|
173
|
+
[OAuth2](../README.md#OAuth2)
|
|
174
|
+
|
|
175
|
+
### HTTP request headers
|
|
176
|
+
|
|
177
|
+
- **Content-Type**: Not defined
|
|
178
|
+
- **Accept**: Not defined
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
## get_payee_by_id_v1
|
|
182
|
+
|
|
183
|
+
> Payee get_payee_by_id_v1(payee_id, opts)
|
|
184
|
+
|
|
185
|
+
Get Payee by Id
|
|
186
|
+
|
|
187
|
+
<p>Get Payee by Id</p> <p>Please use V3 instead.</p>
|
|
188
|
+
|
|
189
|
+
### Example
|
|
190
|
+
|
|
191
|
+
```ruby
|
|
192
|
+
# load the gem
|
|
193
|
+
require 'velopayments'
|
|
194
|
+
# setup authorization
|
|
195
|
+
VeloPayments.configure do |config|
|
|
196
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
197
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
201
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
202
|
+
opts = {
|
|
203
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
begin
|
|
207
|
+
#Get Payee by Id
|
|
208
|
+
result = api_instance.get_payee_by_id_v1(payee_id, opts)
|
|
209
|
+
p result
|
|
210
|
+
rescue VeloPayments::ApiError => e
|
|
211
|
+
puts "Exception when calling PayeesApi->get_payee_by_id_v1: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
Name | Type | Description | Notes
|
|
219
|
+
------------- | ------------- | ------------- | -------------
|
|
220
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
221
|
+
**sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional]
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
[**Payee**](Payee.md)
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[OAuth2](../README.md#OAuth2)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
## get_payee_by_id_v2
|
|
238
|
+
|
|
239
|
+
> PayeeResponseV2 get_payee_by_id_v2(payee_id, opts)
|
|
70
240
|
|
|
71
241
|
Get Payee by Id
|
|
72
242
|
|
|
73
|
-
Get Payee by Id
|
|
243
|
+
<p>Get Payee by Id</p> <p>Please use V3 instead.</p>
|
|
244
|
+
|
|
245
|
+
### Example
|
|
246
|
+
|
|
247
|
+
```ruby
|
|
248
|
+
# load the gem
|
|
249
|
+
require 'velopayments'
|
|
250
|
+
# setup authorization
|
|
251
|
+
VeloPayments.configure do |config|
|
|
252
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
253
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
257
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
258
|
+
opts = {
|
|
259
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
begin
|
|
263
|
+
#Get Payee by Id
|
|
264
|
+
result = api_instance.get_payee_by_id_v2(payee_id, opts)
|
|
265
|
+
p result
|
|
266
|
+
rescue VeloPayments::ApiError => e
|
|
267
|
+
puts "Exception when calling PayeesApi->get_payee_by_id_v2: #{e}"
|
|
268
|
+
end
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
Name | Type | Description | Notes
|
|
275
|
+
------------- | ------------- | ------------- | -------------
|
|
276
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
277
|
+
**sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional]
|
|
278
|
+
|
|
279
|
+
### Return type
|
|
280
|
+
|
|
281
|
+
[**PayeeResponseV2**](PayeeResponseV2.md)
|
|
282
|
+
|
|
283
|
+
### Authorization
|
|
284
|
+
|
|
285
|
+
[OAuth2](../README.md#OAuth2)
|
|
286
|
+
|
|
287
|
+
### HTTP request headers
|
|
288
|
+
|
|
289
|
+
- **Content-Type**: Not defined
|
|
290
|
+
- **Accept**: application/json
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
## get_payee_by_id_v3
|
|
294
|
+
|
|
295
|
+
> PayeeDetailResponse get_payee_by_id_v3(payee_id, opts)
|
|
296
|
+
|
|
297
|
+
Get Payee by Id
|
|
298
|
+
|
|
299
|
+
Get Payee by Id
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
|
|
303
|
+
```ruby
|
|
304
|
+
# load the gem
|
|
305
|
+
require 'velopayments'
|
|
306
|
+
# setup authorization
|
|
307
|
+
VeloPayments.configure do |config|
|
|
308
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
309
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
313
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
314
|
+
opts = {
|
|
315
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
begin
|
|
319
|
+
#Get Payee by Id
|
|
320
|
+
result = api_instance.get_payee_by_id_v3(payee_id, opts)
|
|
321
|
+
p result
|
|
322
|
+
rescue VeloPayments::ApiError => e
|
|
323
|
+
puts "Exception when calling PayeesApi->get_payee_by_id_v3: #{e}"
|
|
324
|
+
end
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
### Parameters
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
Name | Type | Description | Notes
|
|
331
|
+
------------- | ------------- | ------------- | -------------
|
|
332
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
333
|
+
**sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional]
|
|
334
|
+
|
|
335
|
+
### Return type
|
|
336
|
+
|
|
337
|
+
[**PayeeDetailResponse**](PayeeDetailResponse.md)
|
|
338
|
+
|
|
339
|
+
### Authorization
|
|
340
|
+
|
|
341
|
+
[OAuth2](../README.md#OAuth2)
|
|
342
|
+
|
|
343
|
+
### HTTP request headers
|
|
344
|
+
|
|
345
|
+
- **Content-Type**: Not defined
|
|
346
|
+
- **Accept**: application/json
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
## get_payee_by_id_v4
|
|
350
|
+
|
|
351
|
+
> PayeeDetailResponse2 get_payee_by_id_v4(payee_id, opts)
|
|
352
|
+
|
|
353
|
+
Get Payee by Id
|
|
354
|
+
|
|
355
|
+
Get Payee by Id
|
|
356
|
+
|
|
357
|
+
### Example
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
# load the gem
|
|
361
|
+
require 'velopayments'
|
|
362
|
+
# setup authorization
|
|
363
|
+
VeloPayments.configure do |config|
|
|
364
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
365
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
369
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
370
|
+
opts = {
|
|
371
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
begin
|
|
375
|
+
#Get Payee by Id
|
|
376
|
+
result = api_instance.get_payee_by_id_v4(payee_id, opts)
|
|
377
|
+
p result
|
|
378
|
+
rescue VeloPayments::ApiError => e
|
|
379
|
+
puts "Exception when calling PayeesApi->get_payee_by_id_v4: #{e}"
|
|
380
|
+
end
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### Parameters
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
Name | Type | Description | Notes
|
|
387
|
+
------------- | ------------- | ------------- | -------------
|
|
388
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
389
|
+
**sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional]
|
|
390
|
+
|
|
391
|
+
### Return type
|
|
392
|
+
|
|
393
|
+
[**PayeeDetailResponse2**](PayeeDetailResponse2.md)
|
|
394
|
+
|
|
395
|
+
### Authorization
|
|
396
|
+
|
|
397
|
+
[OAuth2](../README.md#OAuth2)
|
|
398
|
+
|
|
399
|
+
### HTTP request headers
|
|
400
|
+
|
|
401
|
+
- **Content-Type**: Not defined
|
|
402
|
+
- **Accept**: application/json
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
## list_payee_changes
|
|
406
|
+
|
|
407
|
+
> PayeeDeltaResponse list_payee_changes(payor_id, updated_since, opts)
|
|
408
|
+
|
|
409
|
+
List Payee Changes
|
|
410
|
+
|
|
411
|
+
<p>Get a paginated response listing payee changes.</p> <p>Please use V3 instead.</p>
|
|
412
|
+
|
|
413
|
+
### Example
|
|
414
|
+
|
|
415
|
+
```ruby
|
|
416
|
+
# load the gem
|
|
417
|
+
require 'velopayments'
|
|
418
|
+
# setup authorization
|
|
419
|
+
VeloPayments.configure do |config|
|
|
420
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
421
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
425
|
+
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
|
426
|
+
updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
427
|
+
opts = {
|
|
428
|
+
page: 1, # Integer | Page number. Default is 1.
|
|
429
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
begin
|
|
433
|
+
#List Payee Changes
|
|
434
|
+
result = api_instance.list_payee_changes(payor_id, updated_since, opts)
|
|
435
|
+
p result
|
|
436
|
+
rescue VeloPayments::ApiError => e
|
|
437
|
+
puts "Exception when calling PayeesApi->list_payee_changes: #{e}"
|
|
438
|
+
end
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
### Parameters
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
Name | Type | Description | Notes
|
|
445
|
+
------------- | ------------- | ------------- | -------------
|
|
446
|
+
**payor_id** | [**String**](.md)| The Payor ID to find associated Payees |
|
|
447
|
+
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
|
448
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
449
|
+
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**PayeeDeltaResponse**](PayeeDeltaResponse.md)
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[OAuth2](../README.md#OAuth2)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: Not defined
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
## list_payee_changes_v3
|
|
466
|
+
|
|
467
|
+
> PayeeDeltaResponse2 list_payee_changes_v3(payor_id, updated_since, opts)
|
|
468
|
+
|
|
469
|
+
List Payee Changes
|
|
470
|
+
|
|
471
|
+
Get a paginated response listing payee changes.
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
|
|
475
|
+
```ruby
|
|
476
|
+
# load the gem
|
|
477
|
+
require 'velopayments'
|
|
478
|
+
# setup authorization
|
|
479
|
+
VeloPayments.configure do |config|
|
|
480
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
481
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
485
|
+
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
|
486
|
+
updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
487
|
+
opts = {
|
|
488
|
+
page: 1, # Integer | Page number. Default is 1.
|
|
489
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
begin
|
|
493
|
+
#List Payee Changes
|
|
494
|
+
result = api_instance.list_payee_changes_v3(payor_id, updated_since, opts)
|
|
495
|
+
p result
|
|
496
|
+
rescue VeloPayments::ApiError => e
|
|
497
|
+
puts "Exception when calling PayeesApi->list_payee_changes_v3: #{e}"
|
|
498
|
+
end
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
Name | Type | Description | Notes
|
|
505
|
+
------------- | ------------- | ------------- | -------------
|
|
506
|
+
**payor_id** | [**String**](.md)| The Payor ID to find associated Payees |
|
|
507
|
+
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
|
508
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
509
|
+
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
|
510
|
+
|
|
511
|
+
### Return type
|
|
512
|
+
|
|
513
|
+
[**PayeeDeltaResponse2**](PayeeDeltaResponse2.md)
|
|
514
|
+
|
|
515
|
+
### Authorization
|
|
516
|
+
|
|
517
|
+
[OAuth2](../README.md#OAuth2)
|
|
518
|
+
|
|
519
|
+
### HTTP request headers
|
|
520
|
+
|
|
521
|
+
- **Content-Type**: Not defined
|
|
522
|
+
- **Accept**: application/json
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
## list_payee_changes_v4
|
|
526
|
+
|
|
527
|
+
> PayeeDeltaResponse2 list_payee_changes_v4(payor_id, updated_since, opts)
|
|
528
|
+
|
|
529
|
+
List Payee Changes
|
|
530
|
+
|
|
531
|
+
Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - dbaName - displayName - email - onboardedStatus - payeeCountry - payeeId - remoteId
|
|
74
532
|
|
|
75
533
|
### Example
|
|
76
534
|
|
|
@@ -84,17 +542,19 @@ VeloPayments.configure do |config|
|
|
|
84
542
|
end
|
|
85
543
|
|
|
86
544
|
api_instance = VeloPayments::PayeesApi.new
|
|
87
|
-
|
|
545
|
+
payor_id = 'payor_id_example' # String | The Payor ID to find associated Payees
|
|
546
|
+
updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
88
547
|
opts = {
|
|
89
|
-
|
|
548
|
+
page: 1, # Integer | Page number. Default is 1.
|
|
549
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
|
90
550
|
}
|
|
91
551
|
|
|
92
552
|
begin
|
|
93
|
-
#
|
|
94
|
-
result = api_instance.
|
|
553
|
+
#List Payee Changes
|
|
554
|
+
result = api_instance.list_payee_changes_v4(payor_id, updated_since, opts)
|
|
95
555
|
p result
|
|
96
556
|
rescue VeloPayments::ApiError => e
|
|
97
|
-
puts "Exception when calling PayeesApi->
|
|
557
|
+
puts "Exception when calling PayeesApi->list_payee_changes_v4: #{e}"
|
|
98
558
|
end
|
|
99
559
|
```
|
|
100
560
|
|
|
@@ -103,12 +563,14 @@ end
|
|
|
103
563
|
|
|
104
564
|
Name | Type | Description | Notes
|
|
105
565
|
------------- | ------------- | ------------- | -------------
|
|
106
|
-
**
|
|
107
|
-
**
|
|
566
|
+
**payor_id** | [**String**](.md)| The Payor ID to find associated Payees |
|
|
567
|
+
**updated_since** | **Time**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
|
|
568
|
+
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
569
|
+
**page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
|
|
108
570
|
|
|
109
571
|
### Return type
|
|
110
572
|
|
|
111
|
-
[**
|
|
573
|
+
[**PayeeDeltaResponse2**](PayeeDeltaResponse2.md)
|
|
112
574
|
|
|
113
575
|
### Authorization
|
|
114
576
|
|
|
@@ -120,13 +582,13 @@ Name | Type | Description | Notes
|
|
|
120
582
|
- **Accept**: application/json
|
|
121
583
|
|
|
122
584
|
|
|
123
|
-
##
|
|
585
|
+
## list_payees_v1
|
|
124
586
|
|
|
125
|
-
>
|
|
587
|
+
> PagedPayeeResponse list_payees_v1(payor_id, opts)
|
|
126
588
|
|
|
127
|
-
List
|
|
589
|
+
List Payees V1
|
|
128
590
|
|
|
129
|
-
Get a paginated response listing
|
|
591
|
+
<p>Get a paginated response listing the payees for a payor.</p> <p>Please use V3 instead.</>
|
|
130
592
|
|
|
131
593
|
### Example
|
|
132
594
|
|
|
@@ -140,19 +602,26 @@ VeloPayments.configure do |config|
|
|
|
140
602
|
end
|
|
141
603
|
|
|
142
604
|
api_instance = VeloPayments::PayeesApi.new
|
|
143
|
-
payor_id = 'payor_id_example' # String | The Payor ID
|
|
144
|
-
updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
|
605
|
+
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
|
145
606
|
opts = {
|
|
607
|
+
ofac_status: VeloPayments::OfacStatus.new, # OfacStatus | The ofacStatus of the payees.
|
|
608
|
+
onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
|
609
|
+
email: 'bob@example.com', # String | Email address
|
|
610
|
+
display_name: 'Bob Smith', # String | The display name of the payees.
|
|
611
|
+
remote_id: 'remoteId123', # String | The remote id of the payees.
|
|
612
|
+
payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
|
613
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
|
146
614
|
page: 1, # Integer | Page number. Default is 1.
|
|
147
|
-
page_size:
|
|
615
|
+
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
|
616
|
+
sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
|
|
148
617
|
}
|
|
149
618
|
|
|
150
619
|
begin
|
|
151
|
-
#List
|
|
152
|
-
result = api_instance.
|
|
620
|
+
#List Payees V1
|
|
621
|
+
result = api_instance.list_payees_v1(payor_id, opts)
|
|
153
622
|
p result
|
|
154
623
|
rescue VeloPayments::ApiError => e
|
|
155
|
-
puts "Exception when calling PayeesApi->
|
|
624
|
+
puts "Exception when calling PayeesApi->list_payees_v1: #{e}"
|
|
156
625
|
end
|
|
157
626
|
```
|
|
158
627
|
|
|
@@ -161,14 +630,21 @@ end
|
|
|
161
630
|
|
|
162
631
|
Name | Type | Description | Notes
|
|
163
632
|
------------- | ------------- | ------------- | -------------
|
|
164
|
-
**payor_id** | [**String**](.md)| The Payor ID
|
|
165
|
-
**
|
|
633
|
+
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
|
634
|
+
**ofac_status** | [**OfacStatus**](.md)| The ofacStatus of the payees. | [optional]
|
|
635
|
+
**onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional]
|
|
636
|
+
**email** | [**String**](.md)| Email address | [optional]
|
|
637
|
+
**display_name** | **String**| The display name of the payees. | [optional]
|
|
638
|
+
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
639
|
+
**payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional]
|
|
640
|
+
**payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [optional]
|
|
166
641
|
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
167
|
-
**page_size** | **Integer**| Page size. Default is
|
|
642
|
+
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
|
643
|
+
**sort** | **String**| List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. | [optional] [default to 'displayName:asc']
|
|
168
644
|
|
|
169
645
|
### Return type
|
|
170
646
|
|
|
171
|
-
[**
|
|
647
|
+
[**PagedPayeeResponse**](PagedPayeeResponse.md)
|
|
172
648
|
|
|
173
649
|
### Authorization
|
|
174
650
|
|
|
@@ -180,9 +656,9 @@ Name | Type | Description | Notes
|
|
|
180
656
|
- **Accept**: application/json
|
|
181
657
|
|
|
182
658
|
|
|
183
|
-
##
|
|
659
|
+
## list_payees_v3
|
|
184
660
|
|
|
185
|
-
>
|
|
661
|
+
> PagedPayeeResponse2 list_payees_v3(payor_id, opts)
|
|
186
662
|
|
|
187
663
|
List Payees
|
|
188
664
|
|
|
@@ -202,13 +678,14 @@ end
|
|
|
202
678
|
api_instance = VeloPayments::PayeesApi.new
|
|
203
679
|
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
|
204
680
|
opts = {
|
|
205
|
-
|
|
681
|
+
watchlist_status: VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
|
|
682
|
+
disabled: true, # Boolean | Payee disabled
|
|
206
683
|
onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
|
207
|
-
email: '
|
|
208
|
-
display_name: '
|
|
209
|
-
remote_id: '
|
|
684
|
+
email: 'bob@example.com', # String | Email address
|
|
685
|
+
display_name: 'Bob Smith', # String | The display name of the payees.
|
|
686
|
+
remote_id: 'remoteId123', # String | The remote id of the payees.
|
|
210
687
|
payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
|
211
|
-
payee_country: '
|
|
688
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
|
212
689
|
page: 1, # Integer | Page number. Default is 1.
|
|
213
690
|
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
|
214
691
|
sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
|
|
@@ -216,10 +693,10 @@ opts = {
|
|
|
216
693
|
|
|
217
694
|
begin
|
|
218
695
|
#List Payees
|
|
219
|
-
result = api_instance.
|
|
696
|
+
result = api_instance.list_payees_v3(payor_id, opts)
|
|
220
697
|
p result
|
|
221
698
|
rescue VeloPayments::ApiError => e
|
|
222
|
-
puts "Exception when calling PayeesApi->
|
|
699
|
+
puts "Exception when calling PayeesApi->list_payees_v3: #{e}"
|
|
223
700
|
end
|
|
224
701
|
```
|
|
225
702
|
|
|
@@ -229,7 +706,8 @@ end
|
|
|
229
706
|
Name | Type | Description | Notes
|
|
230
707
|
------------- | ------------- | ------------- | -------------
|
|
231
708
|
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
|
232
|
-
**
|
|
709
|
+
**watchlist_status** | [**WatchlistStatus**](.md)| The watchlistStatus of the payees. | [optional]
|
|
710
|
+
**disabled** | **Boolean**| Payee disabled | [optional]
|
|
233
711
|
**onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional]
|
|
234
712
|
**email** | [**String**](.md)| Email address | [optional]
|
|
235
713
|
**display_name** | **String**| The display name of the payees. | [optional]
|
|
@@ -242,7 +720,7 @@ Name | Type | Description | Notes
|
|
|
242
720
|
|
|
243
721
|
### Return type
|
|
244
722
|
|
|
245
|
-
[**
|
|
723
|
+
[**PagedPayeeResponse2**](PagedPayeeResponse2.md)
|
|
246
724
|
|
|
247
725
|
### Authorization
|
|
248
726
|
|
|
@@ -254,9 +732,9 @@ Name | Type | Description | Notes
|
|
|
254
732
|
- **Accept**: application/json
|
|
255
733
|
|
|
256
734
|
|
|
257
|
-
##
|
|
735
|
+
## list_payees_v4
|
|
258
736
|
|
|
259
|
-
> PagedPayeeResponse2
|
|
737
|
+
> PagedPayeeResponse2 list_payees_v4(payor_id, opts)
|
|
260
738
|
|
|
261
739
|
List Payees
|
|
262
740
|
|
|
@@ -276,13 +754,15 @@ end
|
|
|
276
754
|
api_instance = VeloPayments::PayeesApi.new
|
|
277
755
|
payor_id = 'payor_id_example' # String | The account owner Payor ID
|
|
278
756
|
opts = {
|
|
279
|
-
|
|
757
|
+
watchlist_status: VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
|
|
758
|
+
disabled: true, # Boolean | Payee disabled
|
|
280
759
|
onboarded_status: VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
|
281
|
-
email: '
|
|
282
|
-
display_name: '
|
|
283
|
-
remote_id: '
|
|
760
|
+
email: 'bob@example.com', # String | Email address
|
|
761
|
+
display_name: 'Bob Smith', # String | The display name of the payees.
|
|
762
|
+
remote_id: 'remoteId123', # String | The remote id of the payees.
|
|
284
763
|
payee_type: VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
|
285
|
-
payee_country: '
|
|
764
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
|
765
|
+
ofac_status: VeloPayments::OfacStatus.new, # OfacStatus | The ofacStatus of the payees.
|
|
286
766
|
page: 1, # Integer | Page number. Default is 1.
|
|
287
767
|
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
|
288
768
|
sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
|
|
@@ -290,10 +770,10 @@ opts = {
|
|
|
290
770
|
|
|
291
771
|
begin
|
|
292
772
|
#List Payees
|
|
293
|
-
result = api_instance.
|
|
773
|
+
result = api_instance.list_payees_v4(payor_id, opts)
|
|
294
774
|
p result
|
|
295
775
|
rescue VeloPayments::ApiError => e
|
|
296
|
-
puts "Exception when calling PayeesApi->
|
|
776
|
+
puts "Exception when calling PayeesApi->list_payees_v4: #{e}"
|
|
297
777
|
end
|
|
298
778
|
```
|
|
299
779
|
|
|
@@ -303,13 +783,15 @@ end
|
|
|
303
783
|
Name | Type | Description | Notes
|
|
304
784
|
------------- | ------------- | ------------- | -------------
|
|
305
785
|
**payor_id** | [**String**](.md)| The account owner Payor ID |
|
|
306
|
-
**
|
|
786
|
+
**watchlist_status** | [**WatchlistStatus**](.md)| The watchlistStatus of the payees. | [optional]
|
|
787
|
+
**disabled** | **Boolean**| Payee disabled | [optional]
|
|
307
788
|
**onboarded_status** | [**OnboardedStatus**](.md)| The onboarded status of the payees. | [optional]
|
|
308
789
|
**email** | [**String**](.md)| Email address | [optional]
|
|
309
790
|
**display_name** | **String**| The display name of the payees. | [optional]
|
|
310
791
|
**remote_id** | **String**| The remote id of the payees. | [optional]
|
|
311
792
|
**payee_type** | [**PayeeType**](.md)| The onboarded status of the payees. | [optional]
|
|
312
793
|
**payee_country** | **String**| The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [optional]
|
|
794
|
+
**ofac_status** | [**OfacStatus**](.md)| The ofacStatus of the payees. | [optional]
|
|
313
795
|
**page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
|
|
314
796
|
**page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
|
|
315
797
|
**sort** | **String**| List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. | [optional] [default to 'displayName:asc']
|
|
@@ -328,13 +810,119 @@ Name | Type | Description | Notes
|
|
|
328
810
|
- **Accept**: application/json
|
|
329
811
|
|
|
330
812
|
|
|
813
|
+
## payee_details_update_v3
|
|
814
|
+
|
|
815
|
+
> payee_details_update_v3(payee_id, update_payee_details_request)
|
|
816
|
+
|
|
817
|
+
Update Payee Details
|
|
818
|
+
|
|
819
|
+
<p>Update payee details for the given Payee Id.<p>
|
|
820
|
+
|
|
821
|
+
### Example
|
|
822
|
+
|
|
823
|
+
```ruby
|
|
824
|
+
# load the gem
|
|
825
|
+
require 'velopayments'
|
|
826
|
+
# setup authorization
|
|
827
|
+
VeloPayments.configure do |config|
|
|
828
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
829
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
830
|
+
end
|
|
831
|
+
|
|
832
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
833
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
834
|
+
update_payee_details_request = VeloPayments::UpdatePayeeDetailsRequest.new # UpdatePayeeDetailsRequest | Request to update payee details
|
|
835
|
+
|
|
836
|
+
begin
|
|
837
|
+
#Update Payee Details
|
|
838
|
+
api_instance.payee_details_update_v3(payee_id, update_payee_details_request)
|
|
839
|
+
rescue VeloPayments::ApiError => e
|
|
840
|
+
puts "Exception when calling PayeesApi->payee_details_update_v3: #{e}"
|
|
841
|
+
end
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
Name | Type | Description | Notes
|
|
848
|
+
------------- | ------------- | ------------- | -------------
|
|
849
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
850
|
+
**update_payee_details_request** | [**UpdatePayeeDetailsRequest**](UpdatePayeeDetailsRequest.md)| Request to update payee details |
|
|
851
|
+
|
|
852
|
+
### Return type
|
|
853
|
+
|
|
854
|
+
nil (empty response body)
|
|
855
|
+
|
|
856
|
+
### Authorization
|
|
857
|
+
|
|
858
|
+
[OAuth2](../README.md#OAuth2)
|
|
859
|
+
|
|
860
|
+
### HTTP request headers
|
|
861
|
+
|
|
862
|
+
- **Content-Type**: application/json
|
|
863
|
+
- **Accept**: application/json
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
## payee_details_update_v4
|
|
867
|
+
|
|
868
|
+
> payee_details_update_v4(payee_id, update_payee_details_request2)
|
|
869
|
+
|
|
870
|
+
Update Payee Details
|
|
871
|
+
|
|
872
|
+
<p>Update payee details for the given Payee Id.<p>
|
|
873
|
+
|
|
874
|
+
### Example
|
|
875
|
+
|
|
876
|
+
```ruby
|
|
877
|
+
# load the gem
|
|
878
|
+
require 'velopayments'
|
|
879
|
+
# setup authorization
|
|
880
|
+
VeloPayments.configure do |config|
|
|
881
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
882
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
883
|
+
end
|
|
884
|
+
|
|
885
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
886
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
887
|
+
update_payee_details_request2 = VeloPayments::UpdatePayeeDetailsRequest2.new # UpdatePayeeDetailsRequest2 | Request to update payee details
|
|
888
|
+
|
|
889
|
+
begin
|
|
890
|
+
#Update Payee Details
|
|
891
|
+
api_instance.payee_details_update_v4(payee_id, update_payee_details_request2)
|
|
892
|
+
rescue VeloPayments::ApiError => e
|
|
893
|
+
puts "Exception when calling PayeesApi->payee_details_update_v4: #{e}"
|
|
894
|
+
end
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
### Parameters
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
Name | Type | Description | Notes
|
|
901
|
+
------------- | ------------- | ------------- | -------------
|
|
902
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
903
|
+
**update_payee_details_request2** | [**UpdatePayeeDetailsRequest2**](UpdatePayeeDetailsRequest2.md)| Request to update payee details |
|
|
904
|
+
|
|
905
|
+
### Return type
|
|
906
|
+
|
|
907
|
+
nil (empty response body)
|
|
908
|
+
|
|
909
|
+
### Authorization
|
|
910
|
+
|
|
911
|
+
[OAuth2](../README.md#OAuth2)
|
|
912
|
+
|
|
913
|
+
### HTTP request headers
|
|
914
|
+
|
|
915
|
+
- **Content-Type**: application/json
|
|
916
|
+
- **Accept**: application/json
|
|
917
|
+
|
|
918
|
+
|
|
331
919
|
## v1_payees_payee_id_remote_id_update_post
|
|
332
920
|
|
|
333
921
|
> v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
|
334
922
|
|
|
335
923
|
Update Payee Remote Id
|
|
336
924
|
|
|
337
|
-
Update the remote Id for the given Payee Id
|
|
925
|
+
<p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p>
|
|
338
926
|
|
|
339
927
|
### Example
|
|
340
928
|
|
|
@@ -348,8 +936,8 @@ VeloPayments.configure do |config|
|
|
|
348
936
|
end
|
|
349
937
|
|
|
350
938
|
api_instance = VeloPayments::PayeesApi.new
|
|
351
|
-
payee_id = '
|
|
352
|
-
update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id
|
|
939
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
940
|
+
update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v1
|
|
353
941
|
|
|
354
942
|
begin
|
|
355
943
|
#Update Payee Remote Id
|
|
@@ -365,7 +953,113 @@ end
|
|
|
365
953
|
Name | Type | Description | Notes
|
|
366
954
|
------------- | ------------- | ------------- | -------------
|
|
367
955
|
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
368
|
-
**update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id |
|
|
956
|
+
**update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v1 |
|
|
957
|
+
|
|
958
|
+
### Return type
|
|
959
|
+
|
|
960
|
+
nil (empty response body)
|
|
961
|
+
|
|
962
|
+
### Authorization
|
|
963
|
+
|
|
964
|
+
[OAuth2](../README.md#OAuth2)
|
|
965
|
+
|
|
966
|
+
### HTTP request headers
|
|
967
|
+
|
|
968
|
+
- **Content-Type**: application/json
|
|
969
|
+
- **Accept**: application/json
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
## v3_payees_payee_id_remote_id_update_post
|
|
973
|
+
|
|
974
|
+
> v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
|
975
|
+
|
|
976
|
+
Update Payee Remote Id
|
|
977
|
+
|
|
978
|
+
<p>Update the remote Id for the given Payee Id.</p>
|
|
979
|
+
|
|
980
|
+
### Example
|
|
981
|
+
|
|
982
|
+
```ruby
|
|
983
|
+
# load the gem
|
|
984
|
+
require 'velopayments'
|
|
985
|
+
# setup authorization
|
|
986
|
+
VeloPayments.configure do |config|
|
|
987
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
988
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
989
|
+
end
|
|
990
|
+
|
|
991
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
992
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
993
|
+
update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v3
|
|
994
|
+
|
|
995
|
+
begin
|
|
996
|
+
#Update Payee Remote Id
|
|
997
|
+
api_instance.v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
|
998
|
+
rescue VeloPayments::ApiError => e
|
|
999
|
+
puts "Exception when calling PayeesApi->v3_payees_payee_id_remote_id_update_post: #{e}"
|
|
1000
|
+
end
|
|
1001
|
+
```
|
|
1002
|
+
|
|
1003
|
+
### Parameters
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
Name | Type | Description | Notes
|
|
1007
|
+
------------- | ------------- | ------------- | -------------
|
|
1008
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
1009
|
+
**update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v3 |
|
|
1010
|
+
|
|
1011
|
+
### Return type
|
|
1012
|
+
|
|
1013
|
+
nil (empty response body)
|
|
1014
|
+
|
|
1015
|
+
### Authorization
|
|
1016
|
+
|
|
1017
|
+
[OAuth2](../README.md#OAuth2)
|
|
1018
|
+
|
|
1019
|
+
### HTTP request headers
|
|
1020
|
+
|
|
1021
|
+
- **Content-Type**: application/json
|
|
1022
|
+
- **Accept**: application/json
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
## v4_payees_payee_id_remote_id_update_post
|
|
1026
|
+
|
|
1027
|
+
> v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
|
1028
|
+
|
|
1029
|
+
Update Payee Remote Id
|
|
1030
|
+
|
|
1031
|
+
<p>Update the remote Id for the given Payee Id.</p>
|
|
1032
|
+
|
|
1033
|
+
### Example
|
|
1034
|
+
|
|
1035
|
+
```ruby
|
|
1036
|
+
# load the gem
|
|
1037
|
+
require 'velopayments'
|
|
1038
|
+
# setup authorization
|
|
1039
|
+
VeloPayments.configure do |config|
|
|
1040
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
1041
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1042
|
+
end
|
|
1043
|
+
|
|
1044
|
+
api_instance = VeloPayments::PayeesApi.new
|
|
1045
|
+
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
|
|
1046
|
+
update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new # UpdateRemoteIdRequest | Request to update payee remote id v4
|
|
1047
|
+
|
|
1048
|
+
begin
|
|
1049
|
+
#Update Payee Remote Id
|
|
1050
|
+
api_instance.v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request)
|
|
1051
|
+
rescue VeloPayments::ApiError => e
|
|
1052
|
+
puts "Exception when calling PayeesApi->v4_payees_payee_id_remote_id_update_post: #{e}"
|
|
1053
|
+
end
|
|
1054
|
+
```
|
|
1055
|
+
|
|
1056
|
+
### Parameters
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
Name | Type | Description | Notes
|
|
1060
|
+
------------- | ------------- | ------------- | -------------
|
|
1061
|
+
**payee_id** | [**String**](.md)| The UUID of the payee. |
|
|
1062
|
+
**update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md)| Request to update payee remote id v4 |
|
|
369
1063
|
|
|
370
1064
|
### Return type
|
|
371
1065
|
|