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
|
@@ -2,20 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**name** | **String** | A name for the key. |
|
|
8
|
-
**description** | **String** | Description of the key. | [optional]
|
|
9
|
-
**roles** | **Array<String>** | A list of roles to assign to the key. |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | A name for the key. | |
|
|
8
|
+
| **description** | **String** | Description of the key. | [optional] |
|
|
9
|
+
| **roles** | **Array<String>** | A list of roles to assign to the key. | |
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'velopayments'
|
|
15
15
|
|
|
16
|
-
instance = VeloPayments::PayorCreateApiKeyRequest.new(
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
instance = VeloPayments::PayorCreateApiKeyRequest.new(
|
|
17
|
+
name: iOS Key,
|
|
18
|
+
description: Key for iOS mobile application,
|
|
19
|
+
roles: ["payor.admin"]
|
|
20
|
+
)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**api_key** | **String** | API Key | [optional]
|
|
8
|
-
**api_secret** | **String** | API Secret | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | API Key | [optional] |
|
|
8
|
+
| **api_secret** | **String** | API Secret | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'velopayments'
|
|
14
14
|
|
|
15
|
-
instance = VeloPayments::PayorCreateApiKeyResponse.new(
|
|
16
|
-
|
|
15
|
+
instance = VeloPayments::PayorCreateApiKeyResponse.new(
|
|
16
|
+
api_key: 385d4506-e7dd-446e-a092-5f30b98e7b26,
|
|
17
|
+
api_secret: f25767d9-342a-48ac-a788-0a7a38ae6fb3
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**name** | **String** | The name of the application. |
|
|
8
|
-
**description** | **String** | Description of the application. | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The name of the application. | |
|
|
8
|
+
| **description** | **String** | Description of the application. | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'velopayments'
|
|
14
14
|
|
|
15
|
-
instance = VeloPayments::PayorCreateApplicationRequest.new(
|
|
16
|
-
|
|
15
|
+
instance = VeloPayments::PayorCreateApplicationRequest.new(
|
|
16
|
+
name: SAP,
|
|
17
|
+
description: SAP Application integration
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -2,16 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**reminder_emails_opt_out** | **Boolean** | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reminder_emails_opt_out** | **Boolean** | | |
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Example
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
|
-
require '
|
|
12
|
+
require 'velopayments'
|
|
13
13
|
|
|
14
|
-
instance = VeloPayments::PayorEmailOptOutRequest.new(
|
|
14
|
+
instance = VeloPayments::PayorEmailOptOutRequest.new(
|
|
15
|
+
reminder_emails_opt_out: null
|
|
16
|
+
)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
|
-
|
data/docs/PayorLinksResponse.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**links** | [**Array<PayorLinksResponseLinks>**](PayorLinksResponseLinks.md) | | [optional]
|
|
8
|
-
**payors** | [**Array<PayorLinksResponsePayors>**](PayorLinksResponsePayors.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **links** | [**Array<PayorLinksResponseLinks>**](PayorLinksResponseLinks.md) | | [optional] |
|
|
8
|
+
| **payors** | [**Array<PayorLinksResponsePayors>**](PayorLinksResponsePayors.md) | | [optional] |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Example
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'velopayments'
|
|
14
14
|
|
|
15
|
-
instance = VeloPayments::PayorLinksResponse.new(
|
|
16
|
-
|
|
15
|
+
instance = VeloPayments::PayorLinksResponse.new(
|
|
16
|
+
links: null,
|
|
17
|
+
payors: null
|
|
18
|
+
)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
@@ -2,22 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**link_id** | **String** | |
|
|
8
|
-
**from_payor_id** | **String** | |
|
|
9
|
-
**link_type** | **String** | |
|
|
10
|
-
**to_payor_id** | **String** | |
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **link_id** | **String** | | |
|
|
8
|
+
| **from_payor_id** | **String** | | |
|
|
9
|
+
| **link_type** | **String** | | |
|
|
10
|
+
| **to_payor_id** | **String** | | |
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'velopayments'
|
|
16
16
|
|
|
17
|
-
instance = VeloPayments::PayorLinksResponseLinks.new(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
instance = VeloPayments::PayorLinksResponseLinks.new(
|
|
18
|
+
link_id: null,
|
|
19
|
+
from_payor_id: null,
|
|
20
|
+
link_type: null,
|
|
21
|
+
to_payor_id: null
|
|
22
|
+
)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
|
@@ -2,22 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payor_id** | **String** | |
|
|
8
|
-
**payor_name** | **String** | |
|
|
9
|
-
**primary_contact_email** | **String** | | [optional]
|
|
10
|
-
**kyc_state** | **String** | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | | |
|
|
8
|
+
| **payor_name** | **String** | | |
|
|
9
|
+
| **primary_contact_email** | **String** | | [optional] |
|
|
10
|
+
| **kyc_state** | **String** | | [optional] |
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'velopayments'
|
|
16
16
|
|
|
17
|
-
instance = VeloPayments::PayorLinksResponsePayors.new(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
instance = VeloPayments::PayorLinksResponsePayors.new(
|
|
18
|
+
payor_id: null,
|
|
19
|
+
payor_name: null,
|
|
20
|
+
primary_contact_email: null,
|
|
21
|
+
kyc_state: null
|
|
22
|
+
)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
data/docs/PayorV1.md
CHANGED
|
@@ -2,58 +2,59 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payor_id** | **String** | | [optional]
|
|
8
|
-
**payor_name** | **String** | The name of the payor. |
|
|
9
|
-
**address** | [**PayorAddress**](PayorAddress.md) | | [optional]
|
|
10
|
-
**primary_contact_name** | **String** | Name of primary contact for the payor. | [optional]
|
|
11
|
-
**primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional]
|
|
12
|
-
**primary_contact_email** | **String** | Primary contact email for the payor. | [optional]
|
|
13
|
-
**funding_account_routing_number** | **String** | The funding account routing number to be used for the payor. | [optional]
|
|
14
|
-
**funding_account_account_number** | **String** | The funding account number to be used for the payor. | [optional]
|
|
15
|
-
**funding_account_account_name** | **String** | The funding account name to be used for the payor. | [optional]
|
|
16
|
-
**kyc_state** | [**KycState**](KycState.md) | | [optional]
|
|
17
|
-
**manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional]
|
|
18
|
-
**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional]
|
|
19
|
-
**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional]
|
|
20
|
-
**collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional]
|
|
21
|
-
**support_contact** | **String** | The payor’s support contact email address. | [optional]
|
|
22
|
-
**dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional]
|
|
23
|
-
**allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional]
|
|
24
|
-
**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional]
|
|
25
|
-
**language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional]
|
|
26
|
-
**includes_reports** | **Boolean** | | [optional]
|
|
27
|
-
**max_master_payor_admins** | **Integer** | | [optional]
|
|
28
|
-
**transmission_types** | [**TransmissionTypes**](TransmissionTypes.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **payor_name** | **String** | The name of the payor. | |
|
|
9
|
+
| **address** | [**PayorAddress**](PayorAddress.md) | | [optional] |
|
|
10
|
+
| **primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] |
|
|
11
|
+
| **primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] |
|
|
12
|
+
| **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] |
|
|
13
|
+
| **funding_account_routing_number** | **String** | The funding account routing number to be used for the payor. | [optional] |
|
|
14
|
+
| **funding_account_account_number** | **String** | The funding account number to be used for the payor. | [optional] |
|
|
15
|
+
| **funding_account_account_name** | **String** | The funding account name to be used for the payor. | [optional] |
|
|
16
|
+
| **kyc_state** | [**KycState**](KycState.md) | | [optional] |
|
|
17
|
+
| **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] |
|
|
18
|
+
| **payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional][readonly] |
|
|
19
|
+
| **payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional][readonly] |
|
|
20
|
+
| **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] |
|
|
21
|
+
| **support_contact** | **String** | The payor’s support contact email address. | [optional] |
|
|
22
|
+
| **dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] |
|
|
23
|
+
| **allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] |
|
|
24
|
+
| **reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional][readonly] |
|
|
25
|
+
| **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] |
|
|
26
|
+
| **includes_reports** | **Boolean** | | [optional] |
|
|
27
|
+
| **max_master_payor_admins** | **Integer** | | [optional] |
|
|
28
|
+
| **transmission_types** | [**TransmissionTypes**](TransmissionTypes.md) | | [optional] |
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Example
|
|
31
31
|
|
|
32
32
|
```ruby
|
|
33
|
-
require '
|
|
33
|
+
require 'velopayments'
|
|
34
34
|
|
|
35
|
-
instance = VeloPayments::PayorV1.new(
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
35
|
+
instance = VeloPayments::PayorV1.new(
|
|
36
|
+
payor_id: null,
|
|
37
|
+
payor_name: Example, Corp,
|
|
38
|
+
address: null,
|
|
39
|
+
primary_contact_name: Joe Buck,
|
|
40
|
+
primary_contact_phone: 123-123-1234,
|
|
41
|
+
primary_contact_email: joe.buck@example.com,
|
|
42
|
+
funding_account_routing_number: 123456789,
|
|
43
|
+
funding_account_account_number: 1234567890123,
|
|
44
|
+
funding_account_account_name: Example Corp BOA,
|
|
45
|
+
kyc_state: null,
|
|
46
|
+
manual_lockout: null,
|
|
47
|
+
payee_grace_period_processing_enabled: null,
|
|
48
|
+
payee_grace_period_days: null,
|
|
49
|
+
collective_alias: Payee,
|
|
50
|
+
support_contact: support@example.com,
|
|
51
|
+
dba_name: Some Biz,
|
|
52
|
+
allows_language_choice: null,
|
|
53
|
+
reminder_emails_opt_out: null,
|
|
54
|
+
language: EN,
|
|
55
|
+
includes_reports: null,
|
|
56
|
+
max_master_payor_admins: null,
|
|
57
|
+
transmission_types: null
|
|
58
|
+
)
|
|
57
59
|
```
|
|
58
60
|
|
|
59
|
-
|
data/docs/PayorV2.md
CHANGED
|
@@ -2,58 +2,61 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
7
|
-
**payor_id** | **String** | | [readonly]
|
|
8
|
-
**payor_name** | **String** | The name of the payor. |
|
|
9
|
-
**payor_xid** | **String** | A unique identifier that an external system uses to reference the payor in their system | [optional]
|
|
10
|
-
**address** | [**PayorAddressV2**](PayorAddressV2.md) | | [optional]
|
|
11
|
-
**primary_contact_name** | **String** | Name of primary contact for the payor. | [optional]
|
|
12
|
-
**primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional]
|
|
13
|
-
**primary_contact_email** | **String** | Primary contact email for the payor. | [optional]
|
|
14
|
-
**kyc_state** | [**KycState**](KycState.md) | | [optional]
|
|
15
|
-
**manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional]
|
|
16
|
-
**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional]
|
|
17
|
-
**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional]
|
|
18
|
-
**collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional]
|
|
19
|
-
**support_contact** | **String** | The payor’s support contact email address. | [optional]
|
|
20
|
-
**dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional]
|
|
21
|
-
**allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional]
|
|
22
|
-
**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional]
|
|
23
|
-
**language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional]
|
|
24
|
-
**includes_reports** | **Boolean** | | [optional]
|
|
25
|
-
**wu_customer_id** | **String** | | [optional]
|
|
26
|
-
**max_master_payor_admins** | **Integer** | | [optional]
|
|
27
|
-
**payment_rails** | [**PaymentRails**](PaymentRails.md) | | [optional]
|
|
28
|
-
**transmission_types** | [**TransmissionTypes2**](TransmissionTypes2.md) | | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payor_id** | **String** | | [readonly] |
|
|
8
|
+
| **payor_name** | **String** | The name of the payor. | |
|
|
9
|
+
| **payor_xid** | **String** | A unique identifier that an external system uses to reference the payor in their system | [optional] |
|
|
10
|
+
| **address** | [**PayorAddressV2**](PayorAddressV2.md) | | [optional] |
|
|
11
|
+
| **primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] |
|
|
12
|
+
| **primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] |
|
|
13
|
+
| **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] |
|
|
14
|
+
| **kyc_state** | [**KycState**](KycState.md) | | [optional] |
|
|
15
|
+
| **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] |
|
|
16
|
+
| **payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional][readonly] |
|
|
17
|
+
| **payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional][readonly] |
|
|
18
|
+
| **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] |
|
|
19
|
+
| **support_contact** | **String** | The payor’s support contact email address. | [optional] |
|
|
20
|
+
| **dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] |
|
|
21
|
+
| **allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] |
|
|
22
|
+
| **reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional][readonly] |
|
|
23
|
+
| **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] |
|
|
24
|
+
| **includes_reports** | **Boolean** | | [optional] |
|
|
25
|
+
| **wu_customer_id** | **String** | | [optional] |
|
|
26
|
+
| **max_master_payor_admins** | **Integer** | | [optional] |
|
|
27
|
+
| **payment_rails** | [**PaymentRails**](PaymentRails.md) | | [optional] |
|
|
28
|
+
| **transmission_types** | [**TransmissionTypes2**](TransmissionTypes2.md) | | [optional] |
|
|
29
|
+
| **remote_system_ids** | **Array<String>** | The payor’s supported remote systems by id | [optional] |
|
|
29
30
|
|
|
30
|
-
##
|
|
31
|
+
## Example
|
|
31
32
|
|
|
32
33
|
```ruby
|
|
33
|
-
require '
|
|
34
|
+
require 'velopayments'
|
|
34
35
|
|
|
35
|
-
instance = VeloPayments::PayorV2.new(
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
36
|
+
instance = VeloPayments::PayorV2.new(
|
|
37
|
+
payor_id: null,
|
|
38
|
+
payor_name: Example, Corp,
|
|
39
|
+
payor_xid: ABC_201234,
|
|
40
|
+
address: null,
|
|
41
|
+
primary_contact_name: Joe Buck,
|
|
42
|
+
primary_contact_phone: 123-123-1234,
|
|
43
|
+
primary_contact_email: joe.buck@example.com,
|
|
44
|
+
kyc_state: null,
|
|
45
|
+
manual_lockout: null,
|
|
46
|
+
payee_grace_period_processing_enabled: null,
|
|
47
|
+
payee_grace_period_days: null,
|
|
48
|
+
collective_alias: Payee,
|
|
49
|
+
support_contact: support@example.com,
|
|
50
|
+
dba_name: Some Biz,
|
|
51
|
+
allows_language_choice: null,
|
|
52
|
+
reminder_emails_opt_out: null,
|
|
53
|
+
language: EN,
|
|
54
|
+
includes_reports: null,
|
|
55
|
+
wu_customer_id: null,
|
|
56
|
+
max_master_payor_admins: null,
|
|
57
|
+
payment_rails: null,
|
|
58
|
+
transmission_types: null,
|
|
59
|
+
remote_system_ids: null
|
|
60
|
+
)
|
|
57
61
|
```
|
|
58
62
|
|
|
59
|
-
|
data/docs/PayorsApi.md
CHANGED
|
@@ -2,31 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.sandbox.velopayments.com*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
|
|
8
|
-
[**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor
|
|
9
|
-
[**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
|
|
10
|
-
[**payor_create_api_key_request**](PayorsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
|
|
11
|
-
[**payor_create_application_request**](PayorsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
|
|
12
|
-
[**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out
|
|
13
|
-
[**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding
|
|
14
|
-
[**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links
|
|
15
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor |
|
|
8
|
+
| [**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor |
|
|
9
|
+
| [**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
|
|
10
|
+
| [**payor_create_api_key_request**](PayorsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
|
|
11
|
+
| [**payor_create_application_request**](PayorsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application |
|
|
12
|
+
| [**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out |
|
|
13
|
+
| [**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding |
|
|
14
|
+
| [**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links |
|
|
16
15
|
|
|
17
16
|
|
|
18
17
|
## get_payor_by_id
|
|
19
18
|
|
|
20
|
-
> PayorV1 get_payor_by_id(payor_id)
|
|
19
|
+
> <PayorV1> get_payor_by_id(payor_id)
|
|
21
20
|
|
|
22
21
|
Get Payor
|
|
23
22
|
|
|
24
23
|
Get a Single Payor by Id.
|
|
25
24
|
|
|
26
|
-
###
|
|
25
|
+
### Examples
|
|
27
26
|
|
|
28
27
|
```ruby
|
|
29
|
-
|
|
28
|
+
require 'time'
|
|
30
29
|
require 'velopayments'
|
|
31
30
|
# setup authorization
|
|
32
31
|
VeloPayments.configure do |config|
|
|
@@ -35,23 +34,40 @@ VeloPayments.configure do |config|
|
|
|
35
34
|
end
|
|
36
35
|
|
|
37
36
|
api_instance = VeloPayments::PayorsApi.new
|
|
38
|
-
payor_id =
|
|
37
|
+
payor_id = TODO # String | The Payor Id
|
|
39
38
|
|
|
40
39
|
begin
|
|
41
|
-
#Get Payor
|
|
40
|
+
# Get Payor
|
|
42
41
|
result = api_instance.get_payor_by_id(payor_id)
|
|
43
42
|
p result
|
|
44
43
|
rescue VeloPayments::ApiError => e
|
|
45
|
-
puts "
|
|
44
|
+
puts "Error when calling PayorsApi->get_payor_by_id: #{e}"
|
|
46
45
|
end
|
|
47
46
|
```
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
#### Using the get_payor_by_id_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
50
51
|
|
|
52
|
+
> <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_with_http_info(payor_id)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# Get Payor
|
|
57
|
+
data, status_code, headers = api_instance.get_payor_by_id_with_http_info(payor_id)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <PayorV1>
|
|
61
|
+
rescue VeloPayments::ApiError => e
|
|
62
|
+
puts "Error when calling PayorsApi->get_payor_by_id_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
51
67
|
|
|
52
|
-
Name | Type | Description
|
|
53
|
-
|
|
54
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
55
71
|
|
|
56
72
|
### Return type
|
|
57
73
|
|
|
@@ -69,16 +85,16 @@ Name | Type | Description | Notes
|
|
|
69
85
|
|
|
70
86
|
## get_payor_by_id_v2
|
|
71
87
|
|
|
72
|
-
> PayorV2 get_payor_by_id_v2(payor_id)
|
|
88
|
+
> <PayorV2> get_payor_by_id_v2(payor_id)
|
|
73
89
|
|
|
74
90
|
Get Payor
|
|
75
91
|
|
|
76
92
|
Get a Single Payor by Id.
|
|
77
93
|
|
|
78
|
-
###
|
|
94
|
+
### Examples
|
|
79
95
|
|
|
80
96
|
```ruby
|
|
81
|
-
|
|
97
|
+
require 'time'
|
|
82
98
|
require 'velopayments'
|
|
83
99
|
# setup authorization
|
|
84
100
|
VeloPayments.configure do |config|
|
|
@@ -87,23 +103,40 @@ VeloPayments.configure do |config|
|
|
|
87
103
|
end
|
|
88
104
|
|
|
89
105
|
api_instance = VeloPayments::PayorsApi.new
|
|
90
|
-
payor_id =
|
|
106
|
+
payor_id = TODO # String | The Payor Id
|
|
91
107
|
|
|
92
108
|
begin
|
|
93
|
-
#Get Payor
|
|
109
|
+
# Get Payor
|
|
94
110
|
result = api_instance.get_payor_by_id_v2(payor_id)
|
|
95
111
|
p result
|
|
96
112
|
rescue VeloPayments::ApiError => e
|
|
97
|
-
puts "
|
|
113
|
+
puts "Error when calling PayorsApi->get_payor_by_id_v2: #{e}"
|
|
98
114
|
end
|
|
99
115
|
```
|
|
100
116
|
|
|
101
|
-
|
|
117
|
+
#### Using the get_payor_by_id_v2_with_http_info variant
|
|
118
|
+
|
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
120
|
+
|
|
121
|
+
> <Array(<PayorV2>, Integer, Hash)> get_payor_by_id_v2_with_http_info(payor_id)
|
|
122
|
+
|
|
123
|
+
```ruby
|
|
124
|
+
begin
|
|
125
|
+
# Get Payor
|
|
126
|
+
data, status_code, headers = api_instance.get_payor_by_id_v2_with_http_info(payor_id)
|
|
127
|
+
p status_code # => 2xx
|
|
128
|
+
p headers # => { ... }
|
|
129
|
+
p data # => <PayorV2>
|
|
130
|
+
rescue VeloPayments::ApiError => e
|
|
131
|
+
puts "Error when calling PayorsApi->get_payor_by_id_v2_with_http_info: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
102
134
|
|
|
135
|
+
### Parameters
|
|
103
136
|
|
|
104
|
-
Name | Type | Description
|
|
105
|
-
|
|
106
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
|
139
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
107
140
|
|
|
108
141
|
### Return type
|
|
109
142
|
|
|
@@ -127,10 +160,10 @@ Add Logo
|
|
|
127
160
|
|
|
128
161
|
Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
|
|
129
162
|
|
|
130
|
-
###
|
|
163
|
+
### Examples
|
|
131
164
|
|
|
132
165
|
```ruby
|
|
133
|
-
|
|
166
|
+
require 'time'
|
|
134
167
|
require 'velopayments'
|
|
135
168
|
# setup authorization
|
|
136
169
|
VeloPayments.configure do |config|
|
|
@@ -139,26 +172,43 @@ VeloPayments.configure do |config|
|
|
|
139
172
|
end
|
|
140
173
|
|
|
141
174
|
api_instance = VeloPayments::PayorsApi.new
|
|
142
|
-
payor_id =
|
|
175
|
+
payor_id = TODO # String | The Payor Id
|
|
143
176
|
opts = {
|
|
144
|
-
logo: File.new('/path/to/file') # File |
|
|
177
|
+
logo: File.new('/path/to/some/file') # File |
|
|
145
178
|
}
|
|
146
179
|
|
|
147
180
|
begin
|
|
148
|
-
#Add Logo
|
|
181
|
+
# Add Logo
|
|
149
182
|
api_instance.payor_add_payor_logo(payor_id, opts)
|
|
150
183
|
rescue VeloPayments::ApiError => e
|
|
151
|
-
puts "
|
|
184
|
+
puts "Error when calling PayorsApi->payor_add_payor_logo: #{e}"
|
|
152
185
|
end
|
|
153
186
|
```
|
|
154
187
|
|
|
155
|
-
|
|
188
|
+
#### Using the payor_add_payor_logo_with_http_info variant
|
|
189
|
+
|
|
190
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
191
|
+
|
|
192
|
+
> <Array(nil, Integer, Hash)> payor_add_payor_logo_with_http_info(payor_id, opts)
|
|
193
|
+
|
|
194
|
+
```ruby
|
|
195
|
+
begin
|
|
196
|
+
# Add Logo
|
|
197
|
+
data, status_code, headers = api_instance.payor_add_payor_logo_with_http_info(payor_id, opts)
|
|
198
|
+
p status_code # => 2xx
|
|
199
|
+
p headers # => { ... }
|
|
200
|
+
p data # => nil
|
|
201
|
+
rescue VeloPayments::ApiError => e
|
|
202
|
+
puts "Error when calling PayorsApi->payor_add_payor_logo_with_http_info: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
156
205
|
|
|
206
|
+
### Parameters
|
|
157
207
|
|
|
158
|
-
Name | Type | Description
|
|
159
|
-
|
|
160
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
161
|
-
**logo** | **File
|
|
208
|
+
| Name | Type | Description | Notes |
|
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
|
210
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
211
|
+
| **logo** | **File** | | [optional] |
|
|
162
212
|
|
|
163
213
|
### Return type
|
|
164
214
|
|
|
@@ -176,16 +226,16 @@ nil (empty response body)
|
|
|
176
226
|
|
|
177
227
|
## payor_create_api_key_request
|
|
178
228
|
|
|
179
|
-
> PayorCreateApiKeyResponse payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
|
|
229
|
+
> <PayorCreateApiKeyResponse> payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
|
|
180
230
|
|
|
181
231
|
Create API Key
|
|
182
232
|
|
|
183
233
|
Create an an API key for the given payor Id and application Id
|
|
184
234
|
|
|
185
|
-
###
|
|
235
|
+
### Examples
|
|
186
236
|
|
|
187
237
|
```ruby
|
|
188
|
-
|
|
238
|
+
require 'time'
|
|
189
239
|
require 'velopayments'
|
|
190
240
|
# setup authorization
|
|
191
241
|
VeloPayments.configure do |config|
|
|
@@ -194,27 +244,44 @@ VeloPayments.configure do |config|
|
|
|
194
244
|
end
|
|
195
245
|
|
|
196
246
|
api_instance = VeloPayments::PayorsApi.new
|
|
197
|
-
payor_id =
|
|
198
|
-
application_id =
|
|
199
|
-
payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new # PayorCreateApiKeyRequest | Details of application API key to create
|
|
247
|
+
payor_id = TODO # String | The Payor Id
|
|
248
|
+
application_id = TODO # String | Application ID
|
|
249
|
+
payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ['payor.admin']}) # PayorCreateApiKeyRequest | Details of application API key to create
|
|
200
250
|
|
|
201
251
|
begin
|
|
202
|
-
#Create API Key
|
|
252
|
+
# Create API Key
|
|
203
253
|
result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
|
|
204
254
|
p result
|
|
205
255
|
rescue VeloPayments::ApiError => e
|
|
206
|
-
puts "
|
|
256
|
+
puts "Error when calling PayorsApi->payor_create_api_key_request: #{e}"
|
|
207
257
|
end
|
|
208
258
|
```
|
|
209
259
|
|
|
210
|
-
|
|
260
|
+
#### Using the payor_create_api_key_request_with_http_info variant
|
|
261
|
+
|
|
262
|
+
This returns an Array which contains the response data, status code and headers.
|
|
263
|
+
|
|
264
|
+
> <Array(<PayorCreateApiKeyResponse>, Integer, Hash)> payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
|
|
265
|
+
|
|
266
|
+
```ruby
|
|
267
|
+
begin
|
|
268
|
+
# Create API Key
|
|
269
|
+
data, status_code, headers = api_instance.payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
|
|
270
|
+
p status_code # => 2xx
|
|
271
|
+
p headers # => { ... }
|
|
272
|
+
p data # => <PayorCreateApiKeyResponse>
|
|
273
|
+
rescue VeloPayments::ApiError => e
|
|
274
|
+
puts "Error when calling PayorsApi->payor_create_api_key_request_with_http_info: #{e}"
|
|
275
|
+
end
|
|
276
|
+
```
|
|
211
277
|
|
|
278
|
+
### Parameters
|
|
212
279
|
|
|
213
|
-
Name | Type | Description
|
|
214
|
-
|
|
215
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
216
|
-
**application_id** | [**String**](.md)| Application ID |
|
|
217
|
-
**payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md)| Details of application API key to create |
|
|
280
|
+
| Name | Type | Description | Notes |
|
|
281
|
+
| ---- | ---- | ----------- | ----- |
|
|
282
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
283
|
+
| **application_id** | [**String**](.md) | Application ID | |
|
|
284
|
+
| **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md) | Details of application API key to create | |
|
|
218
285
|
|
|
219
286
|
### Return type
|
|
220
287
|
|
|
@@ -238,10 +305,10 @@ Create Application
|
|
|
238
305
|
|
|
239
306
|
Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
|
|
240
307
|
|
|
241
|
-
###
|
|
308
|
+
### Examples
|
|
242
309
|
|
|
243
310
|
```ruby
|
|
244
|
-
|
|
311
|
+
require 'time'
|
|
245
312
|
require 'velopayments'
|
|
246
313
|
# setup authorization
|
|
247
314
|
VeloPayments.configure do |config|
|
|
@@ -250,24 +317,41 @@ VeloPayments.configure do |config|
|
|
|
250
317
|
end
|
|
251
318
|
|
|
252
319
|
api_instance = VeloPayments::PayorsApi.new
|
|
253
|
-
payor_id =
|
|
254
|
-
payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new # PayorCreateApplicationRequest | Details of application to create
|
|
320
|
+
payor_id = TODO # String | The Payor Id
|
|
321
|
+
payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new({name: 'SAP'}) # PayorCreateApplicationRequest | Details of application to create
|
|
255
322
|
|
|
256
323
|
begin
|
|
257
|
-
#Create Application
|
|
324
|
+
# Create Application
|
|
258
325
|
api_instance.payor_create_application_request(payor_id, payor_create_application_request)
|
|
259
326
|
rescue VeloPayments::ApiError => e
|
|
260
|
-
puts "
|
|
327
|
+
puts "Error when calling PayorsApi->payor_create_application_request: #{e}"
|
|
261
328
|
end
|
|
262
329
|
```
|
|
263
330
|
|
|
264
|
-
|
|
331
|
+
#### Using the payor_create_application_request_with_http_info variant
|
|
332
|
+
|
|
333
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
334
|
+
|
|
335
|
+
> <Array(nil, Integer, Hash)> payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
|
|
336
|
+
|
|
337
|
+
```ruby
|
|
338
|
+
begin
|
|
339
|
+
# Create Application
|
|
340
|
+
data, status_code, headers = api_instance.payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
|
|
341
|
+
p status_code # => 2xx
|
|
342
|
+
p headers # => { ... }
|
|
343
|
+
p data # => nil
|
|
344
|
+
rescue VeloPayments::ApiError => e
|
|
345
|
+
puts "Error when calling PayorsApi->payor_create_application_request_with_http_info: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
265
348
|
|
|
349
|
+
### Parameters
|
|
266
350
|
|
|
267
|
-
Name | Type | Description
|
|
268
|
-
|
|
269
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
270
|
-
**payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md)| Details of application to create |
|
|
351
|
+
| Name | Type | Description | Notes |
|
|
352
|
+
| ---- | ---- | ----------- | ----- |
|
|
353
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
354
|
+
| **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md) | Details of application to create | |
|
|
271
355
|
|
|
272
356
|
### Return type
|
|
273
357
|
|
|
@@ -291,10 +375,10 @@ Reminder Email Opt-Out
|
|
|
291
375
|
|
|
292
376
|
Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding.
|
|
293
377
|
|
|
294
|
-
###
|
|
378
|
+
### Examples
|
|
295
379
|
|
|
296
380
|
```ruby
|
|
297
|
-
|
|
381
|
+
require 'time'
|
|
298
382
|
require 'velopayments'
|
|
299
383
|
# setup authorization
|
|
300
384
|
VeloPayments.configure do |config|
|
|
@@ -303,24 +387,41 @@ VeloPayments.configure do |config|
|
|
|
303
387
|
end
|
|
304
388
|
|
|
305
389
|
api_instance = VeloPayments::PayorsApi.new
|
|
306
|
-
payor_id =
|
|
307
|
-
payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
|
|
390
|
+
payor_id = TODO # String | The Payor Id
|
|
391
|
+
payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new({reminder_emails_opt_out: false}) # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
|
|
308
392
|
|
|
309
393
|
begin
|
|
310
|
-
#Reminder Email Opt-Out
|
|
394
|
+
# Reminder Email Opt-Out
|
|
311
395
|
api_instance.payor_email_opt_out(payor_id, payor_email_opt_out_request)
|
|
312
396
|
rescue VeloPayments::ApiError => e
|
|
313
|
-
puts "
|
|
397
|
+
puts "Error when calling PayorsApi->payor_email_opt_out: #{e}"
|
|
314
398
|
end
|
|
315
399
|
```
|
|
316
400
|
|
|
317
|
-
|
|
401
|
+
#### Using the payor_email_opt_out_with_http_info variant
|
|
402
|
+
|
|
403
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
404
|
+
|
|
405
|
+
> <Array(nil, Integer, Hash)> payor_email_opt_out_with_http_info(payor_id, payor_email_opt_out_request)
|
|
406
|
+
|
|
407
|
+
```ruby
|
|
408
|
+
begin
|
|
409
|
+
# Reminder Email Opt-Out
|
|
410
|
+
data, status_code, headers = api_instance.payor_email_opt_out_with_http_info(payor_id, payor_email_opt_out_request)
|
|
411
|
+
p status_code # => 2xx
|
|
412
|
+
p headers # => { ... }
|
|
413
|
+
p data # => nil
|
|
414
|
+
rescue VeloPayments::ApiError => e
|
|
415
|
+
puts "Error when calling PayorsApi->payor_email_opt_out_with_http_info: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
318
418
|
|
|
419
|
+
### Parameters
|
|
319
420
|
|
|
320
|
-
Name | Type | Description
|
|
321
|
-
|
|
322
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
323
|
-
**payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md)| Reminder Emails Opt-Out Request |
|
|
421
|
+
| Name | Type | Description | Notes |
|
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
|
423
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
424
|
+
| **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md) | Reminder Emails Opt-Out Request | |
|
|
324
425
|
|
|
325
426
|
### Return type
|
|
326
427
|
|
|
@@ -338,16 +439,16 @@ nil (empty response body)
|
|
|
338
439
|
|
|
339
440
|
## payor_get_branding
|
|
340
441
|
|
|
341
|
-
> PayorBrandingResponse payor_get_branding(payor_id)
|
|
442
|
+
> <PayorBrandingResponse> payor_get_branding(payor_id)
|
|
342
443
|
|
|
343
444
|
Get Branding
|
|
344
445
|
|
|
345
446
|
Get the payor branding details.
|
|
346
447
|
|
|
347
|
-
###
|
|
448
|
+
### Examples
|
|
348
449
|
|
|
349
450
|
```ruby
|
|
350
|
-
|
|
451
|
+
require 'time'
|
|
351
452
|
require 'velopayments'
|
|
352
453
|
# setup authorization
|
|
353
454
|
VeloPayments.configure do |config|
|
|
@@ -356,23 +457,40 @@ VeloPayments.configure do |config|
|
|
|
356
457
|
end
|
|
357
458
|
|
|
358
459
|
api_instance = VeloPayments::PayorsApi.new
|
|
359
|
-
payor_id =
|
|
460
|
+
payor_id = TODO # String | The Payor Id
|
|
360
461
|
|
|
361
462
|
begin
|
|
362
|
-
#Get Branding
|
|
463
|
+
# Get Branding
|
|
363
464
|
result = api_instance.payor_get_branding(payor_id)
|
|
364
465
|
p result
|
|
365
466
|
rescue VeloPayments::ApiError => e
|
|
366
|
-
puts "
|
|
467
|
+
puts "Error when calling PayorsApi->payor_get_branding: #{e}"
|
|
367
468
|
end
|
|
368
469
|
```
|
|
369
470
|
|
|
370
|
-
|
|
471
|
+
#### Using the payor_get_branding_with_http_info variant
|
|
472
|
+
|
|
473
|
+
This returns an Array which contains the response data, status code and headers.
|
|
474
|
+
|
|
475
|
+
> <Array(<PayorBrandingResponse>, Integer, Hash)> payor_get_branding_with_http_info(payor_id)
|
|
476
|
+
|
|
477
|
+
```ruby
|
|
478
|
+
begin
|
|
479
|
+
# Get Branding
|
|
480
|
+
data, status_code, headers = api_instance.payor_get_branding_with_http_info(payor_id)
|
|
481
|
+
p status_code # => 2xx
|
|
482
|
+
p headers # => { ... }
|
|
483
|
+
p data # => <PayorBrandingResponse>
|
|
484
|
+
rescue VeloPayments::ApiError => e
|
|
485
|
+
puts "Error when calling PayorsApi->payor_get_branding_with_http_info: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
371
488
|
|
|
489
|
+
### Parameters
|
|
372
490
|
|
|
373
|
-
Name | Type | Description
|
|
374
|
-
|
|
375
|
-
**payor_id** | [**String**](.md)| The Payor Id |
|
|
491
|
+
| Name | Type | Description | Notes |
|
|
492
|
+
| ---- | ---- | ----------- | ----- |
|
|
493
|
+
| **payor_id** | [**String**](.md) | The Payor Id | |
|
|
376
494
|
|
|
377
495
|
### Return type
|
|
378
496
|
|
|
@@ -390,16 +508,16 @@ Name | Type | Description | Notes
|
|
|
390
508
|
|
|
391
509
|
## payor_links
|
|
392
510
|
|
|
393
|
-
> PayorLinksResponse payor_links(opts)
|
|
511
|
+
> <PayorLinksResponse> payor_links(opts)
|
|
394
512
|
|
|
395
513
|
List Payor Links
|
|
396
514
|
|
|
397
515
|
This endpoint allows you to list payor links
|
|
398
516
|
|
|
399
|
-
###
|
|
517
|
+
### Examples
|
|
400
518
|
|
|
401
519
|
```ruby
|
|
402
|
-
|
|
520
|
+
require 'time'
|
|
403
521
|
require 'velopayments'
|
|
404
522
|
# setup authorization
|
|
405
523
|
VeloPayments.configure do |config|
|
|
@@ -409,28 +527,45 @@ end
|
|
|
409
527
|
|
|
410
528
|
api_instance = VeloPayments::PayorsApi.new
|
|
411
529
|
opts = {
|
|
412
|
-
descendants_of_payor:
|
|
413
|
-
parent_of_payor:
|
|
530
|
+
descendants_of_payor: TODO, # String | The Payor ID from which to start the query to show all descendants
|
|
531
|
+
parent_of_payor: TODO, # String | Look for the parent payor details for this payor id
|
|
414
532
|
fields: 'fields_example' # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState
|
|
415
533
|
}
|
|
416
534
|
|
|
417
535
|
begin
|
|
418
|
-
#List Payor Links
|
|
536
|
+
# List Payor Links
|
|
419
537
|
result = api_instance.payor_links(opts)
|
|
420
538
|
p result
|
|
421
539
|
rescue VeloPayments::ApiError => e
|
|
422
|
-
puts "
|
|
540
|
+
puts "Error when calling PayorsApi->payor_links: #{e}"
|
|
423
541
|
end
|
|
424
542
|
```
|
|
425
543
|
|
|
426
|
-
|
|
544
|
+
#### Using the payor_links_with_http_info variant
|
|
545
|
+
|
|
546
|
+
This returns an Array which contains the response data, status code and headers.
|
|
547
|
+
|
|
548
|
+
> <Array(<PayorLinksResponse>, Integer, Hash)> payor_links_with_http_info(opts)
|
|
549
|
+
|
|
550
|
+
```ruby
|
|
551
|
+
begin
|
|
552
|
+
# List Payor Links
|
|
553
|
+
data, status_code, headers = api_instance.payor_links_with_http_info(opts)
|
|
554
|
+
p status_code # => 2xx
|
|
555
|
+
p headers # => { ... }
|
|
556
|
+
p data # => <PayorLinksResponse>
|
|
557
|
+
rescue VeloPayments::ApiError => e
|
|
558
|
+
puts "Error when calling PayorsApi->payor_links_with_http_info: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
427
561
|
|
|
562
|
+
### Parameters
|
|
428
563
|
|
|
429
|
-
Name | Type | Description
|
|
430
|
-
|
|
431
|
-
**descendants_of_payor** | [**String**](.md)| The Payor ID from which to start the query to show all descendants | [optional]
|
|
432
|
-
**parent_of_payor** | [**String**](.md)| Look for the parent payor details for this payor id | [optional]
|
|
433
|
-
**fields** | **String
|
|
564
|
+
| Name | Type | Description | Notes |
|
|
565
|
+
| ---- | ---- | ----------- | ----- |
|
|
566
|
+
| **descendants_of_payor** | [**String**](.md) | The Payor ID from which to start the query to show all descendants | [optional] |
|
|
567
|
+
| **parent_of_payor** | [**String**](.md) | Look for the parent payor details for this payor id | [optional] |
|
|
568
|
+
| **fields** | **String** | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState | [optional] |
|
|
434
569
|
|
|
435
570
|
### Return type
|
|
436
571
|
|