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,17 +3,17 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.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
|
|
13
13
|
require 'cgi'
|
14
14
|
|
15
15
|
module VeloPayments
|
16
|
-
class
|
16
|
+
class PayoutsApi
|
17
17
|
attr_accessor :api_client
|
18
18
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
@@ -36,11 +36,11 @@ module VeloPayments
|
|
36
36
|
# @return [Array<(QuoteResponseV3, Integer, Hash)>] QuoteResponseV3 data, response status code and response headers
|
37
37
|
def create_quote_for_payout_v3_with_http_info(payout_id, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API:
|
39
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.create_quote_for_payout_v3 ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'payout_id' is set
|
42
42
|
if @api_client.config.client_side_validation && payout_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling
|
43
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.create_quote_for_payout_v3"
|
44
44
|
end
|
45
45
|
# resource path
|
46
46
|
local_var_path = '/v3/payouts/{payoutId}/quote'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -66,7 +66,7 @@ module VeloPayments
|
|
66
66
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
67
67
|
|
68
68
|
new_options = opts.merge(
|
69
|
-
:operation => :"
|
69
|
+
:operation => :"PayoutsApi.create_quote_for_payout_v3",
|
70
70
|
:header_params => header_params,
|
71
71
|
:query_params => query_params,
|
72
72
|
:form_params => form_params,
|
@@ -77,7 +77,70 @@ module VeloPayments
|
|
77
77
|
|
78
78
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
79
79
|
if @api_client.config.debugging
|
80
|
-
@api_client.config.logger.debug "API called:
|
80
|
+
@api_client.config.logger.debug "API called: PayoutsApi#create_quote_for_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# Deschedule a payout
|
86
|
+
# Remove the schedule for a scheduled payout
|
87
|
+
# @param payout_id [String] Id of the payout
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @return [nil]
|
90
|
+
def deschedule_payout(payout_id, opts = {})
|
91
|
+
deschedule_payout_with_http_info(payout_id, opts)
|
92
|
+
nil
|
93
|
+
end
|
94
|
+
|
95
|
+
# Deschedule a payout
|
96
|
+
# Remove the schedule for a scheduled payout
|
97
|
+
# @param payout_id [String] Id of the payout
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
100
|
+
def deschedule_payout_with_http_info(payout_id, opts = {})
|
101
|
+
if @api_client.config.debugging
|
102
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.deschedule_payout ...'
|
103
|
+
end
|
104
|
+
# verify the required parameter 'payout_id' is set
|
105
|
+
if @api_client.config.client_side_validation && payout_id.nil?
|
106
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.deschedule_payout"
|
107
|
+
end
|
108
|
+
# resource path
|
109
|
+
local_var_path = '/v3/payouts/{payoutId}/schedule'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
110
|
+
|
111
|
+
# query parameters
|
112
|
+
query_params = opts[:query_params] || {}
|
113
|
+
|
114
|
+
# header parameters
|
115
|
+
header_params = opts[:header_params] || {}
|
116
|
+
# HTTP header 'Accept' (if needed)
|
117
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
118
|
+
|
119
|
+
# form parameters
|
120
|
+
form_params = opts[:form_params] || {}
|
121
|
+
|
122
|
+
# http body (model)
|
123
|
+
post_body = opts[:debug_body]
|
124
|
+
|
125
|
+
# return_type
|
126
|
+
return_type = opts[:debug_return_type]
|
127
|
+
|
128
|
+
# auth_names
|
129
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
130
|
+
|
131
|
+
new_options = opts.merge(
|
132
|
+
:operation => :"PayoutsApi.deschedule_payout",
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names,
|
138
|
+
:return_type => return_type
|
139
|
+
)
|
140
|
+
|
141
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
142
|
+
if @api_client.config.debugging
|
143
|
+
@api_client.config.logger.debug "API called: PayoutsApi#deschedule_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
144
|
end
|
82
145
|
return data, status_code, headers
|
83
146
|
end
|
@@ -110,16 +173,16 @@ module VeloPayments
|
|
110
173
|
# @option opts [String] :source_account_name Physical Account Name
|
111
174
|
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
112
175
|
# @option opts [String] :payment_memo Payment Memo of the Payment
|
113
|
-
# @option opts [Integer] :page_size The number of results to return in a page
|
114
|
-
# @option opts [Integer] :page Page number. Default is 1.
|
176
|
+
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
177
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
115
178
|
# @return [Array<(PagedPaymentsResponseV3, Integer, Hash)>] PagedPaymentsResponseV3 data, response status code and response headers
|
116
179
|
def get_payments_for_payout_v3_with_http_info(payout_id, opts = {})
|
117
180
|
if @api_client.config.debugging
|
118
|
-
@api_client.config.logger.debug 'Calling API:
|
181
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.get_payments_for_payout_v3 ...'
|
119
182
|
end
|
120
183
|
# verify the required parameter 'payout_id' is set
|
121
184
|
if @api_client.config.client_side_validation && payout_id.nil?
|
122
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling
|
185
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.get_payments_for_payout_v3"
|
123
186
|
end
|
124
187
|
allowable_values = ["ACCEPTED", "REJECTED", "WITHDRAWN", "WITHDRAWABLE"]
|
125
188
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
@@ -130,11 +193,11 @@ module VeloPayments
|
|
130
193
|
fail ArgumentError, "invalid value for \"transmission_type\", must be one of #{allowable_values}"
|
131
194
|
end
|
132
195
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
133
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling
|
196
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PayoutsApi.get_payments_for_payout_v3, must be smaller than or equal to 100.'
|
134
197
|
end
|
135
198
|
|
136
199
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
137
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling
|
200
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PayoutsApi.get_payments_for_payout_v3, must be greater than or equal to 1.'
|
138
201
|
end
|
139
202
|
|
140
203
|
# resource path
|
@@ -169,7 +232,7 @@ module VeloPayments
|
|
169
232
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
170
233
|
|
171
234
|
new_options = opts.merge(
|
172
|
-
:operation => :"
|
235
|
+
:operation => :"PayoutsApi.get_payments_for_payout_v3",
|
173
236
|
:header_params => header_params,
|
174
237
|
:query_params => query_params,
|
175
238
|
:form_params => form_params,
|
@@ -180,7 +243,7 @@ module VeloPayments
|
|
180
243
|
|
181
244
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
182
245
|
if @api_client.config.debugging
|
183
|
-
@api_client.config.logger.debug "API called:
|
246
|
+
@api_client.config.logger.debug "API called: PayoutsApi#get_payments_for_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
184
247
|
end
|
185
248
|
return data, status_code, headers
|
186
249
|
end
|
@@ -202,11 +265,11 @@ module VeloPayments
|
|
202
265
|
# @return [Array<(PayoutSummaryResponseV3, Integer, Hash)>] PayoutSummaryResponseV3 data, response status code and response headers
|
203
266
|
def get_payout_summary_v3_with_http_info(payout_id, opts = {})
|
204
267
|
if @api_client.config.debugging
|
205
|
-
@api_client.config.logger.debug 'Calling API:
|
268
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.get_payout_summary_v3 ...'
|
206
269
|
end
|
207
270
|
# verify the required parameter 'payout_id' is set
|
208
271
|
if @api_client.config.client_side_validation && payout_id.nil?
|
209
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling
|
272
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.get_payout_summary_v3"
|
210
273
|
end
|
211
274
|
# resource path
|
212
275
|
local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -232,7 +295,7 @@ module VeloPayments
|
|
232
295
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
233
296
|
|
234
297
|
new_options = opts.merge(
|
235
|
-
:operation => :"
|
298
|
+
:operation => :"PayoutsApi.get_payout_summary_v3",
|
236
299
|
:header_params => header_params,
|
237
300
|
:query_params => query_params,
|
238
301
|
:form_params => form_params,
|
@@ -243,7 +306,7 @@ module VeloPayments
|
|
243
306
|
|
244
307
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
245
308
|
if @api_client.config.debugging
|
246
|
-
@api_client.config.logger.debug "API called:
|
309
|
+
@api_client.config.logger.debug "API called: PayoutsApi#get_payout_summary_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
247
310
|
end
|
248
311
|
return data, status_code, headers
|
249
312
|
end
|
@@ -252,6 +315,7 @@ module VeloPayments
|
|
252
315
|
# Instruct a payout to be made for the specified payoutId.
|
253
316
|
# @param payout_id [String] Id of the payout
|
254
317
|
# @param [Hash] opts the optional parameters
|
318
|
+
# @option opts [InstructPayoutRequestV3] :instruct_payout_request_v3 Additional instruct payout parameters
|
255
319
|
# @return [nil]
|
256
320
|
def instruct_payout_v3(payout_id, opts = {})
|
257
321
|
instruct_payout_v3_with_http_info(payout_id, opts)
|
@@ -262,14 +326,15 @@ module VeloPayments
|
|
262
326
|
# Instruct a payout to be made for the specified payoutId.
|
263
327
|
# @param payout_id [String] Id of the payout
|
264
328
|
# @param [Hash] opts the optional parameters
|
329
|
+
# @option opts [InstructPayoutRequestV3] :instruct_payout_request_v3 Additional instruct payout parameters
|
265
330
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
266
331
|
def instruct_payout_v3_with_http_info(payout_id, opts = {})
|
267
332
|
if @api_client.config.debugging
|
268
|
-
@api_client.config.logger.debug 'Calling API:
|
333
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.instruct_payout_v3 ...'
|
269
334
|
end
|
270
335
|
# verify the required parameter 'payout_id' is set
|
271
336
|
if @api_client.config.client_side_validation && payout_id.nil?
|
272
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling
|
337
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.instruct_payout_v3"
|
273
338
|
end
|
274
339
|
# resource path
|
275
340
|
local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -281,12 +346,87 @@ module VeloPayments
|
|
281
346
|
header_params = opts[:header_params] || {}
|
282
347
|
# HTTP header 'Accept' (if needed)
|
283
348
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
|
+
# HTTP header 'Content-Type'
|
350
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
351
|
+
if !content_type.nil?
|
352
|
+
header_params['Content-Type'] = content_type
|
353
|
+
end
|
354
|
+
|
355
|
+
# form parameters
|
356
|
+
form_params = opts[:form_params] || {}
|
357
|
+
|
358
|
+
# http body (model)
|
359
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'instruct_payout_request_v3'])
|
360
|
+
|
361
|
+
# return_type
|
362
|
+
return_type = opts[:debug_return_type]
|
363
|
+
|
364
|
+
# auth_names
|
365
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
366
|
+
|
367
|
+
new_options = opts.merge(
|
368
|
+
:operation => :"PayoutsApi.instruct_payout_v3",
|
369
|
+
:header_params => header_params,
|
370
|
+
:query_params => query_params,
|
371
|
+
:form_params => form_params,
|
372
|
+
:body => post_body,
|
373
|
+
:auth_names => auth_names,
|
374
|
+
:return_type => return_type
|
375
|
+
)
|
376
|
+
|
377
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
378
|
+
if @api_client.config.debugging
|
379
|
+
@api_client.config.logger.debug "API called: PayoutsApi#instruct_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
380
|
+
end
|
381
|
+
return data, status_code, headers
|
382
|
+
end
|
383
|
+
|
384
|
+
# Schedule a payout
|
385
|
+
# <p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p>
|
386
|
+
# @param payout_id [String] Id of the payout
|
387
|
+
# @param [Hash] opts the optional parameters
|
388
|
+
# @option opts [SchedulePayoutRequestV3] :schedule_payout_request_v3 schedule payout parameters
|
389
|
+
# @return [nil]
|
390
|
+
def schedule_for_payout(payout_id, opts = {})
|
391
|
+
schedule_for_payout_with_http_info(payout_id, opts)
|
392
|
+
nil
|
393
|
+
end
|
394
|
+
|
395
|
+
# Schedule a payout
|
396
|
+
# <p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p>
|
397
|
+
# @param payout_id [String] Id of the payout
|
398
|
+
# @param [Hash] opts the optional parameters
|
399
|
+
# @option opts [SchedulePayoutRequestV3] :schedule_payout_request_v3 schedule payout parameters
|
400
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
401
|
+
def schedule_for_payout_with_http_info(payout_id, opts = {})
|
402
|
+
if @api_client.config.debugging
|
403
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.schedule_for_payout ...'
|
404
|
+
end
|
405
|
+
# verify the required parameter 'payout_id' is set
|
406
|
+
if @api_client.config.client_side_validation && payout_id.nil?
|
407
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.schedule_for_payout"
|
408
|
+
end
|
409
|
+
# resource path
|
410
|
+
local_var_path = '/v3/payouts/{payoutId}/schedule'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
411
|
+
|
412
|
+
# query parameters
|
413
|
+
query_params = opts[:query_params] || {}
|
414
|
+
|
415
|
+
# header parameters
|
416
|
+
header_params = opts[:header_params] || {}
|
417
|
+
# HTTP header 'Accept' (if needed)
|
418
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
419
|
+
# HTTP header 'Content-Type'
|
420
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
421
|
+
if !content_type.nil?
|
422
|
+
header_params['Content-Type'] = content_type
|
423
|
+
end
|
284
424
|
|
285
425
|
# form parameters
|
286
426
|
form_params = opts[:form_params] || {}
|
287
427
|
|
288
428
|
# http body (model)
|
289
|
-
post_body = opts[:debug_body]
|
429
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'schedule_payout_request_v3'])
|
290
430
|
|
291
431
|
# return_type
|
292
432
|
return_type = opts[:debug_return_type]
|
@@ -295,7 +435,7 @@ module VeloPayments
|
|
295
435
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
296
436
|
|
297
437
|
new_options = opts.merge(
|
298
|
-
:operation => :"
|
438
|
+
:operation => :"PayoutsApi.schedule_for_payout",
|
299
439
|
:header_params => header_params,
|
300
440
|
:query_params => query_params,
|
301
441
|
:form_params => form_params,
|
@@ -306,13 +446,13 @@ module VeloPayments
|
|
306
446
|
|
307
447
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
308
448
|
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug "API called:
|
449
|
+
@api_client.config.logger.debug "API called: PayoutsApi#schedule_for_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
450
|
end
|
311
451
|
return data, status_code, headers
|
312
452
|
end
|
313
453
|
|
314
454
|
# Submit Payout
|
315
|
-
# <p>Create a new payout and return a location header with a link to
|
455
|
+
# <p>Create a new payout and return a location header with a link to the payout</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p>
|
316
456
|
# @param create_payout_request_v3 [CreatePayoutRequestV3] Post amount to transfer using stored funding account details.
|
317
457
|
# @param [Hash] opts the optional parameters
|
318
458
|
# @return [nil]
|
@@ -322,17 +462,17 @@ module VeloPayments
|
|
322
462
|
end
|
323
463
|
|
324
464
|
# Submit Payout
|
325
|
-
# <p>Create a new payout and return a location header with a link to
|
465
|
+
# <p>Create a new payout and return a location header with a link to the payout</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p>
|
326
466
|
# @param create_payout_request_v3 [CreatePayoutRequestV3] Post amount to transfer using stored funding account details.
|
327
467
|
# @param [Hash] opts the optional parameters
|
328
468
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
329
469
|
def submit_payout_v3_with_http_info(create_payout_request_v3, opts = {})
|
330
470
|
if @api_client.config.debugging
|
331
|
-
@api_client.config.logger.debug 'Calling API:
|
471
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.submit_payout_v3 ...'
|
332
472
|
end
|
333
473
|
# verify the required parameter 'create_payout_request_v3' is set
|
334
474
|
if @api_client.config.client_side_validation && create_payout_request_v3.nil?
|
335
|
-
fail ArgumentError, "Missing the required parameter 'create_payout_request_v3' when calling
|
475
|
+
fail ArgumentError, "Missing the required parameter 'create_payout_request_v3' when calling PayoutsApi.submit_payout_v3"
|
336
476
|
end
|
337
477
|
# resource path
|
338
478
|
local_var_path = '/v3/payouts'
|
@@ -345,7 +485,10 @@ module VeloPayments
|
|
345
485
|
# HTTP header 'Accept' (if needed)
|
346
486
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
347
487
|
# HTTP header 'Content-Type'
|
348
|
-
|
488
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
489
|
+
if !content_type.nil?
|
490
|
+
header_params['Content-Type'] = content_type
|
491
|
+
end
|
349
492
|
|
350
493
|
# form parameters
|
351
494
|
form_params = opts[:form_params] || {}
|
@@ -360,7 +503,7 @@ module VeloPayments
|
|
360
503
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
361
504
|
|
362
505
|
new_options = opts.merge(
|
363
|
-
:operation => :"
|
506
|
+
:operation => :"PayoutsApi.submit_payout_v3",
|
364
507
|
:header_params => header_params,
|
365
508
|
:query_params => query_params,
|
366
509
|
:form_params => form_params,
|
@@ -371,7 +514,7 @@ module VeloPayments
|
|
371
514
|
|
372
515
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
373
516
|
if @api_client.config.debugging
|
374
|
-
@api_client.config.logger.debug "API called:
|
517
|
+
@api_client.config.logger.debug "API called: PayoutsApi#submit_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
375
518
|
end
|
376
519
|
return data, status_code, headers
|
377
520
|
end
|
@@ -395,15 +538,15 @@ module VeloPayments
|
|
395
538
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
396
539
|
def withdraw_payment_with_http_info(payment_id, withdraw_payment_request, opts = {})
|
397
540
|
if @api_client.config.debugging
|
398
|
-
@api_client.config.logger.debug 'Calling API:
|
541
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.withdraw_payment ...'
|
399
542
|
end
|
400
543
|
# verify the required parameter 'payment_id' is set
|
401
544
|
if @api_client.config.client_side_validation && payment_id.nil?
|
402
|
-
fail ArgumentError, "Missing the required parameter 'payment_id' when calling
|
545
|
+
fail ArgumentError, "Missing the required parameter 'payment_id' when calling PayoutsApi.withdraw_payment"
|
403
546
|
end
|
404
547
|
# verify the required parameter 'withdraw_payment_request' is set
|
405
548
|
if @api_client.config.client_side_validation && withdraw_payment_request.nil?
|
406
|
-
fail ArgumentError, "Missing the required parameter 'withdraw_payment_request' when calling
|
549
|
+
fail ArgumentError, "Missing the required parameter 'withdraw_payment_request' when calling PayoutsApi.withdraw_payment"
|
407
550
|
end
|
408
551
|
# resource path
|
409
552
|
local_var_path = '/v1/payments/{paymentId}/withdraw'.sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s))
|
@@ -416,7 +559,10 @@ module VeloPayments
|
|
416
559
|
# HTTP header 'Accept' (if needed)
|
417
560
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
418
561
|
# HTTP header 'Content-Type'
|
419
|
-
|
562
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
563
|
+
if !content_type.nil?
|
564
|
+
header_params['Content-Type'] = content_type
|
565
|
+
end
|
420
566
|
|
421
567
|
# form parameters
|
422
568
|
form_params = opts[:form_params] || {}
|
@@ -431,7 +577,7 @@ module VeloPayments
|
|
431
577
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
432
578
|
|
433
579
|
new_options = opts.merge(
|
434
|
-
:operation => :"
|
580
|
+
:operation => :"PayoutsApi.withdraw_payment",
|
435
581
|
:header_params => header_params,
|
436
582
|
:query_params => query_params,
|
437
583
|
:form_params => form_params,
|
@@ -442,13 +588,13 @@ module VeloPayments
|
|
442
588
|
|
443
589
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
444
590
|
if @api_client.config.debugging
|
445
|
-
@api_client.config.logger.debug "API called:
|
591
|
+
@api_client.config.logger.debug "API called: PayoutsApi#withdraw_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
446
592
|
end
|
447
593
|
return data, status_code, headers
|
448
594
|
end
|
449
595
|
|
450
596
|
# Withdraw Payout
|
451
|
-
# Withdraw Payout will
|
597
|
+
# Withdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status.
|
452
598
|
# @param payout_id [String] Id of the payout
|
453
599
|
# @param [Hash] opts the optional parameters
|
454
600
|
# @return [nil]
|
@@ -458,17 +604,17 @@ module VeloPayments
|
|
458
604
|
end
|
459
605
|
|
460
606
|
# Withdraw Payout
|
461
|
-
# Withdraw Payout will
|
607
|
+
# Withdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status.
|
462
608
|
# @param payout_id [String] Id of the payout
|
463
609
|
# @param [Hash] opts the optional parameters
|
464
610
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
465
611
|
def withdraw_payout_v3_with_http_info(payout_id, opts = {})
|
466
612
|
if @api_client.config.debugging
|
467
|
-
@api_client.config.logger.debug 'Calling API:
|
613
|
+
@api_client.config.logger.debug 'Calling API: PayoutsApi.withdraw_payout_v3 ...'
|
468
614
|
end
|
469
615
|
# verify the required parameter 'payout_id' is set
|
470
616
|
if @api_client.config.client_side_validation && payout_id.nil?
|
471
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling
|
617
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutsApi.withdraw_payout_v3"
|
472
618
|
end
|
473
619
|
# resource path
|
474
620
|
local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -494,7 +640,7 @@ module VeloPayments
|
|
494
640
|
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
495
641
|
|
496
642
|
new_options = opts.merge(
|
497
|
-
:operation => :"
|
643
|
+
:operation => :"PayoutsApi.withdraw_payout_v3",
|
498
644
|
:header_params => header_params,
|
499
645
|
:query_params => query_params,
|
500
646
|
:form_params => form_params,
|
@@ -505,7 +651,7 @@ module VeloPayments
|
|
505
651
|
|
506
652
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
507
653
|
if @api_client.config.debugging
|
508
|
-
@api_client.config.logger.debug "API called:
|
654
|
+
@api_client.config.logger.debug "API called: PayoutsApi#withdraw_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
509
655
|
end
|
510
656
|
return data, status_code, headers
|
511
657
|
end
|