velopayments 2.23.78.beta1 → 2.26.124.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Makefile +2 -3
- data/README.md +61 -71
- data/docs/AcceptedPaymentV3.md +22 -17
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +14 -13
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +10 -9
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +74 -21
- data/docs/CreateFundingAccountRequestV2.md +20 -19
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +14 -15
- data/docs/CreateWebhookRequest.md +16 -13
- data/docs/CurrenciesApi.md +26 -9
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -25
- data/docs/FundingAccountResponse2.md +26 -25
- data/docs/FundingAccountType.md +4 -5
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +549 -259
- data/docs/FundingManagerPrivateApi.md +98 -13
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +10 -9
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +10 -9
- data/docs/GetPayeeListResponse.md +40 -39
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +10 -9
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +8 -7
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -43
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +12 -9
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +12 -9
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +4 -5
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +12 -11
- data/docs/ListPaymentsResponseV3.md +12 -11
- data/docs/ListPaymentsResponseV3Page.md +16 -15
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +10 -9
- data/docs/ListSourceAccountResponseV3.md +12 -11
- data/docs/ListSourceAccountResponseV3Links.md +10 -9
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +109 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +14 -13
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +8 -7
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +12 -11
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +64 -63
- data/docs/PayeeDetailResponse2.md +64 -63
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +216 -359
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeUserSelfUpdateRequest.md +18 -17
- data/docs/PayeesApi.md +346 -499
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +242 -631
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +24 -19
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +96 -85
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +32 -27
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorV1.md +50 -49
- data/docs/PayorV2.md +52 -49
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +8 -7
- data/docs/PayoutIndividualV3.md +8 -7
- data/docs/PayoutNameV3.md +10 -9
- data/docs/PayoutPayeeV3.md +12 -11
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +208 -88
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +26 -25
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +28 -27
- data/docs/QuoteResponseV3.md +8 -7
- data/docs/RegionV2.md +10 -9
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +28 -23
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -33
- data/docs/SourceAccountResponseV2.md +38 -37
- data/docs/SourceAccountResponseV3.md +42 -37
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +4 -5
- data/docs/SourceAccountV3.md +14 -13
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +8 -7
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +12 -11
- data/docs/SupportedCurrencyResponseV2.md +8 -7
- data/docs/SupportedCurrencyV2.md +10 -9
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +12 -11
- data/docs/TransmissionType.md +4 -5
- data/docs/TransmissionTypes.md +12 -11
- data/docs/TransmissionTypes2.md +12 -11
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +20 -19
- data/docs/UpdatePayeeDetailsRequest2.md +20 -19
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +14 -11
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +478 -189
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +4 -5
- data/docs/WebhookResponse.md +18 -15
- data/docs/WebhooksApi.md +109 -92
- data/docs/WebhooksResponse.md +12 -11
- data/docs/WithdrawPaymentRequest.md +8 -7
- data/lib/velopayments.rb +50 -48
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +5 -2
- data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +25 -358
- data/lib/velopayments/api/payees_api.rb +28 -468
- data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_service_api.rb +9 -2
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +2 -2
- data/lib/velopayments/api/webhooks_api.rb +2 -61
- data/lib/velopayments/api_client.rb +6 -5
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -7
- data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
- data/lib/velopayments/models/access_token_response.rb +12 -4
- data/lib/velopayments/models/access_token_validation_request.rb +12 -4
- data/lib/velopayments/models/auth_response.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
- data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
- data/lib/velopayments/models/challenge.rb +12 -4
- data/lib/velopayments/models/challenge2.rb +12 -4
- data/lib/velopayments/models/company.rb +12 -4
- data/lib/velopayments/models/company2.rb +12 -4
- data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
- data/lib/velopayments/models/create_individual.rb +13 -5
- data/lib/velopayments/models/create_individual2.rb +13 -5
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
- data/lib/velopayments/models/create_payee.rb +16 -7
- data/lib/velopayments/models/create_payee2.rb +15 -6
- data/lib/velopayments/models/create_payee_address.rb +45 -21
- data/lib/velopayments/models/create_payee_address2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
- data/lib/velopayments/models/create_payees_request.rb +12 -4
- data/lib/velopayments/models/create_payees_request2.rb +12 -4
- data/lib/velopayments/models/create_payment_channel.rb +12 -4
- data/lib/velopayments/models/create_payment_channel2.rb +12 -4
- data/lib/velopayments/models/create_payor_link_request.rb +12 -4
- data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
- data/lib/velopayments/models/create_webhook_request.rb +31 -8
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/error.rb +46 -10
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +41 -10
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +13 -5
- data/lib/velopayments/models/failed_submission2.rb +13 -5
- data/lib/velopayments/models/funding_account_response.rb +12 -4
- data/lib/velopayments/models/funding_account_response2.rb +12 -4
- data/lib/velopayments/models/funding_account_type.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +12 -4
- data/lib/velopayments/models/funding_event.rb +12 -4
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/funding_request_v1.rb +12 -4
- data/lib/velopayments/models/funding_request_v2.rb +12 -4
- data/lib/velopayments/models/funding_request_v3.rb +12 -4
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
- data/lib/velopayments/models/fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/get_fundings_response.rb +12 -4
- data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
- data/lib/velopayments/models/get_payee_list_response.rb +14 -5
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
- data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
- data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
- data/lib/velopayments/models/get_payout_statistics.rb +12 -4
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
- data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
- data/lib/velopayments/models/individual.rb +13 -5
- data/lib/velopayments/models/individual2.rb +13 -5
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
- data/lib/velopayments/models/inline_response400.rb +43 -10
- data/lib/velopayments/models/inline_response401.rb +43 -10
- data/lib/velopayments/models/inline_response403.rb +43 -10
- data/lib/velopayments/models/inline_response404.rb +43 -10
- data/lib/velopayments/models/inline_response409.rb +43 -10
- data/lib/velopayments/models/inline_response412.rb +43 -10
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status2.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +12 -4
- data/lib/velopayments/models/invite_payee_request2.rb +12 -4
- data/lib/velopayments/models/invite_user_request.rb +12 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/link_for_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
- data/lib/velopayments/models/list_source_account_response.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +12 -4
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/name.rb +12 -4
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
- data/lib/velopayments/models/notifications.rb +12 -4
- data/lib/velopayments/models/notifications2.rb +12 -4
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status2.rb +2 -2
- data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
- data/lib/velopayments/models/page_for_response.rb +12 -4
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response.rb +13 -5
- data/lib/velopayments/models/paged_payee_response2.rb +14 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
- data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/paged_user_response.rb +12 -4
- data/lib/velopayments/models/paged_user_response_links.rb +12 -4
- data/lib/velopayments/models/paged_user_response_page.rb +12 -4
- data/lib/velopayments/models/password_request.rb +12 -4
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +12 -4
- data/lib/velopayments/models/payee_address2.rb +12 -4
- data/lib/velopayments/models/payee_delta.rb +13 -5
- data/lib/velopayments/models/payee_delta2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
- data/lib/velopayments/models/payee_detail_response.rb +18 -9
- data/lib/velopayments/models/payee_detail_response2.rb +16 -7
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/payee_payor_ref.rb +58 -8
- data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +12 -4
- data/lib/velopayments/models/payment_channel_rule.rb +12 -4
- data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
- data/lib/velopayments/models/payment_delta.rb +12 -4
- data/lib/velopayments/models/payment_delta_response.rb +12 -4
- data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
- data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/payment_event_all_of.rb +243 -0
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
- data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
- data/lib/velopayments/models/payment_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_response_v4.rb +65 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/payment_v3.rb +34 -8
- data/lib/velopayments/models/payor_address.rb +12 -4
- data/lib/velopayments/models/payor_address_v2.rb +12 -4
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
- data/lib/velopayments/models/payor_branding_response.rb +12 -4
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
- data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
- data/lib/velopayments/models/payor_create_application_request.rb +12 -4
- data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
- data/lib/velopayments/models/payor_links_response.rb +12 -4
- data/lib/velopayments/models/payor_links_response_links.rb +12 -4
- data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
- data/lib/velopayments/models/payor_v1.rb +12 -4
- data/lib/velopayments/models/payor_v2.rb +28 -8
- data/lib/velopayments/models/payout_company_v3.rb +12 -4
- data/lib/velopayments/models/payout_individual_v3.rb +12 -4
- data/lib/velopayments/models/payout_name_v3.rb +12 -4
- data/lib/velopayments/models/payout_payee_v3.rb +12 -4
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
- data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
- data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
- data/lib/velopayments/models/query_batch_response.rb +12 -4
- data/lib/velopayments/models/query_batch_response2.rb +12 -4
- data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/quote_response_v3.rb +12 -4
- data/lib/velopayments/models/region_v2.rb +12 -4
- data/lib/velopayments/models/register_sms_request.rb +12 -4
- data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
- data/lib/velopayments/models/resend_token_request.rb +12 -4
- data/lib/velopayments/models/reset_password_request.rb +12 -4
- data/lib/velopayments/models/role.rb +12 -4
- data/lib/velopayments/models/role_update_request.rb +12 -4
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
- data/lib/velopayments/models/self_update_password_request.rb +12 -4
- data/lib/velopayments/models/set_notifications_request.rb +12 -4
- data/lib/velopayments/models/source_account_response.rb +12 -4
- data/lib/velopayments/models/source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/source_account_response_v3.rb +40 -12
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
- data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
- data/lib/velopayments/models/source_account_type.rb +2 -2
- data/lib/velopayments/models/source_account_v3.rb +12 -4
- data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
- data/lib/velopayments/models/supported_countries_response.rb +12 -4
- data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_country.rb +12 -4
- data/lib/velopayments/models/supported_country_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_v2.rb +12 -4
- data/lib/velopayments/models/transfer_request.rb +12 -4
- data/lib/velopayments/models/transfer_request2.rb +12 -4
- data/lib/velopayments/models/transmission_type.rb +2 -2
- data/lib/velopayments/models/transmission_types.rb +12 -4
- data/lib/velopayments/models/transmission_types2.rb +12 -4
- data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
- data/lib/velopayments/models/update_payee_details_request.rb +19 -10
- data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
- data/lib/velopayments/models/update_remote_id_request.rb +12 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
- data/lib/velopayments/models/update_webhook_request.rb +32 -8
- data/lib/velopayments/models/user_details_update_request.rb +12 -4
- data/lib/velopayments/models/user_info.rb +12 -4
- data/lib/velopayments/models/user_response.rb +27 -4
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +12 -4
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/models/watchlist_status2.rb +2 -2
- data/lib/velopayments/models/webhook_response.rb +27 -8
- data/lib/velopayments/models/webhooks_response.rb +12 -4
- data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +3 -2
- data/spec/api/funding_manager_private_api_spec.rb +14 -2
- data/spec/api/login_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +10 -75
- data/spec/api/payees_api_spec.rb +11 -99
- data/spec/api/payment_audit_service_api_spec.rb +9 -147
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +3 -2
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +2 -12
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +17 -12
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/auto_top_up_config2_spec.rb +5 -12
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/challenge2_spec.rb +5 -12
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/create_funding_account_request_v2_spec.rb +6 -13
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/create_payout_request_v3_spec.rb +5 -18
- data/spec/models/create_webhook_request_spec.rb +11 -12
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
- data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{ping_response_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +5 -12
- data/spec/models/funding_account_response_spec.rb +5 -12
- data/spec/models/funding_account_type_spec.rb +5 -12
- data/spec/models/funding_audit_spec.rb +8 -15
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +5 -12
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +5 -12
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_company_spec.rb +5 -12
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
- data/spec/models/get_payee_list_response_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +5 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/inline_response404_spec.rb +11 -12
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +11 -12
- data/spec/models/invitation_status2_spec.rb +5 -12
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_spec.rb +5 -12
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_spec.rb +5 -12
- data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +5 -12
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +5 -12
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{payee_payor_ref2_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/paged_payments_response_v3_spec.rb +5 -12
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/payee_detail_response2_spec.rb +5 -12
- data/spec/models/payee_detail_response_spec.rb +5 -12
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response401_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -12
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/payee_user_self_update_request_spec.rb +5 -12
- data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/{payment_delta_response_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
- data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
- data/spec/models/payment_instruction_v3_spec.rb +17 -12
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +37 -14
- data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
- data/spec/models/payment_v3_spec.rb +18 -13
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +6 -13
- data/spec/models/payor_v2_spec.rb +12 -13
- data/spec/models/payout_company_v3_spec.rb +5 -12
- data/spec/models/payout_individual_v3_spec.rb +5 -12
- data/spec/models/payout_name_v3_spec.rb +5 -12
- data/spec/models/payout_payee_v3_spec.rb +5 -12
- data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/payout_summary_response_v3_spec.rb +5 -12
- data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/quote_fx_summary_v3_spec.rb +7 -14
- data/spec/models/quote_response_v3_spec.rb +5 -12
- data/spec/models/region_v2_spec.rb +5 -12
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +17 -12
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +6 -13
- data/spec/models/source_account_response_v2_spec.rb +6 -13
- data/spec/models/source_account_response_v3_spec.rb +19 -14
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +5 -12
- data/spec/models/source_account_v3_spec.rb +5 -12
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +5 -12
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/supported_country_v2_spec.rb +5 -12
- data/spec/models/supported_currency_response_v2_spec.rb +5 -12
- data/spec/models/supported_currency_v2_spec.rb +5 -12
- data/spec/models/transfer_request2_spec.rb +5 -12
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +5 -12
- data/spec/models/transmission_types2_spec.rb +5 -12
- data/spec/models/transmission_types_spec.rb +5 -12
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +5 -12
- data/spec/models/update_payee_details_request_spec.rb +5 -12
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +11 -12
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +8 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +5 -12
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +11 -12
- data/spec/models/webhooks_response_spec.rb +5 -12
- data/spec/models/withdraw_payment_request_spec.rb +5 -12
- data/spec/spec_helper.rb +2 -2
- data/specs/api/payee_invitation_api_spec.rb +0 -42
- data/specs/api/payees_api_spec.rb +0 -99
- data/specs/api/payment_audit_service_api_spec.rb +0 -150
- data/velopayments.gemspec +2 -2
- metadata +194 -186
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InlineResponse404Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InlineResponse412Errors.md +0 -23
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRef2.md +0 -25
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeType2.md +0 -16
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentDeltaResponseV4.md +0 -21
- data/docs/PaymentDeltaV4.md +0 -31
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -47
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/PingResponse.md +0 -19
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
- data/lib/velopayments/models/inline_response401_errors.rb +0 -240
- data/lib/velopayments/models/inline_response409_errors.rb +0 -240
- data/lib/velopayments/models/inline_response412_errors.rb +0 -240
- data/lib/velopayments/models/language.rb +0 -46
- data/lib/velopayments/models/language2.rb +0 -46
- data/lib/velopayments/models/location_type.rb +0 -40
- data/lib/velopayments/models/ofac_status2.rb +0 -38
- data/lib/velopayments/models/payee2.rb +0 -460
- data/lib/velopayments/models/payee_payment_channel.rb +0 -455
- data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
- data/lib/velopayments/models/payee_response.rb +0 -392
- data/lib/velopayments/models/payee_response_v2.rb +0 -475
- data/lib/velopayments/models/payor_logo_request.rb +0 -210
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response404_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/inline_response412_errors_spec.rb +0 -59
- data/spec/models/location_type_spec.rb +0 -35
- data/spec/models/payee2_spec.rb +0 -165
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payee_response_spec.rb +0 -155
- data/spec/models/payee_response_v2_spec.rb +0 -209
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
data/docs/PayorsPrivateApi.md
CHANGED
|
@@ -2,10 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**create_payor_links**](PayorsPrivateApi.md#create_payor_links) | **POST** /v1/payorLinks | Create a Payor Link
|
|
8
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_payor_links**](PayorsPrivateApi.md#create_payor_links) | **POST** /v1/payorLinks | Create a Payor Link |
|
|
9
8
|
|
|
10
9
|
|
|
11
10
|
## create_payor_links
|
|
@@ -16,10 +15,10 @@ Create a Payor Link
|
|
|
16
15
|
|
|
17
16
|
This endpoint allows you to create a payor link.
|
|
18
17
|
|
|
19
|
-
###
|
|
18
|
+
### Examples
|
|
20
19
|
|
|
21
20
|
```ruby
|
|
22
|
-
|
|
21
|
+
require 'time'
|
|
23
22
|
require 'velopayments'
|
|
24
23
|
# setup authorization
|
|
25
24
|
VeloPayments.configure do |config|
|
|
@@ -28,22 +27,39 @@ VeloPayments.configure do |config|
|
|
|
28
27
|
end
|
|
29
28
|
|
|
30
29
|
api_instance = VeloPayments::PayorsPrivateApi.new
|
|
31
|
-
create_payor_link_request = VeloPayments::CreatePayorLinkRequest.new # CreatePayorLinkRequest | Request to create a payor link
|
|
30
|
+
create_payor_link_request = VeloPayments::CreatePayorLinkRequest.new({from_payor_id: 'from_payor_id_example', link_type: 'PARENT_OF', to_payor_id: 'to_payor_id_example'}) # CreatePayorLinkRequest | Request to create a payor link
|
|
32
31
|
|
|
33
32
|
begin
|
|
34
|
-
#Create a Payor Link
|
|
33
|
+
# Create a Payor Link
|
|
35
34
|
api_instance.create_payor_links(create_payor_link_request)
|
|
36
35
|
rescue VeloPayments::ApiError => e
|
|
37
|
-
puts "
|
|
36
|
+
puts "Error when calling PayorsPrivateApi->create_payor_links: #{e}"
|
|
38
37
|
end
|
|
39
38
|
```
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
#### Using the create_payor_links_with_http_info variant
|
|
41
|
+
|
|
42
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
42
43
|
|
|
44
|
+
> <Array(nil, Integer, Hash)> create_payor_links_with_http_info(create_payor_link_request)
|
|
45
|
+
|
|
46
|
+
```ruby
|
|
47
|
+
begin
|
|
48
|
+
# Create a Payor Link
|
|
49
|
+
data, status_code, headers = api_instance.create_payor_links_with_http_info(create_payor_link_request)
|
|
50
|
+
p status_code # => 2xx
|
|
51
|
+
p headers # => { ... }
|
|
52
|
+
p data # => nil
|
|
53
|
+
rescue VeloPayments::ApiError => e
|
|
54
|
+
puts "Error when calling PayorsPrivateApi->create_payor_links_with_http_info: #{e}"
|
|
55
|
+
end
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
43
59
|
|
|
44
|
-
Name | Type | Description
|
|
45
|
-
|
|
46
|
-
**create_payor_link_request** | [**CreatePayorLinkRequest**](CreatePayorLinkRequest.md)| Request to create a payor link |
|
|
60
|
+
| Name | Type | Description | Notes |
|
|
61
|
+
| ---- | ---- | ----------- | ----- |
|
|
62
|
+
| **create_payor_link_request** | [**CreatePayorLinkRequest**](CreatePayorLinkRequest.md) | Request to create a payor link | |
|
|
47
63
|
|
|
48
64
|
### Return type
|
|
49
65
|
|
data/docs/PayoutCompanyV3.md
CHANGED
|
@@ -2,16 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**company_name** | **String** | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_name** | **String** | | |
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Example
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
|
-
require '
|
|
12
|
+
require 'velopayments'
|
|
13
13
|
|
|
14
|
-
instance = VeloPayments::PayoutCompanyV3.new(
|
|
14
|
+
instance = VeloPayments::PayoutCompanyV3.new(
|
|
15
|
+
company_name: ACME Anvils PLC
|
|
16
|
+
)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
|
-
|
data/docs/PayoutIndividualV3.md
CHANGED
|
@@ -2,16 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**name** | [**PayoutNameV3**](PayoutNameV3.md) | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | [**PayoutNameV3**](PayoutNameV3.md) | | |
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Example
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
|
-
require '
|
|
12
|
+
require 'velopayments'
|
|
13
13
|
|
|
14
|
-
instance = VeloPayments::PayoutIndividualV3.new(
|
|
14
|
+
instance = VeloPayments::PayoutIndividualV3.new(
|
|
15
|
+
name: null
|
|
16
|
+
)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
|
-
|
data/docs/PayoutNameV3.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**first_name** | **String** | |
|
|
8
|
-
**last_name** | **String** | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | | |
|
|
8
|
+
| **last_name** | **String** | | |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'velopayments'
|
|
14
14
|
|
|
15
|
-
instance = VeloPayments::PayoutNameV3.new(
|
|
16
|
-
|
|
15
|
+
instance = VeloPayments::PayoutNameV3.new(
|
|
16
|
+
first_name: Fred,
|
|
17
|
+
last_name: Flintstone
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
data/docs/PayoutPayeeV3.md
CHANGED
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payee_id** | **String** | |
|
|
8
|
-
**individual** | [**PayoutIndividualV3**](PayoutIndividualV3.md) | | [optional]
|
|
9
|
-
**company** | [**PayoutCompanyV3**](PayoutCompanyV3.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payee_id** | **String** | | |
|
|
8
|
+
| **individual** | [**PayoutIndividualV3**](PayoutIndividualV3.md) | | [optional] |
|
|
9
|
+
| **company** | [**PayoutCompanyV3**](PayoutCompanyV3.md) | | [optional] |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'velopayments'
|
|
15
15
|
|
|
16
|
-
instance = VeloPayments::PayoutPayeeV3.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = VeloPayments::PayoutPayeeV3.new(
|
|
17
|
+
payee_id: null,
|
|
18
|
+
individual: null,
|
|
19
|
+
company: null
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
data/docs/PayoutPayor.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# VeloPayments::PayoutPayor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | The id of the payor. | |
|
|
8
|
+
| **payor_name** | **String** | The name of the payor. | |
|
|
9
|
+
| **dba_name** | **String** | The alternate name of the payor. | |
|
|
10
|
+
| **principal** | **String** | Email address if principal is a user or ID if application. | |
|
|
11
|
+
| **principal_id** | **String** | The id of the principal. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'velopayments'
|
|
17
|
+
|
|
18
|
+
instance = VeloPayments::PayoutPayor.new(
|
|
19
|
+
payor_id: null,
|
|
20
|
+
payor_name: null,
|
|
21
|
+
dba_name: null,
|
|
22
|
+
principal: null,
|
|
23
|
+
principal_id: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VeloPayments::PayoutPayorIds
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **submitting_payor_id** | **String** | The ID of the Payor that is submitting the payout | |
|
|
8
|
+
| **payout_from_payor_id** | **String** | The ID of the Payor providing the source account for the payout | |
|
|
9
|
+
| **payout_to_payor_id** | **String** | The ID of the Payor that owns the Payee (on behalf of) | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'velopayments'
|
|
15
|
+
|
|
16
|
+
instance = VeloPayments::PayoutPayorIds.new(
|
|
17
|
+
submitting_payor_id: ac207f97-663c-4429-9d57-ba5b35d6672d,
|
|
18
|
+
payout_from_payor_id: 35198f08-1c7b-4a91-8921-cd760ed92bca,
|
|
19
|
+
payout_to_payor_id: 3eb99144-6ebf-4b02-9483-ad86b2ff1bca
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VeloPayments::PayoutPrincipal
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **principal** | **String** | Email address if principal is a user or ID if application. | |
|
|
8
|
+
| **principal_id** | **String** | The id of the principal. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'velopayments'
|
|
14
|
+
|
|
15
|
+
instance = VeloPayments::PayoutPrincipal.new(
|
|
16
|
+
principal: null,
|
|
17
|
+
principal_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/PayoutServiceApi.md
CHANGED
|
@@ -2,30 +2,29 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**create_quote_for_payout_v3**](PayoutServiceApi.md#create_quote_for_payout_v3) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout
|
|
8
|
-
[**get_payments_for_payout_v3**](PayoutServiceApi.md#get_payments_for_payout_v3) | **GET** /v3/payouts/{payoutId}/payments | Retrieve payments for a payout
|
|
9
|
-
[**get_payout_summary_v3**](PayoutServiceApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
|
|
10
|
-
[**instruct_payout_v3**](PayoutServiceApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout
|
|
11
|
-
[**submit_payout_v3**](PayoutServiceApi.md#submit_payout_v3) | **POST** /v3/payouts | Submit Payout
|
|
12
|
-
[**withdraw_payment**](PayoutServiceApi.md#withdraw_payment) | **POST** /v1/payments/{paymentId}/withdraw | Withdraw a Payment
|
|
13
|
-
[**withdraw_payout_v3**](PayoutServiceApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
|
|
14
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_quote_for_payout_v3**](PayoutServiceApi.md#create_quote_for_payout_v3) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout |
|
|
8
|
+
| [**get_payments_for_payout_v3**](PayoutServiceApi.md#get_payments_for_payout_v3) | **GET** /v3/payouts/{payoutId}/payments | Retrieve payments for a payout |
|
|
9
|
+
| [**get_payout_summary_v3**](PayoutServiceApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary |
|
|
10
|
+
| [**instruct_payout_v3**](PayoutServiceApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout |
|
|
11
|
+
| [**submit_payout_v3**](PayoutServiceApi.md#submit_payout_v3) | **POST** /v3/payouts | Submit Payout |
|
|
12
|
+
| [**withdraw_payment**](PayoutServiceApi.md#withdraw_payment) | **POST** /v1/payments/{paymentId}/withdraw | Withdraw a Payment |
|
|
13
|
+
| [**withdraw_payout_v3**](PayoutServiceApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout |
|
|
15
14
|
|
|
16
15
|
|
|
17
16
|
## create_quote_for_payout_v3
|
|
18
17
|
|
|
19
|
-
> QuoteResponseV3 create_quote_for_payout_v3(payout_id)
|
|
18
|
+
> <QuoteResponseV3> create_quote_for_payout_v3(payout_id)
|
|
20
19
|
|
|
21
20
|
Create a quote for the payout
|
|
22
21
|
|
|
23
22
|
Create quote for a payout
|
|
24
23
|
|
|
25
|
-
###
|
|
24
|
+
### Examples
|
|
26
25
|
|
|
27
26
|
```ruby
|
|
28
|
-
|
|
27
|
+
require 'time'
|
|
29
28
|
require 'velopayments'
|
|
30
29
|
# setup authorization
|
|
31
30
|
VeloPayments.configure do |config|
|
|
@@ -34,23 +33,40 @@ VeloPayments.configure do |config|
|
|
|
34
33
|
end
|
|
35
34
|
|
|
36
35
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
37
|
-
payout_id =
|
|
36
|
+
payout_id = TODO # String | Id of the payout
|
|
38
37
|
|
|
39
38
|
begin
|
|
40
|
-
#Create a quote for the payout
|
|
39
|
+
# Create a quote for the payout
|
|
41
40
|
result = api_instance.create_quote_for_payout_v3(payout_id)
|
|
42
41
|
p result
|
|
43
42
|
rescue VeloPayments::ApiError => e
|
|
44
|
-
puts "
|
|
43
|
+
puts "Error when calling PayoutServiceApi->create_quote_for_payout_v3: #{e}"
|
|
45
44
|
end
|
|
46
45
|
```
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
#### Using the create_quote_for_payout_v3_with_http_info variant
|
|
48
|
+
|
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
|
50
|
+
|
|
51
|
+
> <Array(<QuoteResponseV3>, Integer, Hash)> create_quote_for_payout_v3_with_http_info(payout_id)
|
|
52
|
+
|
|
53
|
+
```ruby
|
|
54
|
+
begin
|
|
55
|
+
# Create a quote for the payout
|
|
56
|
+
data, status_code, headers = api_instance.create_quote_for_payout_v3_with_http_info(payout_id)
|
|
57
|
+
p status_code # => 2xx
|
|
58
|
+
p headers # => { ... }
|
|
59
|
+
p data # => <QuoteResponseV3>
|
|
60
|
+
rescue VeloPayments::ApiError => e
|
|
61
|
+
puts "Error when calling PayoutServiceApi->create_quote_for_payout_v3_with_http_info: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
49
64
|
|
|
65
|
+
### Parameters
|
|
50
66
|
|
|
51
|
-
Name | Type | Description
|
|
52
|
-
|
|
53
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
|
69
|
+
| **payout_id** | [**String**](.md) | Id of the payout | |
|
|
54
70
|
|
|
55
71
|
### Return type
|
|
56
72
|
|
|
@@ -68,16 +84,16 @@ Name | Type | Description | Notes
|
|
|
68
84
|
|
|
69
85
|
## get_payments_for_payout_v3
|
|
70
86
|
|
|
71
|
-
> PagedPaymentsResponseV3 get_payments_for_payout_v3(payout_id, opts)
|
|
87
|
+
> <PagedPaymentsResponseV3> get_payments_for_payout_v3(payout_id, opts)
|
|
72
88
|
|
|
73
89
|
Retrieve payments for a payout
|
|
74
90
|
|
|
75
91
|
Retrieve payments for a payout
|
|
76
92
|
|
|
77
|
-
###
|
|
93
|
+
### Examples
|
|
78
94
|
|
|
79
95
|
```ruby
|
|
80
|
-
|
|
96
|
+
require 'time'
|
|
81
97
|
require 'velopayments'
|
|
82
98
|
# setup authorization
|
|
83
99
|
VeloPayments.configure do |config|
|
|
@@ -86,39 +102,58 @@ VeloPayments.configure do |config|
|
|
|
86
102
|
end
|
|
87
103
|
|
|
88
104
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
89
|
-
payout_id =
|
|
105
|
+
payout_id = TODO # String | Id of the payout
|
|
90
106
|
opts = {
|
|
91
|
-
status: '
|
|
107
|
+
status: 'ACCEPTED', # String | Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal
|
|
92
108
|
remote_id: 'remote_id_example', # String | The remote id of the payees.
|
|
93
109
|
payor_payment_id: 'payor_payment_id_example', # String | Payor's Id of the Payment
|
|
94
110
|
source_account_name: 'source_account_name_example', # String | Physical Account Name
|
|
111
|
+
transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
|
95
112
|
payment_memo: 'payment_memo_example', # String | Payment Memo of the Payment
|
|
96
|
-
page_size:
|
|
97
|
-
page:
|
|
113
|
+
page_size: 56, # Integer | The number of results to return in a page
|
|
114
|
+
page: 56 # Integer | Page number. Default is 1.
|
|
98
115
|
}
|
|
99
116
|
|
|
100
117
|
begin
|
|
101
|
-
#Retrieve payments for a payout
|
|
118
|
+
# Retrieve payments for a payout
|
|
102
119
|
result = api_instance.get_payments_for_payout_v3(payout_id, opts)
|
|
103
120
|
p result
|
|
104
121
|
rescue VeloPayments::ApiError => e
|
|
105
|
-
puts "
|
|
122
|
+
puts "Error when calling PayoutServiceApi->get_payments_for_payout_v3: #{e}"
|
|
106
123
|
end
|
|
107
124
|
```
|
|
108
125
|
|
|
109
|
-
|
|
126
|
+
#### Using the get_payments_for_payout_v3_with_http_info variant
|
|
127
|
+
|
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
|
129
|
+
|
|
130
|
+
> <Array(<PagedPaymentsResponseV3>, Integer, Hash)> get_payments_for_payout_v3_with_http_info(payout_id, opts)
|
|
131
|
+
|
|
132
|
+
```ruby
|
|
133
|
+
begin
|
|
134
|
+
# Retrieve payments for a payout
|
|
135
|
+
data, status_code, headers = api_instance.get_payments_for_payout_v3_with_http_info(payout_id, opts)
|
|
136
|
+
p status_code # => 2xx
|
|
137
|
+
p headers # => { ... }
|
|
138
|
+
p data # => <PagedPaymentsResponseV3>
|
|
139
|
+
rescue VeloPayments::ApiError => e
|
|
140
|
+
puts "Error when calling PayoutServiceApi->get_payments_for_payout_v3_with_http_info: #{e}"
|
|
141
|
+
end
|
|
142
|
+
```
|
|
110
143
|
|
|
144
|
+
### Parameters
|
|
111
145
|
|
|
112
|
-
Name | Type | Description
|
|
113
|
-
|
|
114
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
115
|
-
**status** | **String
|
|
116
|
-
**remote_id** | **String
|
|
117
|
-
**payor_payment_id** | **String
|
|
118
|
-
**source_account_name** | **String
|
|
119
|
-
**
|
|
120
|
-
**
|
|
121
|
-
**
|
|
146
|
+
| Name | Type | Description | Notes |
|
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
|
148
|
+
| **payout_id** | [**String**](.md) | Id of the payout | |
|
|
149
|
+
| **status** | **String** | Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal | [optional] |
|
|
150
|
+
| **remote_id** | **String** | The remote id of the payees. | [optional] |
|
|
151
|
+
| **payor_payment_id** | **String** | Payor's Id of the Payment | [optional] |
|
|
152
|
+
| **source_account_name** | **String** | Physical Account Name | [optional] |
|
|
153
|
+
| **transmission_type** | **String** | Transmission Type * ACH * SAME_DAY_ACH * WIRE | [optional] |
|
|
154
|
+
| **payment_memo** | **String** | Payment Memo of the Payment | [optional] |
|
|
155
|
+
| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
|
|
156
|
+
| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
|
|
122
157
|
|
|
123
158
|
### Return type
|
|
124
159
|
|
|
@@ -136,16 +171,16 @@ Name | Type | Description | Notes
|
|
|
136
171
|
|
|
137
172
|
## get_payout_summary_v3
|
|
138
173
|
|
|
139
|
-
> PayoutSummaryResponseV3 get_payout_summary_v3(payout_id)
|
|
174
|
+
> <PayoutSummaryResponseV3> get_payout_summary_v3(payout_id)
|
|
140
175
|
|
|
141
176
|
Get Payout Summary
|
|
142
177
|
|
|
143
178
|
Get payout summary - returns the current state of the payout.
|
|
144
179
|
|
|
145
|
-
###
|
|
180
|
+
### Examples
|
|
146
181
|
|
|
147
182
|
```ruby
|
|
148
|
-
|
|
183
|
+
require 'time'
|
|
149
184
|
require 'velopayments'
|
|
150
185
|
# setup authorization
|
|
151
186
|
VeloPayments.configure do |config|
|
|
@@ -154,23 +189,40 @@ VeloPayments.configure do |config|
|
|
|
154
189
|
end
|
|
155
190
|
|
|
156
191
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
157
|
-
payout_id =
|
|
192
|
+
payout_id = TODO # String | Id of the payout
|
|
158
193
|
|
|
159
194
|
begin
|
|
160
|
-
#Get Payout Summary
|
|
195
|
+
# Get Payout Summary
|
|
161
196
|
result = api_instance.get_payout_summary_v3(payout_id)
|
|
162
197
|
p result
|
|
163
198
|
rescue VeloPayments::ApiError => e
|
|
164
|
-
puts "
|
|
199
|
+
puts "Error when calling PayoutServiceApi->get_payout_summary_v3: #{e}"
|
|
165
200
|
end
|
|
166
201
|
```
|
|
167
202
|
|
|
168
|
-
|
|
203
|
+
#### Using the get_payout_summary_v3_with_http_info variant
|
|
204
|
+
|
|
205
|
+
This returns an Array which contains the response data, status code and headers.
|
|
206
|
+
|
|
207
|
+
> <Array(<PayoutSummaryResponseV3>, Integer, Hash)> get_payout_summary_v3_with_http_info(payout_id)
|
|
208
|
+
|
|
209
|
+
```ruby
|
|
210
|
+
begin
|
|
211
|
+
# Get Payout Summary
|
|
212
|
+
data, status_code, headers = api_instance.get_payout_summary_v3_with_http_info(payout_id)
|
|
213
|
+
p status_code # => 2xx
|
|
214
|
+
p headers # => { ... }
|
|
215
|
+
p data # => <PayoutSummaryResponseV3>
|
|
216
|
+
rescue VeloPayments::ApiError => e
|
|
217
|
+
puts "Error when calling PayoutServiceApi->get_payout_summary_v3_with_http_info: #{e}"
|
|
218
|
+
end
|
|
219
|
+
```
|
|
169
220
|
|
|
221
|
+
### Parameters
|
|
170
222
|
|
|
171
|
-
Name | Type | Description
|
|
172
|
-
|
|
173
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
223
|
+
| Name | Type | Description | Notes |
|
|
224
|
+
| ---- | ---- | ----------- | ----- |
|
|
225
|
+
| **payout_id** | [**String**](.md) | Id of the payout | |
|
|
174
226
|
|
|
175
227
|
### Return type
|
|
176
228
|
|
|
@@ -194,10 +246,10 @@ Instruct Payout
|
|
|
194
246
|
|
|
195
247
|
Instruct a payout to be made for the specified payoutId.
|
|
196
248
|
|
|
197
|
-
###
|
|
249
|
+
### Examples
|
|
198
250
|
|
|
199
251
|
```ruby
|
|
200
|
-
|
|
252
|
+
require 'time'
|
|
201
253
|
require 'velopayments'
|
|
202
254
|
# setup authorization
|
|
203
255
|
VeloPayments.configure do |config|
|
|
@@ -206,22 +258,39 @@ VeloPayments.configure do |config|
|
|
|
206
258
|
end
|
|
207
259
|
|
|
208
260
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
209
|
-
payout_id =
|
|
261
|
+
payout_id = TODO # String | Id of the payout
|
|
210
262
|
|
|
211
263
|
begin
|
|
212
|
-
#Instruct Payout
|
|
264
|
+
# Instruct Payout
|
|
213
265
|
api_instance.instruct_payout_v3(payout_id)
|
|
214
266
|
rescue VeloPayments::ApiError => e
|
|
215
|
-
puts "
|
|
267
|
+
puts "Error when calling PayoutServiceApi->instruct_payout_v3: #{e}"
|
|
216
268
|
end
|
|
217
269
|
```
|
|
218
270
|
|
|
219
|
-
|
|
271
|
+
#### Using the instruct_payout_v3_with_http_info variant
|
|
220
272
|
|
|
273
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
221
274
|
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
275
|
+
> <Array(nil, Integer, Hash)> instruct_payout_v3_with_http_info(payout_id)
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
begin
|
|
279
|
+
# Instruct Payout
|
|
280
|
+
data, status_code, headers = api_instance.instruct_payout_v3_with_http_info(payout_id)
|
|
281
|
+
p status_code # => 2xx
|
|
282
|
+
p headers # => { ... }
|
|
283
|
+
p data # => nil
|
|
284
|
+
rescue VeloPayments::ApiError => e
|
|
285
|
+
puts "Error when calling PayoutServiceApi->instruct_payout_v3_with_http_info: #{e}"
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
| Name | Type | Description | Notes |
|
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
|
293
|
+
| **payout_id** | [**String**](.md) | Id of the payout | |
|
|
225
294
|
|
|
226
295
|
### Return type
|
|
227
296
|
|
|
@@ -245,10 +314,10 @@ Submit Payout
|
|
|
245
314
|
|
|
246
315
|
<p>Create a new payout and return a location header with a link to get 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.</p> with no decimal places.
|
|
247
316
|
|
|
248
|
-
###
|
|
317
|
+
### Examples
|
|
249
318
|
|
|
250
319
|
```ruby
|
|
251
|
-
|
|
320
|
+
require 'time'
|
|
252
321
|
require 'velopayments'
|
|
253
322
|
# setup authorization
|
|
254
323
|
VeloPayments.configure do |config|
|
|
@@ -257,22 +326,39 @@ VeloPayments.configure do |config|
|
|
|
257
326
|
end
|
|
258
327
|
|
|
259
328
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
260
|
-
create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new # CreatePayoutRequestV3 | Post amount to transfer using stored funding account details.
|
|
329
|
+
create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new({payments: [VeloPayments::PaymentInstructionV3.new({remote_id: 'remoteId1234', currency: 'USD', amount: 1299, source_account_name: 'MyAccountName'})]}) # CreatePayoutRequestV3 | Post amount to transfer using stored funding account details.
|
|
261
330
|
|
|
262
331
|
begin
|
|
263
|
-
#Submit Payout
|
|
332
|
+
# Submit Payout
|
|
264
333
|
api_instance.submit_payout_v3(create_payout_request_v3)
|
|
265
334
|
rescue VeloPayments::ApiError => e
|
|
266
|
-
puts "
|
|
335
|
+
puts "Error when calling PayoutServiceApi->submit_payout_v3: #{e}"
|
|
267
336
|
end
|
|
268
337
|
```
|
|
269
338
|
|
|
270
|
-
|
|
339
|
+
#### Using the submit_payout_v3_with_http_info variant
|
|
340
|
+
|
|
341
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
342
|
+
|
|
343
|
+
> <Array(nil, Integer, Hash)> submit_payout_v3_with_http_info(create_payout_request_v3)
|
|
344
|
+
|
|
345
|
+
```ruby
|
|
346
|
+
begin
|
|
347
|
+
# Submit Payout
|
|
348
|
+
data, status_code, headers = api_instance.submit_payout_v3_with_http_info(create_payout_request_v3)
|
|
349
|
+
p status_code # => 2xx
|
|
350
|
+
p headers # => { ... }
|
|
351
|
+
p data # => nil
|
|
352
|
+
rescue VeloPayments::ApiError => e
|
|
353
|
+
puts "Error when calling PayoutServiceApi->submit_payout_v3_with_http_info: #{e}"
|
|
354
|
+
end
|
|
355
|
+
```
|
|
271
356
|
|
|
357
|
+
### Parameters
|
|
272
358
|
|
|
273
|
-
Name | Type | Description
|
|
274
|
-
|
|
275
|
-
**create_payout_request_v3** | [**CreatePayoutRequestV3**](CreatePayoutRequestV3.md)| Post amount to transfer using stored funding account details. |
|
|
359
|
+
| Name | Type | Description | Notes |
|
|
360
|
+
| ---- | ---- | ----------- | ----- |
|
|
361
|
+
| **create_payout_request_v3** | [**CreatePayoutRequestV3**](CreatePayoutRequestV3.md) | Post amount to transfer using stored funding account details. | |
|
|
276
362
|
|
|
277
363
|
### Return type
|
|
278
364
|
|
|
@@ -296,10 +382,10 @@ Withdraw a Payment
|
|
|
296
382
|
|
|
297
383
|
<p>withdraw a payment </p> <p>There are a variety of reasons why this can fail</p> <ul> <li>the payment must be in a state of 'accepted' or 'unfunded'</li> <li>the payout must not be in a state of 'instructed'</li> </ul>
|
|
298
384
|
|
|
299
|
-
###
|
|
385
|
+
### Examples
|
|
300
386
|
|
|
301
387
|
```ruby
|
|
302
|
-
|
|
388
|
+
require 'time'
|
|
303
389
|
require 'velopayments'
|
|
304
390
|
# setup authorization
|
|
305
391
|
VeloPayments.configure do |config|
|
|
@@ -308,24 +394,41 @@ VeloPayments.configure do |config|
|
|
|
308
394
|
end
|
|
309
395
|
|
|
310
396
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
311
|
-
payment_id =
|
|
312
|
-
withdraw_payment_request = VeloPayments::WithdrawPaymentRequest.new # WithdrawPaymentRequest | details for withdrawal
|
|
397
|
+
payment_id = TODO # String | Id of the Payment
|
|
398
|
+
withdraw_payment_request = VeloPayments::WithdrawPaymentRequest.new({reason: 'Payment submitted in error'}) # WithdrawPaymentRequest | details for withdrawal
|
|
313
399
|
|
|
314
400
|
begin
|
|
315
|
-
#Withdraw a Payment
|
|
401
|
+
# Withdraw a Payment
|
|
316
402
|
api_instance.withdraw_payment(payment_id, withdraw_payment_request)
|
|
317
403
|
rescue VeloPayments::ApiError => e
|
|
318
|
-
puts "
|
|
404
|
+
puts "Error when calling PayoutServiceApi->withdraw_payment: #{e}"
|
|
319
405
|
end
|
|
320
406
|
```
|
|
321
407
|
|
|
322
|
-
|
|
408
|
+
#### Using the withdraw_payment_with_http_info variant
|
|
323
409
|
|
|
410
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
324
411
|
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
412
|
+
> <Array(nil, Integer, Hash)> withdraw_payment_with_http_info(payment_id, withdraw_payment_request)
|
|
413
|
+
|
|
414
|
+
```ruby
|
|
415
|
+
begin
|
|
416
|
+
# Withdraw a Payment
|
|
417
|
+
data, status_code, headers = api_instance.withdraw_payment_with_http_info(payment_id, withdraw_payment_request)
|
|
418
|
+
p status_code # => 2xx
|
|
419
|
+
p headers # => { ... }
|
|
420
|
+
p data # => nil
|
|
421
|
+
rescue VeloPayments::ApiError => e
|
|
422
|
+
puts "Error when calling PayoutServiceApi->withdraw_payment_with_http_info: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Name | Type | Description | Notes |
|
|
429
|
+
| ---- | ---- | ----------- | ----- |
|
|
430
|
+
| **payment_id** | [**String**](.md) | Id of the Payment | |
|
|
431
|
+
| **withdraw_payment_request** | [**WithdrawPaymentRequest**](WithdrawPaymentRequest.md) | details for withdrawal | |
|
|
329
432
|
|
|
330
433
|
### Return type
|
|
331
434
|
|
|
@@ -349,10 +452,10 @@ Withdraw Payout
|
|
|
349
452
|
|
|
350
453
|
Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
|
|
351
454
|
|
|
352
|
-
###
|
|
455
|
+
### Examples
|
|
353
456
|
|
|
354
457
|
```ruby
|
|
355
|
-
|
|
458
|
+
require 'time'
|
|
356
459
|
require 'velopayments'
|
|
357
460
|
# setup authorization
|
|
358
461
|
VeloPayments.configure do |config|
|
|
@@ -361,22 +464,39 @@ VeloPayments.configure do |config|
|
|
|
361
464
|
end
|
|
362
465
|
|
|
363
466
|
api_instance = VeloPayments::PayoutServiceApi.new
|
|
364
|
-
payout_id =
|
|
467
|
+
payout_id = TODO # String | Id of the payout
|
|
365
468
|
|
|
366
469
|
begin
|
|
367
|
-
#Withdraw Payout
|
|
470
|
+
# Withdraw Payout
|
|
368
471
|
api_instance.withdraw_payout_v3(payout_id)
|
|
369
472
|
rescue VeloPayments::ApiError => e
|
|
370
|
-
puts "
|
|
473
|
+
puts "Error when calling PayoutServiceApi->withdraw_payout_v3: #{e}"
|
|
371
474
|
end
|
|
372
475
|
```
|
|
373
476
|
|
|
374
|
-
|
|
477
|
+
#### Using the withdraw_payout_v3_with_http_info variant
|
|
478
|
+
|
|
479
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
375
480
|
|
|
481
|
+
> <Array(nil, Integer, Hash)> withdraw_payout_v3_with_http_info(payout_id)
|
|
482
|
+
|
|
483
|
+
```ruby
|
|
484
|
+
begin
|
|
485
|
+
# Withdraw Payout
|
|
486
|
+
data, status_code, headers = api_instance.withdraw_payout_v3_with_http_info(payout_id)
|
|
487
|
+
p status_code # => 2xx
|
|
488
|
+
p headers # => { ... }
|
|
489
|
+
p data # => nil
|
|
490
|
+
rescue VeloPayments::ApiError => e
|
|
491
|
+
puts "Error when calling PayoutServiceApi->withdraw_payout_v3_with_http_info: #{e}"
|
|
492
|
+
end
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
### Parameters
|
|
376
496
|
|
|
377
|
-
Name | Type | Description
|
|
378
|
-
|
|
379
|
-
**payout_id** | [**String**](.md)| Id of the payout |
|
|
497
|
+
| Name | Type | Description | Notes |
|
|
498
|
+
| ---- | ---- | ----------- | ----- |
|
|
499
|
+
| **payout_id** | [**String**](.md) | Id of the payout | |
|
|
380
500
|
|
|
381
501
|
### Return type
|
|
382
502
|
|