velopayments 2.19.40.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/Dockerfile +7 -0
- data/Gemfile +1 -1
- data/Makefile +7 -12
- data/README.md +164 -101
- data/docs/AcceptedPaymentV3.md +32 -0
- 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 +24 -0
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +20 -0
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +91 -38
- data/docs/CreateFundingAccountRequestV2.md +30 -0
- 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 +24 -0
- data/docs/CreateWebhookRequest.md +26 -0
- data/docs/CurrenciesApi.md +29 -12
- 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 -17
- data/docs/FundingAccountResponse2.md +36 -0
- data/docs/FundingAccountType.md +15 -0
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +772 -185
- data/docs/FundingManagerPrivateApi.md +101 -16
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +20 -0
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +20 -0
- data/docs/GetPayeeListResponse.md +50 -0
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +20 -0
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +18 -0
- 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 -41
- 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 +22 -0
- data/docs/InlineResponse409.md +22 -0
- data/docs/InlineResponse412.md +22 -0
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +15 -0
- 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 +22 -0
- data/docs/ListPaymentsResponseV3.md +22 -0
- data/docs/ListPaymentsResponseV3Page.md +26 -0
- 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 +20 -0
- data/docs/ListSourceAccountResponseV3.md +22 -0
- data/docs/ListSourceAccountResponseV3Links.md +20 -0
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +113 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +24 -0
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +18 -0
- 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 +22 -0
- 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 +74 -0
- data/docs/PayeeDetailResponse2.md +74 -0
- 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 +258 -176
- 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 +28 -0
- data/docs/PayeesApi.md +479 -219
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +280 -437
- 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 +34 -0
- 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 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +42 -0
- 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 -47
- data/docs/PayorV2.md +52 -45
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +18 -0
- data/docs/PayoutIndividualV3.md +18 -0
- data/docs/PayoutNameV3.md +20 -0
- data/docs/PayoutPayeeV3.md +22 -0
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +513 -0
- 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 +36 -0
- 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 +38 -0
- data/docs/QuoteResponseV3.md +18 -0
- data/docs/RegionV2.md +20 -0
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +38 -0
- 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 -31
- data/docs/SourceAccountResponseV2.md +38 -35
- data/docs/SourceAccountResponseV3.md +52 -0
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +15 -0
- data/docs/SourceAccountV3.md +24 -0
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +18 -0
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +22 -0
- data/docs/SupportedCurrencyResponseV2.md +18 -0
- data/docs/SupportedCurrencyV2.md +20 -0
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +22 -0
- data/docs/TransmissionType.md +15 -0
- data/docs/TransmissionTypes.md +22 -0
- data/docs/TransmissionTypes2.md +22 -0
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +30 -0
- data/docs/UpdatePayeeDetailsRequest2.md +30 -0
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +24 -0
- 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 +526 -181
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +15 -0
- data/docs/WebhookResponse.md +28 -0
- data/docs/WebhooksApi.md +297 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- data/lib/velopayments.rb +110 -70
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +519 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +77 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +100 -154
- data/lib/velopayments/api/payees_api.rb +299 -203
- data/lib/velopayments/api/payment_audit_service_api.rb +153 -459
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +513 -0
- data/lib/velopayments/api/tokens_api.rb +6 -5
- data/lib/velopayments/api/users_api.rb +146 -54
- data/lib/velopayments/api/webhooks_api.rb +291 -0
- data/lib/velopayments/api_client.rb +51 -47
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +40 -11
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +57 -15
- data/lib/velopayments/models/access_token_response.rb +20 -8
- data/lib/velopayments/models/access_token_validation_request.rb +20 -8
- data/lib/velopayments/models/auth_response.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
- data/lib/velopayments/models/{language.rb → category.rb} +9 -16
- data/lib/velopayments/models/challenge.rb +20 -8
- data/lib/velopayments/models/challenge2.rb +293 -0
- data/lib/velopayments/models/company.rb +25 -13
- data/lib/velopayments/models/company2.rb +25 -13
- data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
- data/lib/velopayments/models/create_individual.rb +21 -9
- data/lib/velopayments/models/create_individual2.rb +21 -9
- data/lib/velopayments/models/{create_individual2_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +24 -11
- data/lib/velopayments/models/create_payee2.rb +25 -12
- data/lib/velopayments/models/create_payee_address.rb +53 -25
- data/lib/velopayments/models/create_payee_address2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
- data/lib/velopayments/models/create_payees_request.rb +20 -8
- data/lib/velopayments/models/create_payees_request2.rb +20 -8
- data/lib/velopayments/models/create_payment_channel.rb +20 -8
- data/lib/velopayments/models/create_payment_channel2.rb +20 -8
- data/lib/velopayments/models/create_payor_link_request.rb +20 -8
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
- data/lib/velopayments/models/create_webhook_request.rb +338 -0
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/debit_event_all_of.rb +224 -0
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/error.rb +54 -14
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +49 -14
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +104 -69
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +21 -9
- data/lib/velopayments/models/failed_submission2.rb +21 -9
- data/lib/velopayments/models/funding_account_response.rb +115 -12
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
- data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
- data/lib/velopayments/models/funding_audit.rb +33 -19
- data/lib/velopayments/models/funding_event.rb +21 -9
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
- data/lib/velopayments/models/funding_request_v1.rb +20 -8
- data/lib/velopayments/models/funding_request_v2.rb +20 -8
- data/lib/velopayments/models/{payor_logo_request.rb → funding_request_v3.rb} +79 -18
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
- data/lib/velopayments/models/fx_summary_v3.rb +21 -9
- data/lib/velopayments/models/get_fundings_response.rb +23 -18
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +96 -115
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +97 -116
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
- data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
- data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +43 -56
- data/lib/velopayments/models/get_payout_statistics.rb +20 -8
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
- data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
- data/lib/velopayments/models/individual.rb +21 -9
- data/lib/velopayments/models/individual2.rb +21 -9
- data/lib/velopayments/models/{individual_v1_name.rb → individual_name.rb} +23 -11
- data/lib/velopayments/models/inline_response400.rb +51 -14
- data/lib/velopayments/models/inline_response401.rb +51 -14
- data/lib/velopayments/models/inline_response403.rb +51 -14
- data/lib/velopayments/models/inline_response404.rb +258 -0
- data/lib/velopayments/models/inline_response409.rb +258 -0
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invite_payee_request.rb +20 -8
- data/lib/velopayments/models/invite_payee_request2.rb +20 -8
- data/lib/velopayments/models/invite_user_request.rb +29 -17
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
- data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +23 -11
- data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
- data/lib/velopayments/models/list_source_account_response.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
- data/lib/velopayments/models/{invitation_status_response.rb → list_source_account_response_v2_links.rb} +39 -25
- data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +20 -8
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +341 -0
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +77 -58
- data/lib/velopayments/models/notifications.rb +20 -8
- data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/{inline_response400_errors.rb → onboarding_status_changed.rb} +92 -39
- data/lib/velopayments/models/page_for_response.rb +20 -8
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response.rb +21 -9
- data/lib/velopayments/models/paged_payee_response2.rb +22 -10
- data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
- data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
- data/lib/velopayments/models/paged_user_response.rb +20 -8
- data/lib/velopayments/models/paged_user_response_links.rb +20 -8
- data/lib/velopayments/models/paged_user_response_page.rb +20 -8
- data/lib/velopayments/models/password_request.rb +20 -8
- 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 +20 -8
- data/lib/velopayments/models/payee_address2.rb +20 -8
- data/lib/velopayments/models/payee_delta.rb +21 -9
- data/lib/velopayments/models/payee_delta2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +45 -23
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +77 -64
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
- 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 +20 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/payee_payor_ref.rb +66 -12
- data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +20 -8
- data/lib/velopayments/models/payment_channel_rule.rb +20 -8
- data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
- data/lib/velopayments/models/payment_delta.rb +20 -8
- data/lib/velopayments/models/payment_delta_response.rb +20 -8
- data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
- data/lib/velopayments/models/payment_delta_v1.rb +297 -0
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/{paged_response_page.rb → payment_event_all_of.rb} +49 -48
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
- data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +148 -16
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
- data/lib/velopayments/models/{inline_response403_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
- data/lib/velopayments/models/payment_response_v3.rb +21 -9
- data/lib/velopayments/models/payment_response_v4.rb +101 -13
- data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/payment_v3.rb +389 -0
- data/lib/velopayments/models/payor_address.rb +20 -8
- data/lib/velopayments/models/payor_address_v2.rb +20 -8
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
- data/lib/velopayments/models/payor_branding_response.rb +20 -8
- data/lib/velopayments/models/payor_create_api_key_request.rb +30 -8
- data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
- data/lib/velopayments/models/payor_create_application_request.rb +20 -8
- data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
- data/lib/velopayments/models/payor_links_response.rb +20 -8
- data/lib/velopayments/models/payor_links_response_links.rb +20 -8
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +55 -12
- data/lib/velopayments/models/payout_company_v3.rb +223 -0
- data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
- data/lib/velopayments/models/payout_name_v3.rb +237 -0
- data/lib/velopayments/models/payout_payee_v3.rb +242 -0
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +39 -18
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +42 -16
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/ping.rb +262 -0
- data/lib/velopayments/models/query_batch_response.rb +20 -8
- data/lib/velopayments/models/query_batch_response2.rb +20 -8
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +49 -13
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
- data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
- data/lib/velopayments/models/register_sms_request.rb +23 -11
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +54 -12
- data/lib/velopayments/models/resend_token_request.rb +20 -8
- data/lib/velopayments/models/reset_password_request.rb +20 -8
- data/lib/velopayments/models/role.rb +20 -8
- data/lib/velopayments/models/role_update_request.rb +20 -8
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
- data/lib/velopayments/models/self_update_password_request.rb +20 -8
- data/lib/velopayments/models/set_notifications_request.rb +20 -8
- data/lib/velopayments/models/source_account_response.rb +34 -13
- data/lib/velopayments/models/source_account_response_v2.rb +36 -15
- data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
- data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +63 -11
- data/lib/velopayments/models/source_event.rb +255 -0
- data/lib/velopayments/models/supported_countries_response.rb +20 -8
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_country.rb +51 -37
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +55 -41
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_currency_v2.rb +264 -0
- data/lib/velopayments/models/transfer_request.rb +20 -8
- data/lib/velopayments/models/transfer_request2.rb +309 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{supported_currency.rb → transmission_types.rb} +63 -26
- data/lib/velopayments/models/{currency_type.rb → transmission_types2.rb} +60 -45
- data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
- data/lib/velopayments/models/update_payee_details_request.rb +275 -0
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → update_payee_details_request2.rb} +75 -42
- data/lib/velopayments/models/update_remote_id_request.rb +20 -8
- data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
- data/lib/velopayments/models/update_webhook_request.rb +312 -0
- data/lib/velopayments/models/user_details_update_request.rb +29 -17
- data/lib/velopayments/models/user_info.rb +20 -8
- data/lib/velopayments/models/user_response.rb +45 -18
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +20 -8
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
- data/lib/velopayments/models/webhook_response.rb +265 -0
- data/lib/velopayments/models/webhooks_response.rb +241 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +94 -18
- data/spec/api/funding_manager_private_api_spec.rb +17 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +23 -35
- data/spec/api/payees_api_spec.rb +63 -47
- data/spec/api/payment_audit_service_api_spec.rb +28 -112
- data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/{models/payee2_spec.rb → api/payout_service_api_spec.rb} +66 -103
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +17 -4
- data/spec/api/webhooks_api_spec.rb +86 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +76 -0
- 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/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
- 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/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
- 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/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
- 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_spec.rb → create_payout_request_v3_spec.rb} +8 -21
- data/spec/models/create_webhook_request_spec.rb +58 -0
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/debit_event_spec.rb +52 -0
- data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{marketing_opt_in_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 +88 -0
- data/spec/models/funding_account_response_spec.rb +29 -12
- data/spec/models/{language2_spec.rb → funding_account_type_spec.rb} +8 -15
- data/spec/models/funding_audit_spec.rb +14 -21
- 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 +40 -0
- 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 +40 -0
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
- data/spec/models/{user_response2_roles_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
- data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
- 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 +11 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
- 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/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
- data/spec/models/inline_response409_spec.rb +46 -0
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/{ofac_status2_spec.rb → invitation_status2_spec.rb} +8 -15
- 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_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
- data/spec/models/list_payments_response_v3_spec.rb +46 -0
- 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 +40 -0
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v3_spec.rb +46 -0
- data/spec/models/localisation_details_spec.rb +40 -0
- 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 +52 -0
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +34 -0
- 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/{list_payments_response_page_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/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
- 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_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
- 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_response400_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 -16
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
- data/spec/models/{location_type_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_v1_spec.rb +46 -0
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/payment_delta_v1_spec.rb +76 -0
- data/spec/models/payment_event_all_of_spec.rb +46 -0
- 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/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
- data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
- 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/payment_rejected_or_returned_spec.rb +82 -0
- 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 +55 -14
- data/spec/models/{payor_logo_request_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/payment_v3_spec.rb +110 -0
- 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 +12 -13
- data/spec/models/payor_v2_spec.rb +24 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{individual_response_spec.rb → payout_individual_v3_spec.rb} +8 -15
- data/spec/models/payout_name_v3_spec.rb +40 -0
- data/spec/models/payout_payee_v3_spec.rb +46 -0
- data/spec/models/payout_payor_ids_spec.rb +46 -0
- 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/payout_status_spec.rb +28 -0
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +14 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -15
- data/spec/models/payout_type_spec.rb +28 -0
- 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_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +94 -0
- 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 +12 -13
- data/spec/models/source_account_response_v2_spec.rb +12 -13
- data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
- 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 +28 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
- 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 +34 -0
- data/spec/models/supported_country_spec.rb +5 -20
- data/spec/models/supported_country_v2_spec.rb +46 -0
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
- data/spec/models/transfer_request2_spec.rb +46 -0
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +28 -0
- data/spec/models/transmission_types2_spec.rb +46 -0
- data/spec/models/transmission_types_spec.rb +46 -0
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +70 -0
- data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request_spec.rb} +15 -26
- 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 +52 -0
- 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 +28 -0
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +64 -0
- data/spec/models/webhooks_response_spec.rb +46 -0
- data/spec/models/withdraw_payment_request_spec.rb +34 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +103 -0
- data/{spec/api/quote_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
- data/specs/api/funding_manager_api_spec.rb +372 -0
- data/{spec/api/get_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +15 -15
- data/specs/api/login_api_spec.rb +82 -0
- data/specs/api/payee_invitation_api_spec.rb +161 -0
- data/specs/api/payees_api_spec.rb +186 -0
- data/specs/api/payment_audit_service_api_spec.rb +318 -0
- data/specs/api/payors_api_spec.rb +171 -0
- data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/{spec/api/withdraw_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +15 -14
- data/specs/api/users_api_spec.rb +284 -0
- data/velopayments.gemspec +3 -4
- metadata +449 -295
- data/docs/AcceptedPayment.md +0 -27
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/CreatePayoutRequest.md +0 -25
- data/docs/CurrencyType.md +0 -17
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- 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/InstructPayoutApi.md +0 -60
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/ListPaymentsResponse.md +0 -21
- data/docs/ListPaymentsResponsePage.md +0 -25
- 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/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.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/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeResponseV3.md +0 -71
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PaymentInstruction.md +0 -27
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -45
- data/docs/PayoutSummaryResponse.md +0 -33
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/QuoteFxSummary.md +0 -37
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/Region.md +0 -19
- data/docs/RejectedPayment.md +0 -33
- data/docs/SourceAccount.md +0 -23
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCountry2.md +0 -21
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1148
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1148
- data/lib/velopayments/models/inline_response401_errors.rb +0 -236
- data/lib/velopayments/models/language2.rb +0 -45
- data/lib/velopayments/models/payee2.rb +0 -456
- data/lib/velopayments/models/payee_response.rb +0 -388
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- 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/get_fundings_response_all_of_spec.rb +0 -41
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- data/spec/models/paged_payee_response2_summary_spec.rb +0 -65
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
- data/spec/models/supported_countries_response2_spec.rb +0 -41
- data/spec/models/supported_country2_spec.rb +0 -61
- data/spec/models/user_response2_spec.rb +0 -137
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -22,24 +22,24 @@ module VeloPayments
|
|
22
22
|
# Create Funding Account
|
23
23
|
# Create Funding Account
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [
|
25
|
+
# @option opts [CreateFundingAccountRequestV2] :create_funding_account_request_v2
|
26
26
|
# @return [nil]
|
27
|
-
def
|
28
|
-
|
27
|
+
def create_funding_account_v2(opts = {})
|
28
|
+
create_funding_account_v2_with_http_info(opts)
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Funding Account
|
33
33
|
# Create Funding Account
|
34
34
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @option opts [
|
35
|
+
# @option opts [CreateFundingAccountRequestV2] :create_funding_account_request_v2
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
-
def
|
37
|
+
def create_funding_account_v2_with_http_info(opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: FundingManagerPrivateApi.
|
39
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerPrivateApi.create_funding_account_v2 ...'
|
40
40
|
end
|
41
41
|
# resource path
|
42
|
-
local_var_path = '/
|
42
|
+
local_var_path = '/v2/fundingAccounts'
|
43
43
|
|
44
44
|
# query parameters
|
45
45
|
query_params = opts[:query_params] || {}
|
@@ -55,15 +55,16 @@ module VeloPayments
|
|
55
55
|
form_params = opts[:form_params] || {}
|
56
56
|
|
57
57
|
# http body (model)
|
58
|
-
post_body = opts[:
|
58
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_funding_account_request_v2'])
|
59
59
|
|
60
60
|
# return_type
|
61
|
-
return_type = opts[:
|
61
|
+
return_type = opts[:debug_return_type]
|
62
62
|
|
63
63
|
# auth_names
|
64
|
-
auth_names = opts[:
|
64
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
65
65
|
|
66
66
|
new_options = opts.merge(
|
67
|
+
:operation => :"FundingManagerPrivateApi.create_funding_account_v2",
|
67
68
|
:header_params => header_params,
|
68
69
|
:query_params => query_params,
|
69
70
|
:form_params => form_params,
|
@@ -74,7 +75,70 @@ module VeloPayments
|
|
74
75
|
|
75
76
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
77
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called: FundingManagerPrivateApi#
|
78
|
+
@api_client.config.logger.debug "API called: FundingManagerPrivateApi#create_funding_account_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
return data, status_code, headers
|
81
|
+
end
|
82
|
+
|
83
|
+
# Delete a source account by ID
|
84
|
+
# Mark a source account as deleted by ID
|
85
|
+
# @param source_account_id [String] Source account id
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @return [nil]
|
88
|
+
def delete_source_account_v3(source_account_id, opts = {})
|
89
|
+
delete_source_account_v3_with_http_info(source_account_id, opts)
|
90
|
+
nil
|
91
|
+
end
|
92
|
+
|
93
|
+
# Delete a source account by ID
|
94
|
+
# Mark a source account as deleted by ID
|
95
|
+
# @param source_account_id [String] Source account id
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
98
|
+
def delete_source_account_v3_with_http_info(source_account_id, opts = {})
|
99
|
+
if @api_client.config.debugging
|
100
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerPrivateApi.delete_source_account_v3 ...'
|
101
|
+
end
|
102
|
+
# verify the required parameter 'source_account_id' is set
|
103
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
104
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerPrivateApi.delete_source_account_v3"
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/v3/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s))
|
108
|
+
|
109
|
+
# query parameters
|
110
|
+
query_params = opts[:query_params] || {}
|
111
|
+
|
112
|
+
# header parameters
|
113
|
+
header_params = opts[:header_params] || {}
|
114
|
+
# HTTP header 'Accept' (if needed)
|
115
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
116
|
+
|
117
|
+
# form parameters
|
118
|
+
form_params = opts[:form_params] || {}
|
119
|
+
|
120
|
+
# http body (model)
|
121
|
+
post_body = opts[:debug_body]
|
122
|
+
|
123
|
+
# return_type
|
124
|
+
return_type = opts[:debug_return_type]
|
125
|
+
|
126
|
+
# auth_names
|
127
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
128
|
+
|
129
|
+
new_options = opts.merge(
|
130
|
+
:operation => :"FundingManagerPrivateApi.delete_source_account_v3",
|
131
|
+
:header_params => header_params,
|
132
|
+
:query_params => query_params,
|
133
|
+
:form_params => form_params,
|
134
|
+
:body => post_body,
|
135
|
+
:auth_names => auth_names,
|
136
|
+
:return_type => return_type
|
137
|
+
)
|
138
|
+
|
139
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: FundingManagerPrivateApi#delete_source_account_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
142
|
end
|
79
143
|
return data, status_code, headers
|
80
144
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -51,15 +51,16 @@ module VeloPayments
|
|
51
51
|
form_params = opts[:form_params] || {}
|
52
52
|
|
53
53
|
# http body (model)
|
54
|
-
post_body = opts[:
|
54
|
+
post_body = opts[:debug_body]
|
55
55
|
|
56
56
|
# return_type
|
57
|
-
return_type = opts[:
|
57
|
+
return_type = opts[:debug_return_type]
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:
|
60
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
|
+
:operation => :"LoginApi.logout",
|
63
64
|
:header_params => header_params,
|
64
65
|
:query_params => query_params,
|
65
66
|
:form_params => form_params,
|
@@ -115,15 +116,16 @@ module VeloPayments
|
|
115
116
|
form_params = opts[:form_params] || {}
|
116
117
|
|
117
118
|
# http body (model)
|
118
|
-
post_body = opts[:
|
119
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(reset_password_request)
|
119
120
|
|
120
121
|
# return_type
|
121
|
-
return_type = opts[:
|
122
|
+
return_type = opts[:debug_return_type]
|
122
123
|
|
123
124
|
# auth_names
|
124
|
-
auth_names = opts[:
|
125
|
+
auth_names = opts[:debug_auth_names] || []
|
125
126
|
|
126
127
|
new_options = opts.merge(
|
128
|
+
:operation => :"LoginApi.reset_password",
|
127
129
|
:header_params => header_params,
|
128
130
|
:query_params => query_params,
|
129
131
|
:form_params => form_params,
|
@@ -143,6 +145,7 @@ module VeloPayments
|
|
143
145
|
# <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
|
144
146
|
# @param access_token_validation_request [AccessTokenValidationRequest] An OTP from the user's registered MFA Device
|
145
147
|
# @param [Hash] opts the optional parameters
|
148
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
146
149
|
# @return [AccessTokenResponse]
|
147
150
|
def validate_access_token(access_token_validation_request, opts = {})
|
148
151
|
data, _status_code, _headers = validate_access_token_with_http_info(access_token_validation_request, opts)
|
@@ -153,6 +156,7 @@ module VeloPayments
|
|
153
156
|
# <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
|
154
157
|
# @param access_token_validation_request [AccessTokenValidationRequest] An OTP from the user's registered MFA Device
|
155
158
|
# @param [Hash] opts the optional parameters
|
159
|
+
# @option opts [String] :authorization Bearer token authorization leg of validate
|
156
160
|
# @return [Array<(AccessTokenResponse, Integer, Hash)>] AccessTokenResponse data, response status code and response headers
|
157
161
|
def validate_access_token_with_http_info(access_token_validation_request, opts = {})
|
158
162
|
if @api_client.config.debugging
|
@@ -174,20 +178,22 @@ module VeloPayments
|
|
174
178
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
175
179
|
# HTTP header 'Content-Type'
|
176
180
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
181
|
+
header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
|
177
182
|
|
178
183
|
# form parameters
|
179
184
|
form_params = opts[:form_params] || {}
|
180
185
|
|
181
186
|
# http body (model)
|
182
|
-
post_body = opts[:
|
187
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(access_token_validation_request)
|
183
188
|
|
184
189
|
# return_type
|
185
|
-
return_type = opts[:
|
190
|
+
return_type = opts[:debug_return_type] || 'AccessTokenResponse'
|
186
191
|
|
187
192
|
# auth_names
|
188
|
-
auth_names = opts[:
|
193
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
189
194
|
|
190
195
|
new_options = opts.merge(
|
196
|
+
:operation => :"LoginApi.validate_access_token",
|
191
197
|
:header_params => header_params,
|
192
198
|
:query_params => query_params,
|
193
199
|
:form_params => form_params,
|
@@ -238,15 +244,16 @@ module VeloPayments
|
|
238
244
|
form_params = opts[:form_params] || {}
|
239
245
|
|
240
246
|
# http body (model)
|
241
|
-
post_body = opts[:
|
247
|
+
post_body = opts[:debug_body]
|
242
248
|
|
243
249
|
# return_type
|
244
|
-
return_type = opts[:
|
250
|
+
return_type = opts[:debug_return_type] || 'AuthResponse'
|
245
251
|
|
246
252
|
# auth_names
|
247
|
-
auth_names = opts[:
|
253
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
248
254
|
|
249
255
|
new_options = opts.merge(
|
256
|
+
:operation => :"LoginApi.velo_auth",
|
250
257
|
:header_params => header_params,
|
251
258
|
:query_params => query_params,
|
252
259
|
:form_params => form_params,
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,69 +20,7 @@ module VeloPayments
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Payee Invitation Status
|
23
|
-
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
24
|
-
# @param payor_id [String] The account owner Payor ID
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [InvitationStatusResponse]
|
27
|
-
def get_payees_invitation_status_v1(payor_id, opts = {})
|
28
|
-
data, _status_code, _headers = get_payees_invitation_status_v1_with_http_info(payor_id, opts)
|
29
|
-
data
|
30
|
-
end
|
31
|
-
|
32
|
-
# Get Payee Invitation Status
|
33
|
-
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
34
|
-
# @param payor_id [String] The account owner Payor ID
|
35
|
-
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(InvitationStatusResponse, Integer, Hash)>] InvitationStatusResponse data, response status code and response headers
|
37
|
-
def get_payees_invitation_status_v1_with_http_info(payor_id, opts = {})
|
38
|
-
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v1 ...'
|
40
|
-
end
|
41
|
-
# verify the required parameter 'payor_id' is set
|
42
|
-
if @api_client.config.client_side_validation && payor_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v1"
|
44
|
-
end
|
45
|
-
# resource path
|
46
|
-
local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
47
|
-
|
48
|
-
# query parameters
|
49
|
-
query_params = opts[:query_params] || {}
|
50
|
-
|
51
|
-
# header parameters
|
52
|
-
header_params = opts[:header_params] || {}
|
53
|
-
# HTTP header 'Accept' (if needed)
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
-
|
56
|
-
# form parameters
|
57
|
-
form_params = opts[:form_params] || {}
|
58
|
-
|
59
|
-
# http body (model)
|
60
|
-
post_body = opts[:body]
|
61
|
-
|
62
|
-
# return_type
|
63
|
-
return_type = opts[:return_type] || 'InvitationStatusResponse'
|
64
|
-
|
65
|
-
# auth_names
|
66
|
-
auth_names = opts[:auth_names] || ['OAuth2']
|
67
|
-
|
68
|
-
new_options = opts.merge(
|
69
|
-
:header_params => header_params,
|
70
|
-
:query_params => query_params,
|
71
|
-
:form_params => form_params,
|
72
|
-
:body => post_body,
|
73
|
-
:auth_names => auth_names,
|
74
|
-
:return_type => return_type
|
75
|
-
)
|
76
|
-
|
77
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
78
|
-
if @api_client.config.debugging
|
79
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
|
-
end
|
81
|
-
return data, status_code, headers
|
82
|
-
end
|
83
|
-
|
84
|
-
# Get Payee Invitation Status
|
85
|
-
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
23
|
+
# <p>Use v4 instead</p> <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
86
24
|
# @param payor_id [String] The account owner Payor ID
|
87
25
|
# @param [Hash] opts the optional parameters
|
88
26
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -90,13 +28,13 @@ module VeloPayments
|
|
90
28
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
91
29
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
92
30
|
# @return [PagedPayeeInvitationStatusResponse]
|
93
|
-
def
|
94
|
-
data, _status_code, _headers =
|
31
|
+
def get_payees_invitation_status_v3(payor_id, opts = {})
|
32
|
+
data, _status_code, _headers = get_payees_invitation_status_v3_with_http_info(payor_id, opts)
|
95
33
|
data
|
96
34
|
end
|
97
35
|
|
98
36
|
# Get Payee Invitation Status
|
99
|
-
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
37
|
+
# <p>Use v4 instead</p> <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
|
100
38
|
# @param payor_id [String] The account owner Payor ID
|
101
39
|
# @param [Hash] opts the optional parameters
|
102
40
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -104,16 +42,16 @@ module VeloPayments
|
|
104
42
|
# @option opts [Integer] :page Page number. Default is 1.
|
105
43
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
106
44
|
# @return [Array<(PagedPayeeInvitationStatusResponse, Integer, Hash)>] PagedPayeeInvitationStatusResponse data, response status code and response headers
|
107
|
-
def
|
45
|
+
def get_payees_invitation_status_v3_with_http_info(payor_id, opts = {})
|
108
46
|
if @api_client.config.debugging
|
109
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
47
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v3 ...'
|
110
48
|
end
|
111
49
|
# verify the required parameter 'payor_id' is set
|
112
50
|
if @api_client.config.client_side_validation && payor_id.nil?
|
113
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.
|
51
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v3"
|
114
52
|
end
|
115
53
|
# resource path
|
116
|
-
local_var_path = '/
|
54
|
+
local_var_path = '/v3/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
117
55
|
|
118
56
|
# query parameters
|
119
57
|
query_params = opts[:query_params] || {}
|
@@ -131,15 +69,16 @@ module VeloPayments
|
|
131
69
|
form_params = opts[:form_params] || {}
|
132
70
|
|
133
71
|
# http body (model)
|
134
|
-
post_body = opts[:
|
72
|
+
post_body = opts[:debug_body]
|
135
73
|
|
136
74
|
# return_type
|
137
|
-
return_type = opts[:
|
75
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeInvitationStatusResponse'
|
138
76
|
|
139
77
|
# auth_names
|
140
|
-
auth_names = opts[:
|
78
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
141
79
|
|
142
80
|
new_options = opts.merge(
|
81
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v3",
|
143
82
|
:header_params => header_params,
|
144
83
|
:query_params => query_params,
|
145
84
|
:form_params => form_params,
|
@@ -150,7 +89,7 @@ module VeloPayments
|
|
150
89
|
|
151
90
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
152
91
|
if @api_client.config.debugging
|
153
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
92
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
93
|
end
|
155
94
|
return data, status_code, headers
|
156
95
|
end
|
@@ -164,8 +103,8 @@ module VeloPayments
|
|
164
103
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
165
104
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
166
105
|
# @return [PagedPayeeInvitationStatusResponse2]
|
167
|
-
def
|
168
|
-
data, _status_code, _headers =
|
106
|
+
def get_payees_invitation_status_v4(payor_id, opts = {})
|
107
|
+
data, _status_code, _headers = get_payees_invitation_status_v4_with_http_info(payor_id, opts)
|
169
108
|
data
|
170
109
|
end
|
171
110
|
|
@@ -178,16 +117,16 @@ module VeloPayments
|
|
178
117
|
# @option opts [Integer] :page Page number. Default is 1.
|
179
118
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
180
119
|
# @return [Array<(PagedPayeeInvitationStatusResponse2, Integer, Hash)>] PagedPayeeInvitationStatusResponse2 data, response status code and response headers
|
181
|
-
def
|
120
|
+
def get_payees_invitation_status_v4_with_http_info(payor_id, opts = {})
|
182
121
|
if @api_client.config.debugging
|
183
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
122
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v4 ...'
|
184
123
|
end
|
185
124
|
# verify the required parameter 'payor_id' is set
|
186
125
|
if @api_client.config.client_side_validation && payor_id.nil?
|
187
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.
|
126
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v4"
|
188
127
|
end
|
189
128
|
# resource path
|
190
|
-
local_var_path = '/
|
129
|
+
local_var_path = '/v4/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
191
130
|
|
192
131
|
# query parameters
|
193
132
|
query_params = opts[:query_params] || {}
|
@@ -205,15 +144,16 @@ module VeloPayments
|
|
205
144
|
form_params = opts[:form_params] || {}
|
206
145
|
|
207
146
|
# http body (model)
|
208
|
-
post_body = opts[:
|
147
|
+
post_body = opts[:debug_body]
|
209
148
|
|
210
149
|
# return_type
|
211
|
-
return_type = opts[:
|
150
|
+
return_type = opts[:debug_return_type] || 'PagedPayeeInvitationStatusResponse2'
|
212
151
|
|
213
152
|
# auth_names
|
214
|
-
auth_names = opts[:
|
153
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
215
154
|
|
216
155
|
new_options = opts.merge(
|
156
|
+
:operation => :"PayeeInvitationApi.get_payees_invitation_status_v4",
|
217
157
|
:header_params => header_params,
|
218
158
|
:query_params => query_params,
|
219
159
|
:form_params => form_params,
|
@@ -224,36 +164,36 @@ module VeloPayments
|
|
224
164
|
|
225
165
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
226
166
|
if @api_client.config.debugging
|
227
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
167
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
228
168
|
end
|
229
169
|
return data, status_code, headers
|
230
170
|
end
|
231
171
|
|
232
172
|
# Query Batch Status
|
233
|
-
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found )
|
173
|
+
# <p>Use v4 instead</p> Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
234
174
|
# @param batch_id [String] Batch Id
|
235
175
|
# @param [Hash] opts the optional parameters
|
236
176
|
# @return [QueryBatchResponse]
|
237
|
-
def
|
238
|
-
data, _status_code, _headers =
|
177
|
+
def query_batch_status_v3(batch_id, opts = {})
|
178
|
+
data, _status_code, _headers = query_batch_status_v3_with_http_info(batch_id, opts)
|
239
179
|
data
|
240
180
|
end
|
241
181
|
|
242
182
|
# Query Batch Status
|
243
|
-
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found )
|
183
|
+
# <p>Use v4 instead</p> Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
244
184
|
# @param batch_id [String] Batch Id
|
245
185
|
# @param [Hash] opts the optional parameters
|
246
186
|
# @return [Array<(QueryBatchResponse, Integer, Hash)>] QueryBatchResponse data, response status code and response headers
|
247
|
-
def
|
187
|
+
def query_batch_status_v3_with_http_info(batch_id, opts = {})
|
248
188
|
if @api_client.config.debugging
|
249
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
189
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v3 ...'
|
250
190
|
end
|
251
191
|
# verify the required parameter 'batch_id' is set
|
252
192
|
if @api_client.config.client_side_validation && batch_id.nil?
|
253
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.
|
193
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v3"
|
254
194
|
end
|
255
195
|
# resource path
|
256
|
-
local_var_path = '/
|
196
|
+
local_var_path = '/v3/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
257
197
|
|
258
198
|
# query parameters
|
259
199
|
query_params = opts[:query_params] || {}
|
@@ -267,15 +207,16 @@ module VeloPayments
|
|
267
207
|
form_params = opts[:form_params] || {}
|
268
208
|
|
269
209
|
# http body (model)
|
270
|
-
post_body = opts[:
|
210
|
+
post_body = opts[:debug_body]
|
271
211
|
|
272
212
|
# return_type
|
273
|
-
return_type = opts[:
|
213
|
+
return_type = opts[:debug_return_type] || 'QueryBatchResponse'
|
274
214
|
|
275
215
|
# auth_names
|
276
|
-
auth_names = opts[:
|
216
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
277
217
|
|
278
218
|
new_options = opts.merge(
|
219
|
+
:operation => :"PayeeInvitationApi.query_batch_status_v3",
|
279
220
|
:header_params => header_params,
|
280
221
|
:query_params => query_params,
|
281
222
|
:form_params => form_params,
|
@@ -286,7 +227,7 @@ module VeloPayments
|
|
286
227
|
|
287
228
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
288
229
|
if @api_client.config.debugging
|
289
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
230
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
290
231
|
end
|
291
232
|
return data, status_code, headers
|
292
233
|
end
|
@@ -296,8 +237,8 @@ module VeloPayments
|
|
296
237
|
# @param batch_id [String] Batch Id
|
297
238
|
# @param [Hash] opts the optional parameters
|
298
239
|
# @return [QueryBatchResponse2]
|
299
|
-
def
|
300
|
-
data, _status_code, _headers =
|
240
|
+
def query_batch_status_v4(batch_id, opts = {})
|
241
|
+
data, _status_code, _headers = query_batch_status_v4_with_http_info(batch_id, opts)
|
301
242
|
data
|
302
243
|
end
|
303
244
|
|
@@ -306,16 +247,16 @@ module VeloPayments
|
|
306
247
|
# @param batch_id [String] Batch Id
|
307
248
|
# @param [Hash] opts the optional parameters
|
308
249
|
# @return [Array<(QueryBatchResponse2, Integer, Hash)>] QueryBatchResponse2 data, response status code and response headers
|
309
|
-
def
|
250
|
+
def query_batch_status_v4_with_http_info(batch_id, opts = {})
|
310
251
|
if @api_client.config.debugging
|
311
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
252
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v4 ...'
|
312
253
|
end
|
313
254
|
# verify the required parameter 'batch_id' is set
|
314
255
|
if @api_client.config.client_side_validation && batch_id.nil?
|
315
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.
|
256
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v4"
|
316
257
|
end
|
317
258
|
# resource path
|
318
|
-
local_var_path = '/
|
259
|
+
local_var_path = '/v4/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
319
260
|
|
320
261
|
# query parameters
|
321
262
|
query_params = opts[:query_params] || {}
|
@@ -329,15 +270,16 @@ module VeloPayments
|
|
329
270
|
form_params = opts[:form_params] || {}
|
330
271
|
|
331
272
|
# http body (model)
|
332
|
-
post_body = opts[:
|
273
|
+
post_body = opts[:debug_body]
|
333
274
|
|
334
275
|
# return_type
|
335
|
-
return_type = opts[:
|
276
|
+
return_type = opts[:debug_return_type] || 'QueryBatchResponse2'
|
336
277
|
|
337
278
|
# auth_names
|
338
|
-
auth_names = opts[:
|
279
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
339
280
|
|
340
281
|
new_options = opts.merge(
|
282
|
+
:operation => :"PayeeInvitationApi.query_batch_status_v4",
|
341
283
|
:header_params => header_params,
|
342
284
|
:query_params => query_params,
|
343
285
|
:form_params => form_params,
|
@@ -348,42 +290,42 @@ module VeloPayments
|
|
348
290
|
|
349
291
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
350
292
|
if @api_client.config.debugging
|
351
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
293
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
352
294
|
end
|
353
295
|
return data, status_code, headers
|
354
296
|
end
|
355
297
|
|
356
298
|
# Resend Payee Invite
|
357
|
-
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
299
|
+
# <p>Use v4 instead</p> <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
358
300
|
# @param payee_id [String] The UUID of the payee.
|
359
301
|
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
360
302
|
# @param [Hash] opts the optional parameters
|
361
303
|
# @return [nil]
|
362
|
-
def
|
363
|
-
|
304
|
+
def resend_payee_invite_v3(payee_id, invite_payee_request, opts = {})
|
305
|
+
resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request, opts)
|
364
306
|
nil
|
365
307
|
end
|
366
308
|
|
367
309
|
# Resend Payee Invite
|
368
|
-
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
310
|
+
# <p>Use v4 instead</p> <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
369
311
|
# @param payee_id [String] The UUID of the payee.
|
370
312
|
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
371
313
|
# @param [Hash] opts the optional parameters
|
372
314
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
373
|
-
def
|
315
|
+
def resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request, opts = {})
|
374
316
|
if @api_client.config.debugging
|
375
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
317
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v3 ...'
|
376
318
|
end
|
377
319
|
# verify the required parameter 'payee_id' is set
|
378
320
|
if @api_client.config.client_side_validation && payee_id.nil?
|
379
|
-
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.
|
321
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
380
322
|
end
|
381
323
|
# verify the required parameter 'invite_payee_request' is set
|
382
324
|
if @api_client.config.client_side_validation && invite_payee_request.nil?
|
383
|
-
fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.
|
325
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
384
326
|
end
|
385
327
|
# resource path
|
386
|
-
local_var_path = '/
|
328
|
+
local_var_path = '/v3/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
387
329
|
|
388
330
|
# query parameters
|
389
331
|
query_params = opts[:query_params] || {}
|
@@ -399,15 +341,16 @@ module VeloPayments
|
|
399
341
|
form_params = opts[:form_params] || {}
|
400
342
|
|
401
343
|
# http body (model)
|
402
|
-
post_body = opts[:
|
344
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_payee_request)
|
403
345
|
|
404
346
|
# return_type
|
405
|
-
return_type = opts[:
|
347
|
+
return_type = opts[:debug_return_type]
|
406
348
|
|
407
349
|
# auth_names
|
408
|
-
auth_names = opts[:
|
350
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
409
351
|
|
410
352
|
new_options = opts.merge(
|
353
|
+
:operation => :"PayeeInvitationApi.resend_payee_invite_v3",
|
411
354
|
:header_params => header_params,
|
412
355
|
:query_params => query_params,
|
413
356
|
:form_params => form_params,
|
@@ -418,7 +361,7 @@ module VeloPayments
|
|
418
361
|
|
419
362
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
420
363
|
if @api_client.config.debugging
|
421
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
364
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
422
365
|
end
|
423
366
|
return data, status_code, headers
|
424
367
|
end
|
@@ -429,8 +372,8 @@ module VeloPayments
|
|
429
372
|
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
430
373
|
# @param [Hash] opts the optional parameters
|
431
374
|
# @return [nil]
|
432
|
-
def
|
433
|
-
|
375
|
+
def resend_payee_invite_v4(payee_id, invite_payee_request2, opts = {})
|
376
|
+
resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2, opts)
|
434
377
|
nil
|
435
378
|
end
|
436
379
|
|
@@ -440,20 +383,20 @@ module VeloPayments
|
|
440
383
|
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
441
384
|
# @param [Hash] opts the optional parameters
|
442
385
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
443
|
-
def
|
386
|
+
def resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2, opts = {})
|
444
387
|
if @api_client.config.debugging
|
445
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
388
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v4 ...'
|
446
389
|
end
|
447
390
|
# verify the required parameter 'payee_id' is set
|
448
391
|
if @api_client.config.client_side_validation && payee_id.nil?
|
449
|
-
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.
|
392
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v4"
|
450
393
|
end
|
451
394
|
# verify the required parameter 'invite_payee_request2' is set
|
452
395
|
if @api_client.config.client_side_validation && invite_payee_request2.nil?
|
453
|
-
fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.
|
396
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.resend_payee_invite_v4"
|
454
397
|
end
|
455
398
|
# resource path
|
456
|
-
local_var_path = '/
|
399
|
+
local_var_path = '/v4/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
457
400
|
|
458
401
|
# query parameters
|
459
402
|
query_params = opts[:query_params] || {}
|
@@ -469,15 +412,16 @@ module VeloPayments
|
|
469
412
|
form_params = opts[:form_params] || {}
|
470
413
|
|
471
414
|
# http body (model)
|
472
|
-
post_body = opts[:
|
415
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_payee_request2)
|
473
416
|
|
474
417
|
# return_type
|
475
|
-
return_type = opts[:
|
418
|
+
return_type = opts[:debug_return_type]
|
476
419
|
|
477
420
|
# auth_names
|
478
|
-
auth_names = opts[:
|
421
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
479
422
|
|
480
423
|
new_options = opts.merge(
|
424
|
+
:operation => :"PayeeInvitationApi.resend_payee_invite_v4",
|
481
425
|
:header_params => header_params,
|
482
426
|
:query_params => query_params,
|
483
427
|
:form_params => form_params,
|
@@ -488,32 +432,32 @@ module VeloPayments
|
|
488
432
|
|
489
433
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
490
434
|
if @api_client.config.debugging
|
491
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
435
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
492
436
|
end
|
493
437
|
return data, status_code, headers
|
494
438
|
end
|
495
439
|
|
496
440
|
# Initiate Payee Creation
|
497
|
-
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body,
|
441
|
+
# <p>Use v4 instead</p> Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
498
442
|
# @param [Hash] opts the optional parameters
|
499
443
|
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
500
444
|
# @return [CreatePayeesCSVResponse]
|
501
|
-
def
|
502
|
-
data, _status_code, _headers =
|
445
|
+
def v3_create_payee(opts = {})
|
446
|
+
data, _status_code, _headers = v3_create_payee_with_http_info(opts)
|
503
447
|
data
|
504
448
|
end
|
505
449
|
|
506
450
|
# Initiate Payee Creation
|
507
|
-
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body,
|
451
|
+
# <p>Use v4 instead</p> Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
508
452
|
# @param [Hash] opts the optional parameters
|
509
453
|
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
510
454
|
# @return [Array<(CreatePayeesCSVResponse, Integer, Hash)>] CreatePayeesCSVResponse data, response status code and response headers
|
511
|
-
def
|
455
|
+
def v3_create_payee_with_http_info(opts = {})
|
512
456
|
if @api_client.config.debugging
|
513
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
457
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_create_payee ...'
|
514
458
|
end
|
515
459
|
# resource path
|
516
|
-
local_var_path = '/
|
460
|
+
local_var_path = '/v3/payees'
|
517
461
|
|
518
462
|
# query parameters
|
519
463
|
query_params = opts[:query_params] || {}
|
@@ -529,15 +473,16 @@ module VeloPayments
|
|
529
473
|
form_params = opts[:form_params] || {}
|
530
474
|
|
531
475
|
# http body (model)
|
532
|
-
post_body = opts[:
|
476
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_payees_request'])
|
533
477
|
|
534
478
|
# return_type
|
535
|
-
return_type = opts[:
|
479
|
+
return_type = opts[:debug_return_type] || 'CreatePayeesCSVResponse'
|
536
480
|
|
537
481
|
# auth_names
|
538
|
-
auth_names = opts[:
|
482
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
539
483
|
|
540
484
|
new_options = opts.merge(
|
485
|
+
:operation => :"PayeeInvitationApi.v3_create_payee",
|
541
486
|
:header_params => header_params,
|
542
487
|
:query_params => query_params,
|
543
488
|
:form_params => form_params,
|
@@ -548,32 +493,32 @@ module VeloPayments
|
|
548
493
|
|
549
494
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
550
495
|
if @api_client.config.debugging
|
551
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
496
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v3_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
552
497
|
end
|
553
498
|
return data, status_code, headers
|
554
499
|
end
|
555
500
|
|
556
501
|
# Initiate Payee Creation
|
557
|
-
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body,
|
502
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
558
503
|
# @param [Hash] opts the optional parameters
|
559
504
|
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
560
505
|
# @return [CreatePayeesCSVResponse2]
|
561
|
-
def
|
562
|
-
data, _status_code, _headers =
|
506
|
+
def v4_create_payee(opts = {})
|
507
|
+
data, _status_code, _headers = v4_create_payee_with_http_info(opts)
|
563
508
|
data
|
564
509
|
end
|
565
510
|
|
566
511
|
# Initiate Payee Creation
|
567
|
-
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body,
|
512
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
|
568
513
|
# @param [Hash] opts the optional parameters
|
569
514
|
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
570
515
|
# @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers
|
571
|
-
def
|
516
|
+
def v4_create_payee_with_http_info(opts = {})
|
572
517
|
if @api_client.config.debugging
|
573
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
518
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v4_create_payee ...'
|
574
519
|
end
|
575
520
|
# resource path
|
576
|
-
local_var_path = '/
|
521
|
+
local_var_path = '/v4/payees'
|
577
522
|
|
578
523
|
# query parameters
|
579
524
|
query_params = opts[:query_params] || {}
|
@@ -589,15 +534,16 @@ module VeloPayments
|
|
589
534
|
form_params = opts[:form_params] || {}
|
590
535
|
|
591
536
|
# http body (model)
|
592
|
-
post_body = opts[:
|
537
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_payees_request2'])
|
593
538
|
|
594
539
|
# return_type
|
595
|
-
return_type = opts[:
|
540
|
+
return_type = opts[:debug_return_type] || 'CreatePayeesCSVResponse2'
|
596
541
|
|
597
542
|
# auth_names
|
598
|
-
auth_names = opts[:
|
543
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
599
544
|
|
600
545
|
new_options = opts.merge(
|
546
|
+
:operation => :"PayeeInvitationApi.v4_create_payee",
|
601
547
|
:header_params => header_params,
|
602
548
|
:query_params => query_params,
|
603
549
|
:form_params => form_params,
|
@@ -608,7 +554,7 @@ module VeloPayments
|
|
608
554
|
|
609
555
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
610
556
|
if @api_client.config.debugging
|
611
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
557
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v4_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
612
558
|
end
|
613
559
|
return data, status_code, headers
|
614
560
|
end
|