velopayments 2.26.124.beta1 → 2.35.58.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/Gemfile.lock +72 -0
- data/Makefile +8 -18
- data/README.md +125 -133
- data/credentials +1 -0
- data/docs/AcceptedPaymentV3.md +16 -14
- data/docs/AuthResponse.md +1 -1
- data/docs/{AutoTopUpConfig.md → AutoTopUpConfigV2.md} +2 -2
- data/docs/{AutoTopUpConfig2.md → AutoTopUpConfigV3.md} +2 -2
- data/docs/{Challenge.md → ChallengeV3.md} +2 -2
- data/docs/{Challenge2.md → ChallengeV4.md} +4 -4
- data/docs/{Company2.md → CompanyV3.md} +2 -2
- data/docs/{Company.md → CompanyV4.md} +2 -2
- data/docs/CreateFundingAccountRequestV2.md +4 -4
- data/docs/{CreateIndividual.md → CreateIndividualV3.md} +3 -3
- data/docs/{CreateIndividualName.md → CreateIndividualV3Name.md} +2 -2
- data/docs/{CreateIndividual2.md → CreateIndividualV4.md} +3 -3
- data/docs/{CreatePayeeAddress.md → CreatePayeeAddressV3.md} +2 -2
- data/docs/{PayeeAddress2.md → CreatePayeeAddressV4.md} +3 -3
- data/docs/{CreatePayee.md → CreatePayeeV3.md} +8 -8
- data/docs/CreatePayeeV4.md +34 -0
- data/docs/CreatePayeesCSVRequestV3.md +74 -0
- data/docs/CreatePayeesCSVRequestV4.md +74 -0
- data/docs/{CreatePayeesCSVResponse.md → CreatePayeesCSVResponseV3.md} +3 -3
- data/docs/{CreatePayeesCSVResponseRejectedCsvRows.md → CreatePayeesCSVResponseV3RejectedCsvRows.md} +2 -2
- data/docs/{CreatePayeesCSVResponse2.md → CreatePayeesCSVResponseV4.md} +3 -3
- data/docs/{CreatePayeesRequest2.md → CreatePayeesRequestV3.md} +3 -3
- data/docs/{CreatePayeesRequest.md → CreatePayeesRequestV4.md} +3 -3
- data/docs/{CreatePaymentChannel.md → CreatePaymentChannelV3.md} +6 -6
- data/docs/{CreatePaymentChannel2.md → CreatePaymentChannelV4.md} +6 -6
- data/docs/{FailedPayee.md → FailedPayeeV3.md} +8 -8
- data/docs/{FailedPayee2.md → FailedPayeeV4.md} +9 -9
- data/docs/{FailedSubmission.md → FailedSubmissionV3.md} +3 -3
- data/docs/{FailedSubmission2.md → FailedSubmissionV4.md} +3 -3
- data/docs/{FundingAccountResponse2.md → FundingAccountResponseV2.md} +4 -4
- data/docs/FundingApi.md +459 -0
- data/docs/FundingAudit.md +3 -3
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerPrivateApi.md +2 -2
- data/docs/FundingResponse.md +44 -0
- data/docs/FxSummary.md +6 -6
- data/docs/FxSummaryV3.md +4 -4
- data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md} +2 -2
- data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md} +2 -2
- data/docs/GetPayeeListResponseIndividualV3.md +18 -0
- data/docs/GetPayeeListResponseIndividualV4.md +18 -0
- data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md} +8 -8
- data/docs/{GetPayeeListResponse2.md → GetPayeeListResponseV4.md} +9 -9
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +5 -3
- data/docs/GetPayoutsResponse.md +2 -2
- data/docs/{Individual.md → IndividualV3.md} +3 -3
- data/docs/{IndividualName.md → IndividualV3Name.md} +2 -2
- data/docs/{Individual2.md → IndividualV4.md} +3 -3
- data/docs/InstructPayoutRequestV3.md +18 -0
- data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
- data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
- data/docs/InviteUserRequest.md +5 -3
- data/docs/ListFundingAccountsResponseV2.md +22 -0
- data/docs/{ListSourceAccountResponseLinks.md → ListFundingAccountsResponseV2Links.md} +2 -2
- data/docs/{ListSourceAccountResponsePage.md → ListFundingAccountsResponseV2Page.md} +2 -2
- data/docs/LoginApi.md +1 -1
- data/docs/{Name.md → NameV3.md} +2 -2
- data/docs/{Name2.md → NameV4.md} +2 -2
- data/docs/Notification.md +2 -2
- data/docs/NotificationSource.md +94 -0
- data/docs/{Notifications.md → NotificationsV2.md} +2 -2
- data/docs/{Notifications2.md → NotificationsV3.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponseV3.md +22 -0
- data/docs/{PagedPayeeInvitationStatusResponsePage.md → PagedPayeeInvitationStatusResponseV3Page.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponseV4.md +22 -0
- data/docs/PagedPayeeResponseV3.md +24 -0
- data/docs/{PagedPayeeResponseLinks.md → PagedPayeeResponseV3Links.md} +2 -2
- data/docs/{PagedPayeeResponsePage.md → PagedPayeeResponseV3Page.md} +2 -2
- data/docs/{PagedPayeeResponseSummary.md → PagedPayeeResponseV3Summary.md} +2 -2
- data/docs/PagedPayeeResponseV4.md +24 -0
- data/docs/PagedPaymentsResponseV3.md +2 -2
- data/docs/{PayableIssue.md → PayableIssueV3.md} +2 -2
- data/docs/{PayableIssue2.md → PayableIssueV4.md} +2 -2
- data/docs/{CreatePayeeAddress2.md → PayeeAddressV3.md} +3 -3
- data/docs/{PayeeAddress.md → PayeeAddressV4.md} +2 -2
- data/docs/PayeeDeltaResponseV3.md +22 -0
- data/docs/{PayeeDeltaResponseLinks.md → PayeeDeltaResponseV3Links.md} +2 -2
- data/docs/{PayeeDeltaResponsePage.md → PayeeDeltaResponseV3Page.md} +2 -2
- data/docs/PayeeDeltaResponseV4.md +22 -0
- data/docs/{PayeeDeltaResponse2Links.md → PayeeDeltaResponseV4Links.md} +2 -2
- data/docs/{PayeeDelta.md → PayeeDeltaV3.md} +3 -3
- data/docs/{PayeeDelta2.md → PayeeDeltaV4.md} +4 -4
- data/docs/{PayeeDetailResponse2.md → PayeeDetailResponseV3.md} +11 -11
- data/docs/{PayeeDetailResponse.md → PayeeDetailResponseV4.md} +10 -10
- data/docs/PayeeInvitationApi.md +127 -127
- data/docs/{PayeeInvitationStatusResponse.md → PayeeInvitationStatusResponseV3.md} +3 -3
- data/docs/{PayeeInvitationStatusResponse2.md → PayeeInvitationStatusResponseV4.md} +3 -3
- data/docs/PayeePayorRefV3.md +2 -2
- data/docs/{PayeePayorRef.md → PayeePayorRefV4.md} +4 -4
- data/docs/{PayoutStatus.md → PayeeTypeEnum.md} +2 -2
- data/docs/PayeesApi.md +91 -91
- data/docs/PaymentAuditServiceApi.md +44 -24
- data/docs/PaymentAuditServiceDeprecatedApi.md +18 -18
- data/docs/PaymentChannelRule.md +3 -1
- data/docs/PaymentDeltaResponse.md +2 -2
- data/docs/PaymentDeltaResponseV1.md +2 -2
- data/docs/PaymentEventResponse.md +12 -6
- data/docs/PaymentEventResponseV3.md +3 -3
- data/docs/PaymentInstructionV3.md +3 -3
- data/docs/PaymentResponseV3.md +6 -4
- data/docs/PaymentResponseV4.md +17 -7
- data/docs/PaymentV3.md +25 -21
- data/docs/PayorBrandingResponse.md +3 -3
- data/docs/PayorCreateApiKeyRequest.md +2 -2
- data/docs/PayorHierarchyApi.md +83 -0
- data/docs/PayorLinksResponseLinks.md +1 -1
- data/docs/PayorLinksResponsePayors.md +1 -1
- data/docs/PayorV1.md +2 -2
- data/docs/PayorV2.md +13 -5
- data/docs/PayorsApi.md +57 -133
- data/docs/PayoutSchedule.md +28 -0
- data/docs/PayoutScheduleV3.md +26 -0
- data/docs/PayoutSummaryAudit.md +5 -3
- data/docs/PayoutSummaryAuditV3.md +1 -1
- data/docs/PayoutSummaryResponseV3.md +12 -10
- data/docs/{PayoutServiceApi.md → PayoutsApi.md} +194 -48
- data/docs/PingResponse.md +20 -0
- data/docs/PostInstructFxInfo.md +24 -0
- data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md} +4 -4
- data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md} +4 -4
- data/docs/QuoteFxSummaryV3.md +15 -15
- data/docs/RejectedPaymentV3.md +16 -16
- data/docs/SchedulePayoutRequestV3.md +20 -0
- data/docs/SetNotificationsRequest2.md +18 -0
- data/docs/SourceAccountResponseV2.md +2 -2
- data/docs/SourceAccountResponseV3.md +4 -4
- data/docs/SourceAccountSummary.md +2 -2
- data/docs/SourceAccountSummaryV3.md +1 -1
- data/docs/SourceAccountV3.md +5 -5
- data/docs/SourceAccountsApi.md +603 -0
- data/docs/TokensApi.md +2 -2
- data/docs/{TransferRequest.md → TransferRequestV2.md} +2 -2
- data/docs/{TransferRequest2.md → TransferRequestV3.md} +3 -3
- data/docs/{UpdatePayeeDetailsRequest.md → UpdatePayeeDetailsRequestV3.md} +7 -7
- data/docs/UpdatePayeeDetailsRequestV4.md +32 -0
- data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
- data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
- data/docs/UserResponse.md +4 -0
- data/docs/UsersApi.md +24 -22
- data/docs/WebhooksApi.md +74 -6
- data/docs/WebhooksResponse.md +2 -2
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_api.rb +481 -0
- data/lib/velopayments/api/funding_manager_private_api.rb +6 -3
- data/lib/velopayments/api/login_api.rb +13 -7
- data/lib/velopayments/api/payee_invitation_api.rb +124 -112
- data/lib/velopayments/api/payees_api.rb +98 -86
- data/lib/velopayments/api/payment_audit_service_api.rb +62 -20
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +12 -12
- data/{spec/models/create_webhook_request_spec.rb → lib/velopayments/api/payor_hierarchy_api.rb} +67 -37
- data/lib/velopayments/api/payors_api.rb +57 -111
- data/lib/velopayments/api/payors_private_api.rb +6 -3
- data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +189 -43
- data/lib/velopayments/api/source_accounts_api.rb +632 -0
- data/lib/velopayments/api/tokens_api.rb +6 -3
- data/lib/velopayments/api/users_api.rb +48 -15
- data/lib/velopayments/api/webhooks_api.rb +71 -6
- data/lib/velopayments/api_client.rb +8 -6
- data/lib/velopayments/api_error.rb +3 -2
- data/lib/velopayments/configuration.rb +33 -13
- data/lib/velopayments/models/accepted_payment_v3.rb +193 -23
- data/lib/velopayments/models/access_token_response.rb +15 -19
- data/lib/velopayments/models/access_token_validation_request.rb +17 -19
- data/lib/velopayments/models/auth_response.rb +19 -19
- data/lib/velopayments/models/{auto_top_up_config.rb → auto_top_up_config_v2.rb} +20 -22
- data/lib/velopayments/models/{auto_top_up_config2.rb → auto_top_up_config_v3.rb} +20 -22
- data/lib/velopayments/models/category.rb +8 -5
- data/lib/velopayments/models/{challenge2.rb → challenge_v3.rb} +22 -22
- data/lib/velopayments/models/{challenge.rb → challenge_v4.rb} +24 -22
- data/lib/velopayments/models/{company.rb → company_v3.rb} +20 -22
- data/lib/velopayments/models/{company2.rb → company_v4.rb} +20 -22
- data/lib/velopayments/models/create_funding_account_request_v2.rb +55 -37
- data/lib/velopayments/models/{create_individual.rb → create_individual_v3.rb} +29 -25
- data/lib/velopayments/models/{individual_name.rb → create_individual_v3_name.rb} +34 -26
- data/lib/velopayments/models/{create_individual2.rb → create_individual_v4.rb} +29 -25
- data/lib/velopayments/models/{create_payee_address2.rb → create_payee_address_v3.rb} +37 -51
- data/lib/velopayments/models/{create_payee_address.rb → create_payee_address_v4.rb} +49 -52
- data/lib/velopayments/models/{create_payee.rb → create_payee_v3.rb} +33 -28
- data/lib/velopayments/models/{create_payee2.rb → create_payee_v4.rb} +55 -50
- data/lib/velopayments/models/create_payees_csv_request_v3.rb +1277 -0
- data/lib/velopayments/models/create_payees_csv_request_v4.rb +1277 -0
- data/lib/velopayments/models/{create_payees_csv_response.rb → create_payees_csv_response_v3.rb} +19 -23
- data/lib/velopayments/models/{create_payees_csv_response_rejected_csv_rows.rb → create_payees_csv_response_v3_rejected_csv_rows.rb} +18 -22
- data/lib/velopayments/models/{create_payees_csv_response2.rb → create_payees_csv_response_v4.rb} +19 -23
- data/lib/velopayments/models/{create_payees_request.rb → create_payees_request_v3.rb} +23 -23
- data/lib/velopayments/models/{create_payees_request2.rb → create_payees_request_v4.rb} +23 -23
- data/lib/velopayments/models/{create_payment_channel.rb → create_payment_channel_v3.rb} +104 -67
- data/lib/velopayments/models/{create_payment_channel2.rb → create_payment_channel_v4.rb} +104 -67
- data/lib/velopayments/models/create_payor_link_request.rb +21 -19
- data/lib/velopayments/models/create_payout_request_v3.rb +22 -20
- data/lib/velopayments/models/create_webhook_request.rb +28 -22
- data/lib/velopayments/models/debit_event.rb +23 -19
- data/lib/velopayments/models/debit_event_all_of.rb +17 -19
- data/lib/velopayments/models/debit_status_changed.rb +25 -19
- data/lib/velopayments/models/debit_status_changed_all_of.rb +17 -19
- data/lib/velopayments/models/error.rb +15 -19
- data/lib/velopayments/models/error_data.rb +15 -19
- data/lib/velopayments/models/error_response.rb +20 -20
- data/lib/velopayments/models/{failed_payee.rb → failed_payee_v3.rb} +25 -28
- data/lib/velopayments/models/{failed_payee2.rb → failed_payee_v4.rb} +26 -29
- data/lib/velopayments/models/{failed_submission.rb → failed_submission_v3.rb} +19 -23
- data/lib/velopayments/models/{failed_submission2.rb → failed_submission_v4.rb} +19 -23
- data/lib/velopayments/models/{funding_account_response2.rb → funding_account_response_v2.rb} +43 -28
- data/lib/velopayments/models/funding_audit.rb +18 -77
- data/lib/velopayments/models/funding_event.rb +17 -20
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +22 -22
- data/lib/velopayments/models/funding_request_v2.rb +17 -19
- data/lib/velopayments/models/funding_request_v3.rb +19 -19
- data/lib/velopayments/models/{source_account_response.rb → funding_response.rb} +178 -138
- data/lib/velopayments/models/fx_summary.rb +87 -61
- data/lib/velopayments/models/fx_summary_v3.rb +87 -61
- data/lib/velopayments/models/get_fundings_response.rb +15 -19
- data/lib/velopayments/models/get_fundings_response_links.rb +15 -19
- data/lib/velopayments/models/{get_payee_list_response_company.rb → get_payee_list_response_company_v3.rb} +24 -24
- data/lib/velopayments/models/{get_payee_list_response_company2.rb → get_payee_list_response_company_v4.rb} +24 -24
- data/lib/velopayments/models/{get_payee_list_response_individual.rb → get_payee_list_response_individual_v3.rb} +19 -23
- data/lib/velopayments/models/{get_payee_list_response_individual2.rb → get_payee_list_response_individual_v4.rb} +19 -23
- data/lib/velopayments/models/{get_payee_list_response.rb → get_payee_list_response_v3.rb} +66 -27
- data/lib/velopayments/models/{get_payee_list_response2.rb → get_payee_list_response_v4.rb} +67 -28
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +15 -19
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +15 -19
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +16 -54
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +17 -21
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +32 -25
- data/lib/velopayments/models/get_payout_statistics.rb +19 -19
- data/lib/velopayments/models/get_payouts_response.rb +17 -21
- data/lib/velopayments/models/get_payouts_response_v3.rb +15 -19
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +15 -19
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +15 -19
- data/lib/velopayments/models/{individual.rb → individual_v3.rb} +29 -25
- data/lib/velopayments/models/{create_individual_name.rb → individual_v3_name.rb} +34 -26
- data/lib/velopayments/models/{individual2.rb → individual_v4.rb} +29 -25
- data/lib/velopayments/models/inline_response400.rb +15 -19
- data/lib/velopayments/models/inline_response401.rb +15 -19
- data/lib/velopayments/models/inline_response403.rb +15 -19
- data/lib/velopayments/models/inline_response404.rb +15 -19
- data/lib/velopayments/models/inline_response409.rb +15 -19
- data/lib/velopayments/models/inline_response412.rb +15 -19
- data/lib/velopayments/models/instruct_payout_request_v3.rb +215 -0
- data/lib/velopayments/models/{invite_payee_request.rb → invite_payee_request_v3.rb} +20 -22
- data/lib/velopayments/models/{invite_payee_request2.rb → invite_payee_request_v4.rb} +20 -22
- data/lib/velopayments/models/invite_user_request.rb +62 -26
- data/lib/velopayments/models/link_for_response.rb +15 -19
- data/lib/velopayments/models/{list_funding_accounts_response2.rb → list_funding_accounts_response_v2.rb} +21 -25
- data/lib/velopayments/models/{payee_delta_response_links.rb → list_funding_accounts_response_v2_links.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response_page.rb → list_funding_accounts_response_v2_page.rb} +18 -22
- data/lib/velopayments/models/list_payments_response_v3.rb +15 -19
- data/lib/velopayments/models/list_payments_response_v3_page.rb +15 -19
- data/lib/velopayments/models/list_payments_response_v4.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v2.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v3.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +15 -19
- data/lib/velopayments/models/localisation_details.rb +15 -19
- data/lib/velopayments/models/mfa_details.rb +37 -19
- data/lib/velopayments/models/mfa_type.rb +8 -5
- data/lib/velopayments/models/{name.rb → name_v3.rb} +42 -30
- data/lib/velopayments/models/{name2.rb → name_v4.rb} +42 -30
- data/lib/velopayments/models/notification.rb +24 -21
- data/lib/velopayments/models/{funding_event_type.rb → notification_source.rb} +48 -24
- data/lib/velopayments/models/{notifications.rb → notifications_v2.rb} +18 -22
- data/lib/velopayments/models/{notifications2.rb → notifications_v3.rb} +18 -22
- data/lib/velopayments/models/onboarding_status_changed.rb +23 -19
- data/lib/velopayments/models/page_for_response.rb +15 -19
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +15 -19
- data/lib/velopayments/models/{paged_payee_invitation_status_response.rb → paged_payee_invitation_status_response_v3.rb} +21 -25
- data/lib/velopayments/models/{paged_payee_invitation_status_response_page.rb → paged_payee_invitation_status_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_invitation_status_response2.rb → paged_payee_invitation_status_response_v4.rb} +21 -25
- data/lib/velopayments/models/{paged_payee_response.rb → paged_payee_response_v3.rb} +22 -26
- data/lib/velopayments/models/{paged_payee_response_links.rb → paged_payee_response_v3_links.rb} +18 -22
- data/lib/velopayments/models/{payee_delta_response_page.rb → paged_payee_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response_summary.rb → paged_payee_response_v3_summary.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response2.rb → paged_payee_response_v4.rb} +22 -26
- data/lib/velopayments/models/paged_payments_response_v3.rb +17 -21
- data/lib/velopayments/models/paged_user_response.rb +15 -19
- data/lib/velopayments/models/paged_user_response_links.rb +15 -19
- data/lib/velopayments/models/paged_user_response_page.rb +15 -19
- data/lib/velopayments/models/password_request.rb +17 -19
- data/lib/velopayments/models/{payable_issue.rb → payable_issue_v3.rb} +22 -22
- data/lib/velopayments/models/{payable_issue2.rb → payable_issue_v4.rb} +22 -22
- data/lib/velopayments/models/payable_status_changed.rb +23 -19
- data/lib/velopayments/models/{payee_address2.rb → payee_address_v3.rb} +41 -27
- data/lib/velopayments/models/{payee_address.rb → payee_address_v4.rb} +24 -22
- data/lib/velopayments/models/{payee_delta_response.rb → payee_delta_response_v3.rb} +21 -25
- data/lib/velopayments/models/{payee_delta_response2_links.rb → payee_delta_response_v3_links.rb} +18 -22
- data/lib/velopayments/models/{list_source_account_response_page.rb → payee_delta_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{payee_delta_response2.rb → payee_delta_response_v4.rb} +21 -25
- data/lib/velopayments/models/{list_source_account_response_links.rb → payee_delta_response_v4_links.rb} +18 -22
- data/lib/velopayments/models/{payee_delta.rb → payee_delta_v3.rb} +24 -23
- data/lib/velopayments/models/{payee_delta2.rb → payee_delta_v4.rb} +64 -23
- data/lib/velopayments/models/{payee_detail_response2.rb → payee_detail_response_v3.rb} +69 -30
- data/lib/velopayments/models/{payee_detail_response.rb → payee_detail_response_v4.rb} +29 -30
- data/lib/velopayments/models/payee_details_changed.rb +23 -19
- data/lib/velopayments/models/payee_event.rb +23 -19
- data/lib/velopayments/models/payee_event_all_of.rb +17 -19
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +19 -19
- data/lib/velopayments/models/{payee_invitation_status_response.rb → payee_invitation_status_response_v3.rb} +23 -56
- data/lib/velopayments/models/{payee_invitation_status_response2.rb → payee_invitation_status_response_v4.rb} +23 -56
- data/lib/velopayments/models/payee_payor_ref_v3.rb +17 -21
- data/lib/velopayments/models/{payee_payor_ref.rb → payee_payor_ref_v4.rb} +20 -24
- data/lib/velopayments/models/payee_type.rb +10 -7
- data/lib/velopayments/models/{payment_rails.rb → payee_type_enum.rb} +11 -8
- data/lib/velopayments/models/payee_user_self_update_request.rb +15 -19
- data/lib/velopayments/models/payment_channel_country.rb +19 -19
- data/lib/velopayments/models/payment_channel_rule.rb +37 -23
- data/lib/velopayments/models/payment_channel_rules_response.rb +15 -19
- data/lib/velopayments/models/payment_delta.rb +19 -19
- data/lib/velopayments/models/payment_delta_response.rb +17 -21
- data/lib/velopayments/models/payment_delta_response_v1.rb +17 -21
- data/lib/velopayments/models/payment_delta_v1.rb +19 -19
- data/lib/velopayments/models/payment_event.rb +23 -19
- data/lib/velopayments/models/payment_event_all_of.rb +17 -19
- data/lib/velopayments/models/payment_event_response.rb +109 -55
- data/lib/velopayments/models/payment_event_response_v3.rb +79 -53
- data/lib/velopayments/models/payment_instruction_v3.rb +84 -29
- data/lib/velopayments/models/payment_rejected_or_returned.rb +29 -19
- data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +19 -19
- data/lib/velopayments/models/payment_response_v3.rb +101 -63
- data/lib/velopayments/models/payment_response_v4.rb +139 -63
- data/lib/velopayments/models/payment_response_v4_payout.rb +15 -19
- data/lib/velopayments/models/payment_status_changed.rb +25 -19
- data/lib/velopayments/models/payment_status_changed_all_of.rb +17 -19
- data/lib/velopayments/models/payment_v3.rb +167 -55
- data/lib/velopayments/models/payor_address.rb +21 -19
- data/lib/velopayments/models/payor_address_v2.rb +21 -19
- data/lib/velopayments/models/payor_aml_transaction.rb +15 -19
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +15 -19
- data/lib/velopayments/models/payor_branding_response.rb +20 -20
- data/lib/velopayments/models/payor_create_api_key_request.rb +23 -23
- data/lib/velopayments/models/payor_create_api_key_response.rb +15 -19
- data/lib/velopayments/models/payor_create_application_request.rb +17 -19
- data/lib/velopayments/models/payor_email_opt_out_request.rb +17 -19
- data/lib/velopayments/models/payor_links_response.rb +15 -19
- data/lib/velopayments/models/payor_links_response_links.rb +24 -53
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -53
- data/lib/velopayments/models/payor_v1.rb +19 -54
- data/lib/velopayments/models/payor_v2.rb +65 -58
- data/lib/velopayments/models/payout_company_v3.rb +17 -19
- data/lib/velopayments/models/payout_individual_v3.rb +17 -19
- data/lib/velopayments/models/payout_name_v3.rb +19 -19
- data/lib/velopayments/models/payout_payee_v3.rb +17 -19
- data/lib/velopayments/models/payout_payor.rb +25 -19
- data/lib/velopayments/models/payout_payor_ids.rb +21 -19
- data/lib/velopayments/models/payout_principal.rb +19 -19
- data/lib/velopayments/models/payout_schedule.rb +298 -0
- data/lib/velopayments/models/payout_schedule_v3.rb +288 -0
- data/lib/velopayments/models/payout_summary_audit.rb +40 -25
- data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
- data/lib/velopayments/models/payout_summary_response_v3.rb +44 -23
- data/lib/velopayments/models/ping.rb +21 -19
- data/lib/velopayments/models/ping_response.rb +223 -0
- data/lib/velopayments/models/post_instruct_fx_info.rb +267 -0
- data/lib/velopayments/models/{query_batch_response.rb → query_batch_response_v3.rb} +20 -58
- data/lib/velopayments/models/{query_batch_response2.rb → query_batch_response_v4.rb} +20 -58
- data/lib/velopayments/models/quote_fx_summary_v3.rb +42 -65
- data/lib/velopayments/models/quote_response_v3.rb +15 -19
- data/lib/velopayments/models/region_v2.rb +15 -19
- data/lib/velopayments/models/register_sms_request.rb +17 -19
- data/lib/velopayments/models/rejected_payment_v3.rb +121 -19
- data/lib/velopayments/models/resend_token_request.rb +17 -19
- data/lib/velopayments/models/reset_password_request.rb +17 -19
- data/lib/velopayments/models/role.rb +17 -19
- data/lib/velopayments/models/role_update_request.rb +17 -19
- data/lib/velopayments/models/{funding_request_v1.rb → schedule_payout_request_v3.rb} +46 -59
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +17 -19
- data/lib/velopayments/models/self_update_password_request.rb +19 -19
- data/lib/velopayments/models/set_notifications_request.rb +17 -19
- data/lib/velopayments/models/set_notifications_request2.rb +250 -0
- data/lib/velopayments/models/source_account_response_v2.rb +44 -50
- data/lib/velopayments/models/source_account_response_v3.rb +66 -53
- data/lib/velopayments/models/source_account_summary.rb +49 -20
- data/lib/velopayments/models/source_account_summary_v3.rb +49 -20
- data/lib/velopayments/models/source_account_v3.rb +26 -19
- data/lib/velopayments/models/source_event.rb +21 -19
- data/lib/velopayments/models/supported_countries_response.rb +15 -19
- data/lib/velopayments/models/supported_countries_response_v2.rb +15 -19
- data/lib/velopayments/models/supported_country.rb +22 -22
- data/lib/velopayments/models/supported_country_v2.rb +22 -22
- data/lib/velopayments/models/supported_currency_response_v2.rb +15 -19
- data/lib/velopayments/models/supported_currency_v2.rb +22 -22
- data/lib/velopayments/models/{transfer_request2.rb → transfer_request_v2.rb} +24 -22
- data/lib/velopayments/models/{transfer_request.rb → transfer_request_v3.rb} +36 -22
- data/lib/velopayments/models/transmission_types.rb +21 -19
- data/lib/velopayments/models/transmission_types2.rb +21 -19
- data/lib/velopayments/models/unregister_mfa_request.rb +17 -19
- data/lib/velopayments/models/{update_payee_details_request.rb → update_payee_details_request_v3.rb} +45 -27
- data/lib/velopayments/models/{update_payee_details_request2.rb → update_payee_details_request_v4.rb} +81 -32
- data/lib/velopayments/models/{update_remote_id_request2.rb → update_remote_id_request_v3.rb} +22 -22
- data/lib/velopayments/models/{update_remote_id_request.rb → update_remote_id_request_v4.rb} +22 -22
- data/lib/velopayments/models/update_webhook_request.rb +21 -21
- data/lib/velopayments/models/user_details_update_request.rb +37 -19
- data/lib/velopayments/models/user_info.rb +37 -19
- data/lib/velopayments/models/user_response.rb +108 -28
- data/lib/velopayments/models/user_status.rb +8 -5
- data/lib/velopayments/models/user_type.rb +8 -5
- data/lib/velopayments/models/user_type2.rb +8 -5
- data/lib/velopayments/models/validate_password_response.rb +21 -21
- data/lib/velopayments/models/webhook_response.rb +15 -19
- data/lib/velopayments/models/webhooks_response.rb +17 -21
- data/lib/velopayments/models/withdraw_payment_request.rb +17 -19
- data/lib/velopayments/version.rb +3 -3
- data/lib/velopayments.rb +93 -102
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +41 -6
- data/spec/api/currencies_api_spec.rb +5 -3
- data/spec/api/funding_api_spec.rb +169 -0
- data/spec/api/funding_manager_private_api_spec.rb +4 -4
- data/spec/api/login_api_spec.rb +11 -11
- data/spec/api/payee_invitation_api_spec.rb +74 -38
- data/spec/api/payees_api_spec.rb +77 -43
- data/spec/api/payment_audit_service_api_spec.rb +97 -18
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +10 -10
- data/spec/{models/get_fundings_response_links_spec.rb → api/payor_hierarchy_api_spec.rb} +24 -15
- data/spec/api/payors_api_spec.rb +47 -35
- data/spec/api/payors_private_api_spec.rb +3 -3
- data/spec/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +43 -17
- data/spec/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +81 -162
- data/spec/api/tokens_api_spec.rb +3 -3
- data/spec/api/users_api_spec.rb +46 -19
- data/spec/api/webhooks_api_spec.rb +16 -6
- data/spec/api_client_spec.rb +6 -4
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +19 -19
- data/specs/api/currencies_api_spec.rb +2 -2
- data/specs/api/funding_api_spec.rb +169 -0
- data/specs/api/funding_manager_private_api_spec.rb +16 -4
- data/specs/api/login_api_spec.rb +8 -7
- data/specs/api/payee_invitation_api_spec.rb +55 -39
- data/specs/api/payees_api_spec.rb +107 -45
- data/specs/api/payment_audit_service_api_spec.rb +29 -85
- data/specs/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/{spec/models/company2_spec.rb → specs/api/payor_hierarchy_api_spec.rb} +23 -20
- data/specs/api/payors_api_spec.rb +27 -48
- data/specs/api/payors_private_api_spec.rb +4 -4
- data/specs/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +51 -24
- data/specs/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +36 -208
- data/specs/api/tokens_api_spec.rb +4 -4
- data/specs/api/users_api_spec.rb +38 -47
- data/{spec/models/failed_payee_spec.rb → specs/api/webhooks_api_spec.rb} +53 -51
- data/velopayments.gemspec +3 -3
- metadata +213 -724
- data/docs/CreatePayee2.md +0 -38
- data/docs/FundingAccountResponse.md +0 -36
- data/docs/FundingAccountType.md +0 -15
- data/docs/FundingEventType.md +0 -15
- data/docs/FundingManagerApi.md +0 -1291
- data/docs/FundingRequestV1.md +0 -18
- data/docs/GetPayeeListResponseIndividual.md +0 -18
- data/docs/GetPayeeListResponseIndividual2.md +0 -18
- data/docs/InvitationStatus.md +0 -15
- data/docs/InvitationStatus2.md +0 -15
- data/docs/KycState.md +0 -15
- data/docs/ListFundingAccountsResponse.md +0 -22
- data/docs/ListFundingAccountsResponse2.md +0 -22
- data/docs/ListSourceAccountResponse.md +0 -22
- data/docs/OfacStatus.md +0 -15
- data/docs/OnboardedStatus.md +0 -15
- data/docs/OnboardedStatus2.md +0 -15
- data/docs/PagedPayeeInvitationStatusResponse.md +0 -22
- data/docs/PagedPayeeInvitationStatusResponse2.md +0 -22
- data/docs/PagedPayeeResponse.md +0 -24
- data/docs/PagedPayeeResponse2.md +0 -24
- data/docs/PayeeDeltaResponse.md +0 -22
- data/docs/PayeeDeltaResponse2.md +0 -22
- data/docs/PaymentAuditCurrency.md +0 -15
- data/docs/PaymentAuditCurrencyV3.md +0 -15
- data/docs/PaymentRails.md +0 -15
- data/docs/PayoutStatusV3.md +0 -15
- data/docs/PayoutType.md +0 -15
- data/docs/SourceAccountResponse.md +0 -44
- data/docs/SourceAccountType.md +0 -15
- data/docs/TransmissionType.md +0 -15
- data/docs/UpdatePayeeDetailsRequest2.md +0 -30
- data/docs/WatchlistStatus.md +0 -15
- data/docs/WatchlistStatus2.md +0 -15
- data/lib/velopayments/api/funding_manager_api.rb +0 -1312
- data/lib/velopayments/models/funding_account_response.rb +0 -357
- data/lib/velopayments/models/funding_account_type.rb +0 -37
- data/lib/velopayments/models/invitation_status.rb +0 -38
- data/lib/velopayments/models/invitation_status2.rb +0 -38
- data/lib/velopayments/models/kyc_state.rb +0 -38
- data/lib/velopayments/models/list_funding_accounts_response.rb +0 -241
- data/lib/velopayments/models/list_source_account_response.rb +0 -241
- data/lib/velopayments/models/ofac_status.rb +0 -38
- data/lib/velopayments/models/onboarded_status.rb +0 -39
- data/lib/velopayments/models/onboarded_status2.rb +0 -39
- data/lib/velopayments/models/payment_audit_currency.rb +0 -38
- data/lib/velopayments/models/payment_audit_currency_v3.rb +0 -38
- data/lib/velopayments/models/payout_status.rb +0 -44
- data/lib/velopayments/models/payout_status_v3.rb +0 -44
- data/lib/velopayments/models/payout_type.rb +0 -38
- data/lib/velopayments/models/source_account_type.rb +0 -37
- data/lib/velopayments/models/transmission_type.rb +0 -38
- data/lib/velopayments/models/watchlist_status.rb +0 -40
- data/lib/velopayments/models/watchlist_status2.rb +0 -40
- data/spec/models/accepted_payment_v3_spec.rb +0 -76
- data/spec/models/access_token_response_spec.rb +0 -70
- data/spec/models/access_token_validation_request_spec.rb +0 -34
- data/spec/models/auth_response_spec.rb +0 -64
- data/spec/models/auto_top_up_config2_spec.rb +0 -52
- data/spec/models/auto_top_up_config_spec.rb +0 -46
- data/spec/models/category_spec.rb +0 -28
- data/spec/models/challenge2_spec.rb +0 -40
- data/spec/models/challenge_spec.rb +0 -40
- data/spec/models/company_spec.rb +0 -46
- data/spec/models/create_funding_account_request_v2_spec.rb +0 -74
- data/spec/models/create_individual2_spec.rb +0 -46
- data/spec/models/create_individual_name_spec.rb +0 -52
- data/spec/models/create_individual_spec.rb +0 -46
- data/spec/models/create_payee2_spec.rb +0 -94
- data/spec/models/create_payee_address2_spec.rb +0 -80
- data/spec/models/create_payee_address_spec.rb +0 -80
- data/spec/models/create_payee_spec.rb +0 -94
- data/spec/models/create_payees_csv_response2_spec.rb +0 -40
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +0 -46
- data/spec/models/create_payees_csv_response_spec.rb +0 -40
- data/spec/models/create_payees_request2_spec.rb +0 -40
- data/spec/models/create_payees_request_spec.rb +0 -40
- data/spec/models/create_payment_channel2_spec.rb +0 -78
- data/spec/models/create_payment_channel_spec.rb +0 -78
- data/spec/models/create_payor_link_request_spec.rb +0 -50
- data/spec/models/create_payout_request_v3_spec.rb +0 -52
- data/spec/models/debit_event_all_of_spec.rb +0 -34
- data/spec/models/debit_event_spec.rb +0 -52
- data/spec/models/debit_status_changed_all_of_spec.rb +0 -34
- data/spec/models/debit_status_changed_spec.rb +0 -58
- data/spec/models/error_data_spec.rb +0 -40
- data/spec/models/error_response_spec.rb +0 -46
- data/spec/models/error_spec.rb +0 -74
- data/spec/models/failed_payee2_spec.rb +0 -94
- data/spec/models/failed_submission2_spec.rb +0 -40
- data/spec/models/failed_submission_spec.rb +0 -40
- data/spec/models/funding_account_response2_spec.rb +0 -88
- data/spec/models/funding_account_response_spec.rb +0 -88
- data/spec/models/funding_account_type_spec.rb +0 -28
- data/spec/models/funding_audit_spec.rb +0 -94
- data/spec/models/funding_event_spec.rb +0 -52
- data/spec/models/funding_event_type_spec.rb +0 -28
- data/spec/models/funding_payor_status_audit_response_spec.rb +0 -52
- data/spec/models/funding_request_v1_spec.rb +0 -34
- data/spec/models/funding_request_v2_spec.rb +0 -34
- data/spec/models/funding_request_v3_spec.rb +0 -40
- data/spec/models/fx_summary_spec.rb +0 -96
- data/spec/models/fx_summary_v3_spec.rb +0 -96
- data/spec/models/get_fundings_response_spec.rb +0 -46
- data/spec/models/get_payee_list_response2_spec.rb +0 -130
- data/spec/models/get_payee_list_response_company2_spec.rb +0 -40
- data/spec/models/get_payee_list_response_company_spec.rb +0 -40
- data/spec/models/get_payee_list_response_individual2_spec.rb +0 -34
- data/spec/models/get_payee_list_response_individual_spec.rb +0 -34
- data/spec/models/get_payee_list_response_spec.rb +0 -130
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +0 -58
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +0 -52
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +0 -92
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +0 -52
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +0 -142
- data/spec/models/get_payout_statistics_spec.rb +0 -40
- data/spec/models/get_payouts_response_spec.rb +0 -46
- data/spec/models/get_payouts_response_v3_links_spec.rb +0 -40
- data/spec/models/get_payouts_response_v3_page_spec.rb +0 -58
- data/spec/models/get_payouts_response_v3_spec.rb +0 -46
- data/spec/models/individual2_spec.rb +0 -46
- data/spec/models/individual_name_spec.rb +0 -52
- data/spec/models/individual_spec.rb +0 -46
- data/spec/models/inline_response400_spec.rb +0 -46
- data/spec/models/inline_response401_spec.rb +0 -46
- data/spec/models/inline_response403_spec.rb +0 -46
- data/spec/models/inline_response404_spec.rb +0 -46
- data/spec/models/inline_response409_spec.rb +0 -46
- data/spec/models/inline_response412_spec.rb +0 -46
- data/spec/models/invitation_status2_spec.rb +0 -28
- data/spec/models/invitation_status_spec.rb +0 -28
- data/spec/models/invite_payee_request2_spec.rb +0 -34
- data/spec/models/invite_payee_request_spec.rb +0 -34
- data/spec/models/invite_user_request_spec.rb +0 -92
- data/spec/models/kyc_state_spec.rb +0 -28
- data/spec/models/link_for_response_spec.rb +0 -40
- data/spec/models/list_funding_accounts_response2_spec.rb +0 -46
- data/spec/models/list_funding_accounts_response_spec.rb +0 -46
- data/spec/models/list_payments_response_v3_page_spec.rb +0 -58
- data/spec/models/list_payments_response_v3_spec.rb +0 -46
- data/spec/models/list_payments_response_v4_spec.rb +0 -46
- data/spec/models/list_source_account_response_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_page_spec.rb +0 -58
- data/spec/models/list_source_account_response_spec.rb +0 -46
- data/spec/models/list_source_account_response_v2_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_v2_spec.rb +0 -46
- data/spec/models/list_source_account_response_v3_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_v3_spec.rb +0 -46
- data/spec/models/localisation_details_spec.rb +0 -40
- data/spec/models/mfa_details_spec.rb +0 -40
- data/spec/models/mfa_type_spec.rb +0 -28
- data/spec/models/name2_spec.rb +0 -52
- data/spec/models/name_spec.rb +0 -52
- data/spec/models/notification_spec.rb +0 -58
- data/spec/models/notifications2_spec.rb +0 -34
- data/spec/models/notifications_spec.rb +0 -34
- data/spec/models/ofac_status_spec.rb +0 -28
- data/spec/models/onboarded_status2_spec.rb +0 -28
- data/spec/models/onboarded_status_spec.rb +0 -28
- data/spec/models/onboarding_status_changed_spec.rb +0 -58
- data/spec/models/page_for_response_spec.rb +0 -58
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +0 -46
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +0 -46
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +0 -58
- data/spec/models/paged_payee_invitation_status_response_spec.rb +0 -46
- data/spec/models/paged_payee_response2_spec.rb +0 -52
- data/spec/models/paged_payee_response_links_spec.rb +0 -40
- data/spec/models/paged_payee_response_page_spec.rb +0 -58
- data/spec/models/paged_payee_response_spec.rb +0 -52
- data/spec/models/paged_payee_response_summary_spec.rb +0 -58
- data/spec/models/paged_payments_response_v3_spec.rb +0 -46
- data/spec/models/paged_user_response_links_spec.rb +0 -40
- data/spec/models/paged_user_response_page_spec.rb +0 -58
- data/spec/models/paged_user_response_spec.rb +0 -46
- data/spec/models/password_request_spec.rb +0 -34
- data/spec/models/payable_issue2_spec.rb +0 -40
- data/spec/models/payable_issue_spec.rb +0 -40
- data/spec/models/payable_status_changed_spec.rb +0 -58
- data/spec/models/payee_address2_spec.rb +0 -76
- data/spec/models/payee_address_spec.rb +0 -76
- data/spec/models/payee_delta2_spec.rb +0 -70
- data/spec/models/payee_delta_response2_links_spec.rb +0 -40
- data/spec/models/payee_delta_response2_spec.rb +0 -46
- data/spec/models/payee_delta_response_links_spec.rb +0 -40
- data/spec/models/payee_delta_response_page_spec.rb +0 -58
- data/spec/models/payee_delta_response_spec.rb +0 -46
- data/spec/models/payee_delta_spec.rb +0 -70
- data/spec/models/payee_detail_response2_spec.rb +0 -202
- data/spec/models/payee_detail_response_spec.rb +0 -202
- data/spec/models/payee_details_changed_spec.rb +0 -58
- data/spec/models/payee_event_all_of_reasons_spec.rb +0 -40
- data/spec/models/payee_event_all_of_spec.rb +0 -40
- data/spec/models/payee_event_spec.rb +0 -58
- data/spec/models/payee_invitation_status_response2_spec.rb +0 -50
- data/spec/models/payee_invitation_status_response_spec.rb +0 -50
- data/spec/models/payee_payor_ref_spec.rb +0 -70
- data/spec/models/payee_payor_ref_v3_spec.rb +0 -70
- data/spec/models/payee_type_spec.rb +0 -28
- data/spec/models/payee_user_self_update_request_spec.rb +0 -64
- data/spec/models/payment_audit_currency_spec.rb +0 -28
- data/spec/models/payment_audit_currency_v3_spec.rb +0 -28
- data/spec/models/payment_channel_country_spec.rb +0 -40
- data/spec/models/payment_channel_rule_spec.rb +0 -70
- data/spec/models/payment_channel_rules_response_spec.rb +0 -34
- data/spec/models/payment_delta_response_spec.rb +0 -46
- data/spec/models/payment_delta_response_v1_spec.rb +0 -46
- data/spec/models/payment_delta_spec.rb +0 -76
- data/spec/models/payment_delta_v1_spec.rb +0 -76
- data/spec/models/payment_event_all_of_spec.rb +0 -46
- data/spec/models/payment_event_response_spec.rb +0 -104
- data/spec/models/payment_event_response_v3_spec.rb +0 -104
- data/spec/models/payment_event_spec.rb +0 -64
- data/spec/models/payment_instruction_v3_spec.rb +0 -82
- data/spec/models/payment_rails_spec.rb +0 -28
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +0 -40
- data/spec/models/payment_rejected_or_returned_spec.rb +0 -82
- data/spec/models/payment_response_v3_spec.rb +0 -252
- data/spec/models/payment_response_v4_payout_spec.rb +0 -46
- data/spec/models/payment_response_v4_spec.rb +0 -306
- data/spec/models/payment_status_changed_all_of_spec.rb +0 -34
- data/spec/models/payment_status_changed_spec.rb +0 -70
- data/spec/models/payment_v3_spec.rb +0 -110
- data/spec/models/payor_address_spec.rb +0 -76
- data/spec/models/payor_address_v2_spec.rb +0 -76
- data/spec/models/payor_aml_transaction_spec.rb +0 -190
- data/spec/models/payor_aml_transaction_v3_spec.rb +0 -178
- data/spec/models/payor_branding_response_spec.rb +0 -58
- data/spec/models/payor_create_api_key_request_spec.rb +0 -50
- data/spec/models/payor_create_api_key_response_spec.rb +0 -40
- data/spec/models/payor_create_application_request_spec.rb +0 -40
- data/spec/models/payor_email_opt_out_request_spec.rb +0 -34
- data/spec/models/payor_links_response_links_spec.rb +0 -56
- data/spec/models/payor_links_response_payors_spec.rb +0 -56
- data/spec/models/payor_links_response_spec.rb +0 -40
- data/spec/models/payor_v1_spec.rb +0 -164
- data/spec/models/payor_v2_spec.rb +0 -170
- data/spec/models/payout_company_v3_spec.rb +0 -34
- data/spec/models/payout_individual_v3_spec.rb +0 -34
- data/spec/models/payout_name_v3_spec.rb +0 -40
- data/spec/models/payout_payee_v3_spec.rb +0 -46
- data/spec/models/payout_payor_ids_spec.rb +0 -46
- data/spec/models/payout_payor_spec.rb +0 -58
- data/spec/models/payout_principal_spec.rb +0 -40
- data/spec/models/payout_status_spec.rb +0 -28
- data/spec/models/payout_status_v3_spec.rb +0 -28
- data/spec/models/payout_summary_audit_spec.rb +0 -124
- data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
- data/spec/models/payout_summary_response_v3_spec.rb +0 -88
- data/spec/models/payout_type_spec.rb +0 -28
- data/spec/models/ping_spec.rb +0 -46
- data/spec/models/query_batch_response2_spec.rb +0 -56
- data/spec/models/query_batch_response_spec.rb +0 -56
- data/spec/models/quote_fx_summary_v3_spec.rb +0 -102
- data/spec/models/quote_response_v3_spec.rb +0 -34
- data/spec/models/region_v2_spec.rb +0 -40
- data/spec/models/register_sms_request_spec.rb +0 -34
- data/spec/models/rejected_payment_v3_spec.rb +0 -94
- data/spec/models/resend_token_request_spec.rb +0 -44
- data/spec/models/reset_password_request_spec.rb +0 -34
- data/spec/models/role_spec.rb +0 -34
- data/spec/models/role_update_request_spec.rb +0 -40
- data/spec/models/self_mfa_type_unregister_request_spec.rb +0 -38
- data/spec/models/self_update_password_request_spec.rb +0 -40
- data/spec/models/set_notifications_request_spec.rb +0 -34
- data/spec/models/source_account_response_spec.rb +0 -116
- data/spec/models/source_account_response_v2_spec.rb +0 -128
- data/spec/models/source_account_response_v3_spec.rb +0 -140
- data/spec/models/source_account_summary_spec.rb +0 -46
- data/spec/models/source_account_summary_v3_spec.rb +0 -46
- data/spec/models/source_account_type_spec.rb +0 -28
- data/spec/models/source_account_v3_spec.rb +0 -52
- data/spec/models/source_event_spec.rb +0 -46
- data/spec/models/supported_countries_response_spec.rb +0 -34
- data/spec/models/supported_countries_response_v2_spec.rb +0 -34
- data/spec/models/supported_country_spec.rb +0 -40
- data/spec/models/supported_country_v2_spec.rb +0 -46
- data/spec/models/supported_currency_response_v2_spec.rb +0 -34
- data/spec/models/supported_currency_v2_spec.rb +0 -40
- data/spec/models/transfer_request2_spec.rb +0 -46
- data/spec/models/transfer_request_spec.rb +0 -46
- data/spec/models/transmission_type_spec.rb +0 -28
- data/spec/models/transmission_types2_spec.rb +0 -46
- data/spec/models/transmission_types_spec.rb +0 -46
- data/spec/models/unregister_mfa_request_spec.rb +0 -44
- data/spec/models/update_payee_details_request2_spec.rb +0 -70
- data/spec/models/update_payee_details_request_spec.rb +0 -70
- data/spec/models/update_remote_id_request2_spec.rb +0 -40
- data/spec/models/update_remote_id_request_spec.rb +0 -40
- data/spec/models/update_webhook_request_spec.rb +0 -52
- data/spec/models/user_details_update_request_spec.rb +0 -76
- data/spec/models/user_info_spec.rb +0 -46
- data/spec/models/user_response_spec.rb +0 -124
- data/spec/models/user_status_spec.rb +0 -28
- data/spec/models/user_type2_spec.rb +0 -28
- data/spec/models/user_type_spec.rb +0 -28
- data/spec/models/validate_password_response_spec.rb +0 -52
- data/spec/models/watchlist_status2_spec.rb +0 -28
- data/spec/models/watchlist_status_spec.rb +0 -28
- data/spec/models/webhook_response_spec.rb +0 -64
- data/spec/models/webhooks_response_spec.rb +0 -46
- data/spec/models/withdraw_payment_request_spec.rb +0 -34
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.35.58
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -146,7 +146,7 @@ module VeloPayments
|
|
146
146
|
# @param payee_id [String] The UUID of the payee.
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @option opts [Boolean] :sensitive 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.
|
149
|
-
# @return [
|
149
|
+
# @return [PayeeDetailResponseV3]
|
150
150
|
def get_payee_by_id_v3(payee_id, opts = {})
|
151
151
|
data, _status_code, _headers = get_payee_by_id_v3_with_http_info(payee_id, opts)
|
152
152
|
data
|
@@ -157,7 +157,7 @@ module VeloPayments
|
|
157
157
|
# @param payee_id [String] The UUID of the payee.
|
158
158
|
# @param [Hash] opts the optional parameters
|
159
159
|
# @option opts [Boolean] :sensitive 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.
|
160
|
-
# @return [Array<(
|
160
|
+
# @return [Array<(PayeeDetailResponseV3, Integer, Hash)>] PayeeDetailResponseV3 data, response status code and response headers
|
161
161
|
def get_payee_by_id_v3_with_http_info(payee_id, opts = {})
|
162
162
|
if @api_client.config.debugging
|
163
163
|
@api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v3 ...'
|
@@ -185,7 +185,7 @@ module VeloPayments
|
|
185
185
|
post_body = opts[:debug_body]
|
186
186
|
|
187
187
|
# return_type
|
188
|
-
return_type = opts[:debug_return_type] || '
|
188
|
+
return_type = opts[:debug_return_type] || 'PayeeDetailResponseV3'
|
189
189
|
|
190
190
|
# auth_names
|
191
191
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -212,7 +212,7 @@ module VeloPayments
|
|
212
212
|
# @param payee_id [String] The UUID of the payee.
|
213
213
|
# @param [Hash] opts the optional parameters
|
214
214
|
# @option opts [Boolean] :sensitive 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.
|
215
|
-
# @return [
|
215
|
+
# @return [PayeeDetailResponseV4]
|
216
216
|
def get_payee_by_id_v4(payee_id, opts = {})
|
217
217
|
data, _status_code, _headers = get_payee_by_id_v4_with_http_info(payee_id, opts)
|
218
218
|
data
|
@@ -223,7 +223,7 @@ module VeloPayments
|
|
223
223
|
# @param payee_id [String] The UUID of the payee.
|
224
224
|
# @param [Hash] opts the optional parameters
|
225
225
|
# @option opts [Boolean] :sensitive 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.
|
226
|
-
# @return [Array<(
|
226
|
+
# @return [Array<(PayeeDetailResponseV4, Integer, Hash)>] PayeeDetailResponseV4 data, response status code and response headers
|
227
227
|
def get_payee_by_id_v4_with_http_info(payee_id, opts = {})
|
228
228
|
if @api_client.config.debugging
|
229
229
|
@api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v4 ...'
|
@@ -251,7 +251,7 @@ module VeloPayments
|
|
251
251
|
post_body = opts[:debug_body]
|
252
252
|
|
253
253
|
# return_type
|
254
|
-
return_type = opts[:debug_return_type] || '
|
254
|
+
return_type = opts[:debug_return_type] || 'PayeeDetailResponseV4'
|
255
255
|
|
256
256
|
# auth_names
|
257
257
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -280,7 +280,7 @@ module VeloPayments
|
|
280
280
|
# @param [Hash] opts the optional parameters
|
281
281
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
282
282
|
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
|
283
|
-
# @return [
|
283
|
+
# @return [PayeeDeltaResponseV3]
|
284
284
|
def list_payee_changes_v3(payor_id, updated_since, opts = {})
|
285
285
|
data, _status_code, _headers = list_payee_changes_v3_with_http_info(payor_id, updated_since, opts)
|
286
286
|
data
|
@@ -291,9 +291,9 @@ module VeloPayments
|
|
291
291
|
# @param payor_id [String] The Payor ID to find associated Payees
|
292
292
|
# @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
293
293
|
# @param [Hash] opts the optional parameters
|
294
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
295
|
-
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
|
296
|
-
# @return [Array<(
|
294
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
295
|
+
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
|
296
|
+
# @return [Array<(PayeeDeltaResponseV3, Integer, Hash)>] PayeeDeltaResponseV3 data, response status code and response headers
|
297
297
|
def list_payee_changes_v3_with_http_info(payor_id, updated_since, opts = {})
|
298
298
|
if @api_client.config.debugging
|
299
299
|
@api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes_v3 ...'
|
@@ -328,7 +328,7 @@ module VeloPayments
|
|
328
328
|
post_body = opts[:debug_body]
|
329
329
|
|
330
330
|
# return_type
|
331
|
-
return_type = opts[:debug_return_type] || '
|
331
|
+
return_type = opts[:debug_return_type] || 'PayeeDeltaResponseV3'
|
332
332
|
|
333
333
|
# auth_names
|
334
334
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -357,7 +357,7 @@ module VeloPayments
|
|
357
357
|
# @param [Hash] opts the optional parameters
|
358
358
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
359
359
|
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
|
360
|
-
# @return [
|
360
|
+
# @return [PayeeDeltaResponseV4]
|
361
361
|
def list_payee_changes_v4(payor_id, updated_since, opts = {})
|
362
362
|
data, _status_code, _headers = list_payee_changes_v4_with_http_info(payor_id, updated_since, opts)
|
363
363
|
data
|
@@ -368,9 +368,9 @@ module VeloPayments
|
|
368
368
|
# @param payor_id [String] The Payor ID to find associated Payees
|
369
369
|
# @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
370
370
|
# @param [Hash] opts the optional parameters
|
371
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
372
|
-
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
|
373
|
-
# @return [Array<(
|
371
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
372
|
+
# @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
|
373
|
+
# @return [Array<(PayeeDeltaResponseV4, Integer, Hash)>] PayeeDeltaResponseV4 data, response status code and response headers
|
374
374
|
def list_payee_changes_v4_with_http_info(payor_id, updated_since, opts = {})
|
375
375
|
if @api_client.config.debugging
|
376
376
|
@api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes_v4 ...'
|
@@ -405,7 +405,7 @@ module VeloPayments
|
|
405
405
|
post_body = opts[:debug_body]
|
406
406
|
|
407
407
|
# return_type
|
408
|
-
return_type = opts[:debug_return_type] || '
|
408
|
+
return_type = opts[:debug_return_type] || 'PayeeDeltaResponseV4'
|
409
409
|
|
410
410
|
# auth_names
|
411
411
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -431,18 +431,18 @@ module VeloPayments
|
|
431
431
|
# <p>Use v4 instead</p> Get a paginated response listing the payees for a payor.
|
432
432
|
# @param payor_id [String] The account owner Payor ID
|
433
433
|
# @param [Hash] opts the optional parameters
|
434
|
-
# @option opts [
|
434
|
+
# @option opts [String] :watchlist_status The watchlistStatus of the payees.
|
435
435
|
# @option opts [Boolean] :disabled Payee disabled
|
436
|
-
# @option opts [
|
436
|
+
# @option opts [String] :onboarded_status The onboarded status of the payees.
|
437
437
|
# @option opts [String] :email Email address
|
438
438
|
# @option opts [String] :display_name The display name of the payees.
|
439
439
|
# @option opts [String] :remote_id The remote id of the payees.
|
440
|
-
# @option opts [
|
440
|
+
# @option opts [String] :payee_type The onboarded status of the payees.
|
441
441
|
# @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
442
442
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
443
443
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
444
444
|
# @option opts [String] :sort 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. (default to 'displayName:asc')
|
445
|
-
# @return [
|
445
|
+
# @return [PagedPayeeResponseV3]
|
446
446
|
def list_payees_v3(payor_id, opts = {})
|
447
447
|
data, _status_code, _headers = list_payees_v3_with_http_info(payor_id, opts)
|
448
448
|
data
|
@@ -452,18 +452,18 @@ module VeloPayments
|
|
452
452
|
# <p>Use v4 instead</p> Get a paginated response listing the payees for a payor.
|
453
453
|
# @param payor_id [String] The account owner Payor ID
|
454
454
|
# @param [Hash] opts the optional parameters
|
455
|
-
# @option opts [
|
455
|
+
# @option opts [String] :watchlist_status The watchlistStatus of the payees.
|
456
456
|
# @option opts [Boolean] :disabled Payee disabled
|
457
|
-
# @option opts [
|
457
|
+
# @option opts [String] :onboarded_status The onboarded status of the payees.
|
458
458
|
# @option opts [String] :email Email address
|
459
459
|
# @option opts [String] :display_name The display name of the payees.
|
460
460
|
# @option opts [String] :remote_id The remote id of the payees.
|
461
|
-
# @option opts [
|
461
|
+
# @option opts [String] :payee_type The onboarded status of the payees.
|
462
462
|
# @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
463
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
464
|
-
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
465
|
-
# @option opts [String] :sort 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.
|
466
|
-
# @return [Array<(
|
463
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
464
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
465
|
+
# @option opts [String] :sort 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. (default to 'displayName:asc')
|
466
|
+
# @return [Array<(PagedPayeeResponseV3, Integer, Hash)>] PagedPayeeResponseV3 data, response status code and response headers
|
467
467
|
def list_payees_v3_with_http_info(payor_id, opts = {})
|
468
468
|
if @api_client.config.debugging
|
469
469
|
@api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v3 ...'
|
@@ -507,7 +507,7 @@ module VeloPayments
|
|
507
507
|
post_body = opts[:debug_body]
|
508
508
|
|
509
509
|
# return_type
|
510
|
-
return_type = opts[:debug_return_type] || '
|
510
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeResponseV3'
|
511
511
|
|
512
512
|
# auth_names
|
513
513
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -533,19 +533,19 @@ module VeloPayments
|
|
533
533
|
# Get a paginated response listing the payees for a payor.
|
534
534
|
# @param payor_id [String] The account owner Payor ID
|
535
535
|
# @param [Hash] opts the optional parameters
|
536
|
-
# @option opts [
|
536
|
+
# @option opts [String] :watchlist_status The watchlistStatus of the payees.
|
537
537
|
# @option opts [Boolean] :disabled Payee disabled
|
538
|
-
# @option opts [
|
538
|
+
# @option opts [String] :onboarded_status The onboarded status of the payees.
|
539
539
|
# @option opts [String] :email Email address
|
540
540
|
# @option opts [String] :display_name The display name of the payees.
|
541
541
|
# @option opts [String] :remote_id The remote id of the payees.
|
542
|
-
# @option opts [
|
542
|
+
# @option opts [String] :payee_type The onboarded status of the payees.
|
543
543
|
# @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
544
|
-
# @option opts [
|
544
|
+
# @option opts [String] :ofac_status The ofacStatus of the payees.
|
545
545
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
546
546
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
547
547
|
# @option opts [String] :sort 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. (default to 'displayName:asc')
|
548
|
-
# @return [
|
548
|
+
# @return [PagedPayeeResponseV4]
|
549
549
|
def list_payees_v4(payor_id, opts = {})
|
550
550
|
data, _status_code, _headers = list_payees_v4_with_http_info(payor_id, opts)
|
551
551
|
data
|
@@ -555,19 +555,19 @@ module VeloPayments
|
|
555
555
|
# Get a paginated response listing the payees for a payor.
|
556
556
|
# @param payor_id [String] The account owner Payor ID
|
557
557
|
# @param [Hash] opts the optional parameters
|
558
|
-
# @option opts [
|
558
|
+
# @option opts [String] :watchlist_status The watchlistStatus of the payees.
|
559
559
|
# @option opts [Boolean] :disabled Payee disabled
|
560
|
-
# @option opts [
|
560
|
+
# @option opts [String] :onboarded_status The onboarded status of the payees.
|
561
561
|
# @option opts [String] :email Email address
|
562
562
|
# @option opts [String] :display_name The display name of the payees.
|
563
563
|
# @option opts [String] :remote_id The remote id of the payees.
|
564
|
-
# @option opts [
|
564
|
+
# @option opts [String] :payee_type The onboarded status of the payees.
|
565
565
|
# @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
566
|
-
# @option opts [
|
567
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
568
|
-
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
569
|
-
# @option opts [String] :sort 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.
|
570
|
-
# @return [Array<(
|
566
|
+
# @option opts [String] :ofac_status The ofacStatus of the payees.
|
567
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
568
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
569
|
+
# @option opts [String] :sort 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. (default to 'displayName:asc')
|
570
|
+
# @return [Array<(PagedPayeeResponseV4, Integer, Hash)>] PagedPayeeResponseV4 data, response status code and response headers
|
571
571
|
def list_payees_v4_with_http_info(payor_id, opts = {})
|
572
572
|
if @api_client.config.debugging
|
573
573
|
@api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v4 ...'
|
@@ -612,7 +612,7 @@ module VeloPayments
|
|
612
612
|
post_body = opts[:debug_body]
|
613
613
|
|
614
614
|
# return_type
|
615
|
-
return_type = opts[:debug_return_type] || '
|
615
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeResponseV4'
|
616
616
|
|
617
617
|
# auth_names
|
618
618
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
@@ -637,21 +637,21 @@ module VeloPayments
|
|
637
637
|
# Update Payee Details
|
638
638
|
# <p>Use v4 instead</p> <p>Update payee details for the given Payee Id.<p>
|
639
639
|
# @param payee_id [String] The UUID of the payee.
|
640
|
-
# @param
|
640
|
+
# @param update_payee_details_request_v3 [UpdatePayeeDetailsRequestV3] Request to update payee details
|
641
641
|
# @param [Hash] opts the optional parameters
|
642
642
|
# @return [nil]
|
643
|
-
def payee_details_update_v3(payee_id,
|
644
|
-
payee_details_update_v3_with_http_info(payee_id,
|
643
|
+
def payee_details_update_v3(payee_id, update_payee_details_request_v3, opts = {})
|
644
|
+
payee_details_update_v3_with_http_info(payee_id, update_payee_details_request_v3, opts)
|
645
645
|
nil
|
646
646
|
end
|
647
647
|
|
648
648
|
# Update Payee Details
|
649
649
|
# <p>Use v4 instead</p> <p>Update payee details for the given Payee Id.<p>
|
650
650
|
# @param payee_id [String] The UUID of the payee.
|
651
|
-
# @param
|
651
|
+
# @param update_payee_details_request_v3 [UpdatePayeeDetailsRequestV3] Request to update payee details
|
652
652
|
# @param [Hash] opts the optional parameters
|
653
653
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
654
|
-
def payee_details_update_v3_with_http_info(payee_id,
|
654
|
+
def payee_details_update_v3_with_http_info(payee_id, update_payee_details_request_v3, opts = {})
|
655
655
|
if @api_client.config.debugging
|
656
656
|
@api_client.config.logger.debug 'Calling API: PayeesApi.payee_details_update_v3 ...'
|
657
657
|
end
|
@@ -659,9 +659,9 @@ module VeloPayments
|
|
659
659
|
if @api_client.config.client_side_validation && payee_id.nil?
|
660
660
|
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.payee_details_update_v3"
|
661
661
|
end
|
662
|
-
# verify the required parameter '
|
663
|
-
if @api_client.config.client_side_validation &&
|
664
|
-
fail ArgumentError, "Missing the required parameter '
|
662
|
+
# verify the required parameter 'update_payee_details_request_v3' is set
|
663
|
+
if @api_client.config.client_side_validation && update_payee_details_request_v3.nil?
|
664
|
+
fail ArgumentError, "Missing the required parameter 'update_payee_details_request_v3' when calling PayeesApi.payee_details_update_v3"
|
665
665
|
end
|
666
666
|
# resource path
|
667
667
|
local_var_path = '/v3/payees/{payeeId}/payeeDetailsUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
@@ -674,13 +674,16 @@ module VeloPayments
|
|
674
674
|
# HTTP header 'Accept' (if needed)
|
675
675
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
676
676
|
# HTTP header 'Content-Type'
|
677
|
-
|
677
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
678
|
+
if !content_type.nil?
|
679
|
+
header_params['Content-Type'] = content_type
|
680
|
+
end
|
678
681
|
|
679
682
|
# form parameters
|
680
683
|
form_params = opts[:form_params] || {}
|
681
684
|
|
682
685
|
# http body (model)
|
683
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
686
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_payee_details_request_v3)
|
684
687
|
|
685
688
|
# return_type
|
686
689
|
return_type = opts[:debug_return_type]
|
@@ -706,23 +709,23 @@ module VeloPayments
|
|
706
709
|
end
|
707
710
|
|
708
711
|
# Update Payee Details
|
709
|
-
# <p>Update payee details for the given Payee Id
|
712
|
+
# <p>Update payee details for the given Payee Id.</p> <p>Payors may only update the payee details if the payee has not yet onboarded</p>
|
710
713
|
# @param payee_id [String] The UUID of the payee.
|
711
|
-
# @param
|
714
|
+
# @param update_payee_details_request_v4 [UpdatePayeeDetailsRequestV4] Request to update payee details
|
712
715
|
# @param [Hash] opts the optional parameters
|
713
716
|
# @return [nil]
|
714
|
-
def payee_details_update_v4(payee_id,
|
715
|
-
payee_details_update_v4_with_http_info(payee_id,
|
717
|
+
def payee_details_update_v4(payee_id, update_payee_details_request_v4, opts = {})
|
718
|
+
payee_details_update_v4_with_http_info(payee_id, update_payee_details_request_v4, opts)
|
716
719
|
nil
|
717
720
|
end
|
718
721
|
|
719
722
|
# Update Payee Details
|
720
|
-
# <p>Update payee details for the given Payee Id.<p>
|
723
|
+
# <p>Update payee details for the given Payee Id.</p> <p>Payors may only update the payee details if the payee has not yet onboarded</p>
|
721
724
|
# @param payee_id [String] The UUID of the payee.
|
722
|
-
# @param
|
725
|
+
# @param update_payee_details_request_v4 [UpdatePayeeDetailsRequestV4] Request to update payee details
|
723
726
|
# @param [Hash] opts the optional parameters
|
724
727
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
725
|
-
def payee_details_update_v4_with_http_info(payee_id,
|
728
|
+
def payee_details_update_v4_with_http_info(payee_id, update_payee_details_request_v4, opts = {})
|
726
729
|
if @api_client.config.debugging
|
727
730
|
@api_client.config.logger.debug 'Calling API: PayeesApi.payee_details_update_v4 ...'
|
728
731
|
end
|
@@ -730,9 +733,9 @@ module VeloPayments
|
|
730
733
|
if @api_client.config.client_side_validation && payee_id.nil?
|
731
734
|
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.payee_details_update_v4"
|
732
735
|
end
|
733
|
-
# verify the required parameter '
|
734
|
-
if @api_client.config.client_side_validation &&
|
735
|
-
fail ArgumentError, "Missing the required parameter '
|
736
|
+
# verify the required parameter 'update_payee_details_request_v4' is set
|
737
|
+
if @api_client.config.client_side_validation && update_payee_details_request_v4.nil?
|
738
|
+
fail ArgumentError, "Missing the required parameter 'update_payee_details_request_v4' when calling PayeesApi.payee_details_update_v4"
|
736
739
|
end
|
737
740
|
# resource path
|
738
741
|
local_var_path = '/v4/payees/{payeeId}/payeeDetailsUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
@@ -745,13 +748,16 @@ module VeloPayments
|
|
745
748
|
# HTTP header 'Accept' (if needed)
|
746
749
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
747
750
|
# HTTP header 'Content-Type'
|
748
|
-
|
751
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
752
|
+
if !content_type.nil?
|
753
|
+
header_params['Content-Type'] = content_type
|
754
|
+
end
|
749
755
|
|
750
756
|
# form parameters
|
751
757
|
form_params = opts[:form_params] || {}
|
752
758
|
|
753
759
|
# http body (model)
|
754
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
760
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_payee_details_request_v4)
|
755
761
|
|
756
762
|
# return_type
|
757
763
|
return_type = opts[:debug_return_type]
|
@@ -779,21 +785,21 @@ module VeloPayments
|
|
779
785
|
# Update Payee Remote Id
|
780
786
|
# <p>Use v4 instead</p> <p>Update the remote Id for the given Payee Id.</p>
|
781
787
|
# @param payee_id [String] The UUID of the payee.
|
782
|
-
# @param
|
788
|
+
# @param update_remote_id_request_v3 [UpdateRemoteIdRequestV3] Request to update payee remote id v3
|
783
789
|
# @param [Hash] opts the optional parameters
|
784
790
|
# @return [nil]
|
785
|
-
def v3_payees_payee_id_remote_id_update_post(payee_id,
|
786
|
-
v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id,
|
791
|
+
def v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request_v3, opts = {})
|
792
|
+
v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request_v3, opts)
|
787
793
|
nil
|
788
794
|
end
|
789
795
|
|
790
796
|
# Update Payee Remote Id
|
791
797
|
# <p>Use v4 instead</p> <p>Update the remote Id for the given Payee Id.</p>
|
792
798
|
# @param payee_id [String] The UUID of the payee.
|
793
|
-
# @param
|
799
|
+
# @param update_remote_id_request_v3 [UpdateRemoteIdRequestV3] Request to update payee remote id v3
|
794
800
|
# @param [Hash] opts the optional parameters
|
795
801
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
796
|
-
def v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id,
|
802
|
+
def v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request_v3, opts = {})
|
797
803
|
if @api_client.config.debugging
|
798
804
|
@api_client.config.logger.debug 'Calling API: PayeesApi.v3_payees_payee_id_remote_id_update_post ...'
|
799
805
|
end
|
@@ -801,9 +807,9 @@ module VeloPayments
|
|
801
807
|
if @api_client.config.client_side_validation && payee_id.nil?
|
802
808
|
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
|
803
809
|
end
|
804
|
-
# verify the required parameter '
|
805
|
-
if @api_client.config.client_side_validation &&
|
806
|
-
fail ArgumentError, "Missing the required parameter '
|
810
|
+
# verify the required parameter 'update_remote_id_request_v3' is set
|
811
|
+
if @api_client.config.client_side_validation && update_remote_id_request_v3.nil?
|
812
|
+
fail ArgumentError, "Missing the required parameter 'update_remote_id_request_v3' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
|
807
813
|
end
|
808
814
|
# resource path
|
809
815
|
local_var_path = '/v3/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
@@ -816,13 +822,16 @@ module VeloPayments
|
|
816
822
|
# HTTP header 'Accept' (if needed)
|
817
823
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
818
824
|
# HTTP header 'Content-Type'
|
819
|
-
|
825
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
826
|
+
if !content_type.nil?
|
827
|
+
header_params['Content-Type'] = content_type
|
828
|
+
end
|
820
829
|
|
821
830
|
# form parameters
|
822
831
|
form_params = opts[:form_params] || {}
|
823
832
|
|
824
833
|
# http body (model)
|
825
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
834
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_remote_id_request_v3)
|
826
835
|
|
827
836
|
# return_type
|
828
837
|
return_type = opts[:debug_return_type]
|
@@ -850,21 +859,21 @@ module VeloPayments
|
|
850
859
|
# Update Payee Remote Id
|
851
860
|
# <p>Update the remote Id for the given Payee Id.</p>
|
852
861
|
# @param payee_id [String] The UUID of the payee.
|
853
|
-
# @param
|
862
|
+
# @param update_remote_id_request_v4 [UpdateRemoteIdRequestV4] Request to update payee remote id v4
|
854
863
|
# @param [Hash] opts the optional parameters
|
855
864
|
# @return [nil]
|
856
|
-
def v4_payees_payee_id_remote_id_update_post(payee_id,
|
857
|
-
v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id,
|
865
|
+
def v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request_v4, opts = {})
|
866
|
+
v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request_v4, opts)
|
858
867
|
nil
|
859
868
|
end
|
860
869
|
|
861
870
|
# Update Payee Remote Id
|
862
871
|
# <p>Update the remote Id for the given Payee Id.</p>
|
863
872
|
# @param payee_id [String] The UUID of the payee.
|
864
|
-
# @param
|
873
|
+
# @param update_remote_id_request_v4 [UpdateRemoteIdRequestV4] Request to update payee remote id v4
|
865
874
|
# @param [Hash] opts the optional parameters
|
866
875
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
867
|
-
def v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id,
|
876
|
+
def v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request_v4, opts = {})
|
868
877
|
if @api_client.config.debugging
|
869
878
|
@api_client.config.logger.debug 'Calling API: PayeesApi.v4_payees_payee_id_remote_id_update_post ...'
|
870
879
|
end
|
@@ -872,9 +881,9 @@ module VeloPayments
|
|
872
881
|
if @api_client.config.client_side_validation && payee_id.nil?
|
873
882
|
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v4_payees_payee_id_remote_id_update_post"
|
874
883
|
end
|
875
|
-
# verify the required parameter '
|
876
|
-
if @api_client.config.client_side_validation &&
|
877
|
-
fail ArgumentError, "Missing the required parameter '
|
884
|
+
# verify the required parameter 'update_remote_id_request_v4' is set
|
885
|
+
if @api_client.config.client_side_validation && update_remote_id_request_v4.nil?
|
886
|
+
fail ArgumentError, "Missing the required parameter 'update_remote_id_request_v4' when calling PayeesApi.v4_payees_payee_id_remote_id_update_post"
|
878
887
|
end
|
879
888
|
# resource path
|
880
889
|
local_var_path = '/v4/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
@@ -887,13 +896,16 @@ module VeloPayments
|
|
887
896
|
# HTTP header 'Accept' (if needed)
|
888
897
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
889
898
|
# HTTP header 'Content-Type'
|
890
|
-
|
899
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
900
|
+
if !content_type.nil?
|
901
|
+
header_params['Content-Type'] = content_type
|
902
|
+
end
|
891
903
|
|
892
904
|
# form parameters
|
893
905
|
form_params = opts[:form_params] || {}
|
894
906
|
|
895
907
|
# http body (model)
|
896
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
908
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_remote_id_request_v4)
|
897
909
|
|
898
910
|
# return_type
|
899
911
|
return_type = opts[:debug_return_type]
|