velopayments 2.20.119 → 2.23.78.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/Makefile +5 -2
- data/README.md +116 -45
- data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +2 -2
- data/docs/AutoTopUpConfig2.md +23 -0
- data/docs/Challenge2.md +19 -0
- data/docs/CountriesApi.md +25 -25
- data/docs/CreateFundingAccountRequestV2.md +29 -0
- data/docs/CreatePayee2.md +3 -3
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +1 -1
- data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +3 -3
- data/docs/CreateWebhookRequest.md +23 -0
- data/docs/CurrenciesApi.md +6 -6
- data/docs/FundingAccountResponse.md +15 -7
- data/docs/FundingAccountResponse2.md +35 -0
- data/docs/{CurrencyType.md → FundingAccountType.md} +2 -3
- data/docs/FundingAudit.md +5 -5
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerApi.md +329 -32
- data/docs/FundingManagerPrivateApi.md +7 -7
- data/docs/FundingPayorStatusAuditResponse.md +2 -2
- data/docs/FundingRequestV3.md +19 -0
- data/docs/FxSummaryV3.md +1 -1
- data/docs/FxSummaryV4.md +1 -1
- data/docs/GetFundingsResponse.md +5 -1
- data/docs/GetFundingsResponseLinks.md +19 -0
- data/docs/GetPayeeListResponse.md +49 -0
- data/docs/GetPayeeListResponseCompany.md +19 -0
- data/docs/GetPayeeListResponseIndividual.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
- data/docs/InlineResponse404.md +19 -0
- data/docs/InlineResponse404Errors.md +23 -0
- data/docs/InlineResponse412.md +19 -0
- data/docs/InlineResponse412Errors.md +23 -0
- data/docs/{UserResponse2Roles.md → InvitationStatus2.md} +2 -3
- data/docs/ListFundingAccountsResponse2.md +21 -0
- data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
- data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
- data/docs/ListPaymentsResponseV4.md +1 -1
- data/docs/ListSourceAccountResponseV2.md +1 -1
- data/docs/ListSourceAccountResponseV2Links.md +19 -0
- data/docs/ListSourceAccountResponseV3.md +21 -0
- data/docs/ListSourceAccountResponseV3Links.md +19 -0
- data/docs/LoginApi.md +6 -2
- data/docs/MarketingOptIn.md +1 -1
- data/docs/Name.md +23 -0
- data/docs/Notifications2.md +17 -0
- data/docs/PagedPayeeResponse2.md +1 -1
- data/docs/PagedPaymentsResponseV3.md +21 -0
- data/docs/Payee.md +2 -2
- data/docs/Payee2.md +2 -2
- data/docs/{PayeeResponseV3.md → PayeeDetailResponse.md} +9 -7
- data/docs/PayeeDetailResponse2.md +73 -0
- data/docs/PayeeInvitationApi.md +227 -2
- data/docs/PayeePayorRef2.md +25 -0
- data/docs/PayeePayorRefV2.md +1 -1
- data/docs/PayeePayorRefV3.md +3 -3
- data/docs/PayeeResponse.md +2 -2
- data/docs/PayeeResponseV2.md +3 -3
- data/docs/PayeeType2.md +16 -0
- data/docs/PayeeUserSelfUpdateRequest.md +27 -0
- data/docs/PayeesApi.md +421 -8
- data/docs/PaymentAuditServiceApi.md +267 -35
- data/docs/PaymentDeltaResponseV4.md +21 -0
- data/docs/PaymentDeltaV4.md +31 -0
- data/docs/PaymentEventResponseV3.md +1 -1
- data/docs/PaymentEventResponseV4.md +1 -1
- data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +5 -3
- data/docs/PaymentResponseV3.md +1 -1
- data/docs/PaymentResponseV4.md +7 -1
- data/docs/PaymentV3.md +37 -0
- data/docs/PayorV1.md +3 -1
- data/docs/PayorV2.md +5 -1
- data/docs/PayorsApi.md +14 -14
- data/docs/PayoutCompanyV3.md +17 -0
- data/docs/PayoutIndividualV3.md +17 -0
- data/docs/PayoutNameV3.md +19 -0
- data/docs/PayoutPayeeV3.md +21 -0
- data/docs/PayoutServiceApi.md +393 -0
- data/docs/PayoutSummaryAuditV4.md +4 -2
- data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
- data/docs/PingResponse.md +19 -0
- data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +4 -4
- data/docs/QuoteResponseV3.md +17 -0
- data/docs/{Region.md → RegionV2.md} +2 -2
- data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +2 -2
- data/docs/SourceAccountResponse.md +3 -1
- data/docs/SourceAccountResponseV2.md +4 -2
- data/docs/SourceAccountResponseV3.md +47 -0
- data/docs/SourceAccountType.md +16 -0
- data/docs/{SourceAccount.md → SourceAccountV3.md} +2 -2
- data/docs/SupportedCountriesResponseV2.md +17 -0
- data/docs/{SupportedCountry2.md → SupportedCountryV2.md} +3 -3
- data/docs/SupportedCurrencyResponseV2.md +17 -0
- data/docs/{SupportedCurrency.md → SupportedCurrencyV2.md} +2 -2
- data/docs/TransferRequest2.md +21 -0
- data/docs/TransmissionType.md +16 -0
- data/docs/TransmissionTypes.md +21 -0
- data/docs/TransmissionTypes2.md +21 -0
- data/docs/UpdatePayeeDetailsRequest.md +29 -0
- data/docs/UpdatePayeeDetailsRequest2.md +29 -0
- data/docs/UpdateWebhookRequest.md +21 -0
- data/docs/UserResponse.md +1 -1
- data/docs/UsersApi.md +62 -6
- data/docs/WatchlistStatus2.md +16 -0
- data/docs/WebhookResponse.md +25 -0
- data/docs/WebhooksApi.md +280 -0
- data/docs/WebhooksResponse.md +21 -0
- data/docs/WithdrawPaymentRequest.md +17 -0
- data/lib/velopayments.rb +68 -32
- 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 +516 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +14 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +312 -33
- data/lib/velopayments/api/payees_api.rb +582 -46
- data/lib/velopayments/api/payment_audit_service_api.rb +444 -78
- 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 +506 -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 +350 -0
- data/lib/velopayments/api_client.rb +47 -44
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +35 -8
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +13 -9
- data/lib/velopayments/models/access_token_response.rb +10 -6
- data/lib/velopayments/models/access_token_validation_request.rb +10 -6
- data/lib/velopayments/models/auth_response.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
- data/lib/velopayments/models/challenge.rb +10 -6
- data/lib/velopayments/models/challenge2.rb +285 -0
- data/lib/velopayments/models/company.rb +15 -11
- data/lib/velopayments/models/company2.rb +15 -11
- data/lib/velopayments/models/company_response.rb +10 -6
- data/lib/velopayments/models/company_v1.rb +15 -11
- data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
- data/lib/velopayments/models/create_individual.rb +10 -6
- data/lib/velopayments/models/create_individual2.rb +10 -6
- data/lib/velopayments/models/create_individual2_name.rb +10 -6
- data/lib/velopayments/models/create_payee.rb +10 -6
- data/lib/velopayments/models/create_payee2.rb +13 -9
- data/lib/velopayments/models/create_payee_address.rb +10 -6
- data/lib/velopayments/models/create_payee_address2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +10 -6
- data/lib/velopayments/models/create_payees_request.rb +10 -6
- data/lib/velopayments/models/create_payees_request2.rb +10 -6
- data/lib/velopayments/models/create_payment_channel.rb +10 -6
- data/lib/velopayments/models/create_payment_channel2.rb +10 -6
- data/lib/velopayments/models/create_payor_link_request.rb +10 -6
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +14 -10
- data/lib/velopayments/models/create_webhook_request.rb +315 -0
- data/lib/velopayments/models/error.rb +10 -6
- data/lib/velopayments/models/error_response.rb +10 -6
- data/lib/velopayments/models/failed_submission.rb +10 -6
- data/lib/velopayments/models/failed_submission2.rb +10 -6
- data/lib/velopayments/models/funding_account_response.rb +105 -10
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +106 -95
- data/lib/velopayments/models/funding_account_type.rb +37 -0
- data/lib/velopayments/models/funding_audit.rb +23 -17
- data/lib/velopayments/models/funding_event.rb +11 -7
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +47 -7
- data/lib/velopayments/models/funding_request_v1.rb +10 -6
- data/lib/velopayments/models/funding_request_v2.rb +10 -6
- data/lib/velopayments/models/funding_request_v3.rb +259 -0
- data/lib/velopayments/models/fx_summary_v3.rb +11 -7
- data/lib/velopayments/models/fx_summary_v4.rb +11 -7
- data/lib/velopayments/models/get_fundings_response.rb +37 -24
- data/lib/velopayments/models/{paged_response.rb → get_fundings_response_links.rb} +26 -24
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +85 -113
- data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +14 -10
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -9
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +25 -11
- data/lib/velopayments/models/get_payout_statistics.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v4.rb +10 -6
- data/lib/velopayments/models/individual.rb +10 -6
- data/lib/velopayments/models/individual2.rb +10 -6
- data/lib/velopayments/models/individual_response.rb +10 -6
- data/lib/velopayments/models/individual_v1.rb +10 -6
- data/lib/velopayments/models/individual_v1_name.rb +10 -6
- data/lib/velopayments/models/inline_response400.rb +10 -6
- data/lib/velopayments/models/inline_response400_errors.rb +10 -6
- data/lib/velopayments/models/inline_response401.rb +10 -6
- data/lib/velopayments/models/inline_response401_errors.rb +10 -6
- data/lib/velopayments/models/inline_response403.rb +10 -6
- data/lib/velopayments/models/inline_response403_errors.rb +10 -6
- data/lib/velopayments/models/inline_response404.rb +225 -0
- data/lib/velopayments/models/inline_response404_errors.rb +240 -0
- data/lib/velopayments/models/inline_response409.rb +10 -6
- data/lib/velopayments/models/inline_response409_errors.rb +10 -6
- data/lib/velopayments/models/inline_response412.rb +225 -0
- data/lib/velopayments/models/inline_response412_errors.rb +240 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invitation_status_response.rb +10 -6
- data/lib/velopayments/models/invite_payee_request.rb +10 -6
- data/lib/velopayments/models/invite_payee_request2.rb +10 -6
- data/lib/velopayments/models/invite_user_request.rb +19 -15
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/language.rb +3 -2
- data/lib/velopayments/models/language2.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +14 -10
- data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +13 -9
- data/lib/velopayments/models/list_payments_response_v4.rb +11 -7
- data/lib/velopayments/models/list_source_account_response.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_links.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_page.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_v2.rb +11 -7
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
- data/lib/velopayments/models/location_type.rb +3 -2
- data/lib/velopayments/models/marketing_opt_in.rb +11 -7
- data/lib/velopayments/models/mfa_details.rb +10 -6
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +333 -0
- data/lib/velopayments/models/notifications.rb +10 -6
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → notifications2.rb} +20 -18
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/ofac_status2.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/page_for_response.rb +10 -6
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_response2.rb +11 -7
- data/lib/velopayments/models/paged_payee_response2_summary.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_summary.rb +10 -6
- data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
- data/lib/velopayments/models/paged_user_response.rb +10 -6
- data/lib/velopayments/models/paged_user_response_links.rb +10 -6
- data/lib/velopayments/models/paged_user_response_page.rb +10 -6
- data/lib/velopayments/models/password_request.rb +10 -6
- data/lib/velopayments/models/payee.rb +12 -8
- data/lib/velopayments/models/payee2.rb +12 -8
- data/lib/velopayments/models/payee_address.rb +10 -6
- data/lib/velopayments/models/payee_address2.rb +10 -6
- data/lib/velopayments/models/payee_delta.rb +10 -6
- data/lib/velopayments/models/payee_delta2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_page.rb +10 -6
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +30 -17
- data/lib/velopayments/models/payee_detail_response2.rb +475 -0
- data/lib/velopayments/models/payee_invitation_status.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel2.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref2.rb +248 -0
- data/lib/velopayments/models/payee_payor_ref_v2.rb +11 -7
- data/lib/velopayments/models/payee_payor_ref_v3.rb +12 -42
- data/lib/velopayments/models/payee_response.rb +12 -8
- data/lib/velopayments/models/payee_response_v2.rb +13 -9
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/payee_type2.rb +37 -0
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +54 -194
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +10 -6
- data/lib/velopayments/models/payment_channel_rule.rb +10 -6
- data/lib/velopayments/models/payment_channel_rules_response.rb +10 -6
- data/lib/velopayments/models/payment_delta.rb +10 -6
- data/lib/velopayments/models/payment_delta_response.rb +10 -6
- data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
- data/lib/velopayments/models/payment_delta_v4.rb +289 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_event_response_v4.rb +11 -7
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +27 -13
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_response_v4.rb +39 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +10 -6
- data/lib/velopayments/models/payment_v3.rb +363 -0
- data/lib/velopayments/models/payor_address.rb +10 -6
- data/lib/velopayments/models/payor_address_v2.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +10 -6
- data/lib/velopayments/models/payor_branding_response.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_request.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_response.rb +10 -6
- data/lib/velopayments/models/payor_create_application_request.rb +10 -6
- data/lib/velopayments/models/payor_email_opt_out_request.rb +10 -6
- data/lib/velopayments/models/payor_links_response.rb +10 -6
- data/lib/velopayments/models/payor_links_response_links.rb +10 -6
- data/lib/velopayments/models/payor_links_response_payors.rb +10 -6
- data/lib/velopayments/models/payor_logo_request.rb +10 -6
- data/lib/velopayments/models/payor_v1.rb +23 -10
- data/lib/velopayments/models/payor_v2.rb +33 -10
- data/lib/velopayments/models/payout_company_v3.rb +215 -0
- data/lib/velopayments/models/payout_individual_v3.rb +215 -0
- data/lib/velopayments/models/payout_name_v3.rb +229 -0
- data/lib/velopayments/models/payout_payee_v3.rb +234 -0
- data/lib/velopayments/models/payout_payor_v4.rb +10 -6
- data/lib/velopayments/models/payout_principal_v4.rb +10 -6
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/payout_status_v4.rb +3 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +10 -6
- data/lib/velopayments/models/payout_summary_audit_v4.rb +22 -9
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +32 -14
- data/lib/velopayments/models/payout_type_v4.rb +3 -2
- data/lib/velopayments/models/ping_response.rb +219 -0
- data/lib/velopayments/models/query_batch_response.rb +10 -6
- data/lib/velopayments/models/query_batch_response2.rb +10 -6
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +15 -11
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +14 -10
- data/lib/velopayments/models/{region.rb → region_v2.rb} +13 -9
- data/lib/velopayments/models/register_sms_request.rb +13 -9
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +13 -9
- data/lib/velopayments/models/resend_token_request.rb +10 -6
- data/lib/velopayments/models/reset_password_request.rb +10 -6
- data/lib/velopayments/models/role.rb +10 -6
- data/lib/velopayments/models/role_update_request.rb +10 -6
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +10 -6
- data/lib/velopayments/models/self_update_password_request.rb +10 -6
- data/lib/velopayments/models/set_notifications_request.rb +10 -6
- data/lib/velopayments/models/source_account_response.rb +24 -11
- data/lib/velopayments/models/source_account_response_v2.rb +26 -13
- data/lib/velopayments/models/source_account_response_v3.rb +437 -0
- data/lib/velopayments/models/source_account_summary_v3.rb +10 -6
- data/lib/velopayments/models/source_account_summary_v4.rb +10 -6
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +13 -9
- data/lib/velopayments/models/supported_countries_response.rb +10 -6
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +14 -10
- data/lib/velopayments/models/supported_country.rb +10 -6
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +13 -9
- data/lib/velopayments/models/transfer_request.rb +10 -6
- data/lib/velopayments/models/transfer_request2.rb +301 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{list_payments_response_page.rb → transmission_types.rb} +50 -46
- data/lib/velopayments/models/transmission_types2.rb +246 -0
- data/lib/velopayments/models/unregister_mfa_request.rb +10 -6
- data/lib/velopayments/models/update_payee_details_request.rb +266 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
- data/lib/velopayments/models/update_remote_id_request.rb +10 -6
- data/lib/velopayments/models/update_webhook_request.rb +288 -0
- data/lib/velopayments/models/user_details_update_request.rb +19 -15
- data/lib/velopayments/models/user_info.rb +10 -6
- data/lib/velopayments/models/user_response.rb +20 -16
- 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 +10 -6
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/watchlist_status2.rb +40 -0
- data/lib/velopayments/models/webhook_response.rb +246 -0
- data/lib/velopayments/models/webhooks_response.rb +233 -0
- data/lib/velopayments/models/{currency_type.rb → withdraw_payment_request.rb} +39 -34
- 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 +93 -18
- data/spec/api/funding_manager_private_api_spec.rb +5 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +57 -4
- data/spec/api/payees_api_spec.rb +108 -4
- data/spec/api/payment_audit_service_api_spec.rb +72 -18
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +127 -0
- 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 +96 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
- data/spec/models/access_token_response_spec.rb +2 -2
- data/spec/models/access_token_validation_request_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +2 -2
- data/spec/models/auto_top_up_config2_spec.rb +59 -0
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company2_spec.rb +2 -2
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +2 -2
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
- data/spec/models/create_individual2_name_spec.rb +2 -2
- data/spec/models/create_individual2_spec.rb +2 -2
- data/spec/models/create_individual_spec.rb +2 -2
- data/spec/models/create_payee2_spec.rb +2 -2
- data/spec/models/create_payee_address2_spec.rb +2 -2
- data/spec/models/create_payee_address_spec.rb +2 -2
- data/spec/models/create_payee_spec.rb +2 -2
- data/spec/models/create_payees_csv_request2_spec.rb +2 -2
- data/spec/models/create_payees_csv_request_spec.rb +2 -2
- data/spec/models/create_payees_csv_response2_spec.rb +2 -2
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payor_link_request_spec.rb +2 -2
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
- data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/failed_submission2_spec.rb +2 -2
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response2_spec.rb +95 -0
- data/spec/models/funding_account_response_spec.rb +26 -2
- data/spec/models/funding_account_type_spec.rb +35 -0
- data/spec/models/funding_audit_spec.rb +8 -8
- data/spec/models/funding_event_spec.rb +2 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/funding_request_v3_spec.rb +47 -0
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/get_fundings_response_links_spec.rb +47 -0
- data/spec/models/get_fundings_response_spec.rb +14 -2
- data/spec/models/get_payee_list_response_company_spec.rb +47 -0
- data/spec/models/get_payee_list_response_individual_spec.rb +41 -0
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response_spec.rb} +21 -39
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual2_spec.rb +2 -2
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +2 -2
- data/spec/models/individual_v1_name_spec.rb +2 -2
- data/spec/models/individual_v1_spec.rb +2 -2
- data/spec/models/inline_response400_errors_spec.rb +2 -2
- data/spec/models/inline_response400_spec.rb +2 -2
- data/spec/models/inline_response401_errors_spec.rb +2 -2
- data/spec/models/inline_response401_spec.rb +2 -2
- data/spec/models/inline_response403_errors_spec.rb +2 -2
- data/spec/models/inline_response403_spec.rb +2 -2
- data/spec/models/inline_response404_errors_spec.rb +59 -0
- data/spec/models/inline_response404_spec.rb +47 -0
- data/spec/models/inline_response409_errors_spec.rb +2 -2
- data/spec/models/inline_response409_spec.rb +2 -2
- data/spec/models/inline_response412_errors_spec.rb +59 -0
- data/spec/models/inline_response412_spec.rb +47 -0
- data/spec/models/invitation_status2_spec.rb +35 -0
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request2_spec.rb +2 -2
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/invite_user_request_spec.rb +2 -2
- data/spec/models/kyc_state_spec.rb +2 -2
- data/spec/models/language2_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/link_for_response_spec.rb +2 -2
- data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
- data/spec/models/list_funding_accounts_response_spec.rb +2 -2
- data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
- data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
- data/spec/models/list_payments_response_v4_spec.rb +2 -2
- data/spec/models/list_source_account_response_links_spec.rb +2 -2
- data/spec/models/list_source_account_response_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v3_spec.rb +53 -0
- data/spec/models/location_type_spec.rb +2 -2
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/mfa_details_spec.rb +2 -2
- data/spec/models/mfa_type_spec.rb +2 -2
- data/spec/models/name_spec.rb +59 -0
- data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status2_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status2_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/page_for_response_spec.rb +2 -2
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/paged_payee_response2_spec.rb +2 -2
- data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
- data/spec/models/paged_payee_response_links_spec.rb +2 -2
- data/spec/models/paged_payee_response_page_spec.rb +2 -2
- data/spec/models/paged_payee_response_spec.rb +2 -2
- data/spec/models/paged_payee_response_summary_spec.rb +2 -2
- data/spec/models/paged_payments_response_v3_spec.rb +53 -0
- data/spec/models/paged_user_response_links_spec.rb +2 -2
- data/spec/models/paged_user_response_page_spec.rb +2 -2
- data/spec/models/paged_user_response_spec.rb +2 -2
- data/spec/models/password_request_spec.rb +2 -2
- data/spec/models/payee2_spec.rb +2 -2
- data/spec/models/payee_address2_spec.rb +2 -2
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +2 -2
- data/spec/models/payee_delta_response2_links_spec.rb +2 -2
- data/spec/models/payee_delta_response2_spec.rb +2 -2
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_detail_response2_spec.rb +209 -0
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -8
- data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
- data/spec/models/payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +2 -2
- data/spec/models/payee_payment_channel_spec.rb +2 -2
- data/spec/models/payee_payor_ref2_spec.rb +65 -0
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v3_spec.rb +2 -6
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +2 -2
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type2_spec.rb +35 -0
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payee_user_self_update_request_spec.rb +71 -0
- data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
- data/spec/models/payment_channel_country_spec.rb +2 -2
- data/spec/models/payment_channel_rule_spec.rb +2 -2
- data/spec/models/payment_channel_rules_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_v4_spec.rb +53 -0
- data/spec/models/payment_delta_spec.rb +2 -2
- data/spec/models/payment_delta_v4_spec.rb +83 -0
- data/spec/models/payment_event_response_v3_spec.rb +2 -2
- data/spec/models/payment_event_response_v4_spec.rb +2 -2
- data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -8
- data/spec/models/payment_rails_spec.rb +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +2 -2
- data/spec/models/payment_response_v4_spec.rb +20 -2
- data/spec/models/payment_v3_spec.rb +105 -0
- data/spec/models/payor_address_spec.rb +2 -2
- data/spec/models/payor_address_v2_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
- data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +8 -2
- data/spec/models/payor_v2_spec.rb +14 -2
- data/spec/models/{get_fundings_response_all_of_spec.rb → payout_company_v3_spec.rb} +9 -9
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
- data/spec/models/payout_name_v3_spec.rb +47 -0
- data/spec/models/payout_payee_v3_spec.rb +53 -0
- data/spec/models/payout_payor_v4_spec.rb +2 -2
- data/spec/models/payout_principal_v4_spec.rb +2 -2
- data/spec/models/payout_status_v3_spec.rb +2 -2
- data/spec/models/payout_status_v4_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/ping_response_spec.rb +47 -0
- data/spec/models/query_batch_response2_spec.rb +2 -2
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
- data/spec/models/register_sms_request_spec.rb +2 -2
- data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
- data/spec/models/resend_token_request_spec.rb +2 -2
- data/spec/models/reset_password_request_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_update_request_spec.rb +2 -2
- data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
- data/spec/models/self_update_password_request_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +8 -2
- data/spec/models/source_account_response_v2_spec.rb +8 -2
- data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
- data/spec/models/source_account_summary_v3_spec.rb +2 -2
- data/spec/models/source_account_summary_v4_spec.rb +2 -2
- data/spec/models/source_account_type_spec.rb +35 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
- data/spec/models/transfer_request2_spec.rb +53 -0
- data/spec/models/transfer_request_spec.rb +2 -2
- data/spec/models/transmission_type_spec.rb +35 -0
- data/spec/models/transmission_types2_spec.rb +53 -0
- data/spec/models/transmission_types_spec.rb +53 -0
- data/spec/models/unregister_mfa_request_spec.rb +2 -2
- data/spec/models/update_payee_details_request2_spec.rb +77 -0
- data/spec/models/update_payee_details_request_spec.rb +77 -0
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/update_webhook_request_spec.rb +53 -0
- data/spec/models/user_details_update_request_spec.rb +2 -2
- data/spec/models/user_info_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_status_spec.rb +2 -2
- data/spec/models/user_type2_spec.rb +2 -2
- data/spec/models/user_type_spec.rb +2 -2
- data/spec/models/validate_password_response_spec.rb +2 -2
- data/spec/models/watchlist_status2_spec.rb +35 -0
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/models/{paged_response_page_spec.rb → webhook_response_spec.rb} +13 -13
- data/spec/models/webhooks_response_spec.rb +53 -0
- data/spec/models/withdraw_payment_request_spec.rb +41 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +61 -11
- data/specs/api/payees_api_spec.rb +101 -14
- data/specs/api/payment_audit_service_api_spec.rb +231 -30
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/velopayments.gemspec +3 -4
- metadata +444 -326
- data/Gemfile.lock +0 -70
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- 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/spec/api/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/payout_history_api_spec.rb +0 -95
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/payout_history_api_spec.rb +0 -95
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
- data/velopayments-2.20.118.gem +0 -0
@@ -3,14 +3,15 @@
|
|
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.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
17
|
# Error response returned by all error conditions in Velo Services
|
@@ -118,7 +119,9 @@ module VeloPayments
|
|
118
119
|
def build_from_hash(attributes)
|
119
120
|
return nil unless attributes.is_a?(Hash)
|
120
121
|
self.class.openapi_types.each_pair do |key, type|
|
121
|
-
if
|
122
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
123
|
+
self.send("#{key}=", nil)
|
124
|
+
elsif type =~ /\AArray<(.*)>/i
|
122
125
|
# check to ensure the input is an array given that the attribute
|
123
126
|
# is documented as an array but the input is not
|
124
127
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -126,7 +129,7 @@ module VeloPayments
|
|
126
129
|
end
|
127
130
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
128
131
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
129
|
-
end
|
132
|
+
end
|
130
133
|
end
|
131
134
|
|
132
135
|
self
|
@@ -138,8 +141,8 @@ module VeloPayments
|
|
138
141
|
# @return [Object] Deserialized data
|
139
142
|
def _deserialize(type, value)
|
140
143
|
case type.to_sym
|
141
|
-
when :
|
142
|
-
|
144
|
+
when :Time
|
145
|
+
Time.parse(value)
|
143
146
|
when :Date
|
144
147
|
Date.parse(value)
|
145
148
|
when :String
|
@@ -218,5 +221,6 @@ module VeloPayments
|
|
218
221
|
value
|
219
222
|
end
|
220
223
|
end
|
224
|
+
|
221
225
|
end
|
222
226
|
end
|
@@ -3,14 +3,15 @@
|
|
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.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
17
|
class FailedSubmission
|
@@ -111,7 +112,9 @@ module VeloPayments
|
|
111
112
|
def build_from_hash(attributes)
|
112
113
|
return nil unless attributes.is_a?(Hash)
|
113
114
|
self.class.openapi_types.each_pair do |key, type|
|
114
|
-
if
|
115
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
116
|
+
self.send("#{key}=", nil)
|
117
|
+
elsif type =~ /\AArray<(.*)>/i
|
115
118
|
# check to ensure the input is an array given that the attribute
|
116
119
|
# is documented as an array but the input is not
|
117
120
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -119,7 +122,7 @@ module VeloPayments
|
|
119
122
|
end
|
120
123
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
121
124
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
122
|
-
end
|
125
|
+
end
|
123
126
|
end
|
124
127
|
|
125
128
|
self
|
@@ -131,8 +134,8 @@ module VeloPayments
|
|
131
134
|
# @return [Object] Deserialized data
|
132
135
|
def _deserialize(type, value)
|
133
136
|
case type.to_sym
|
134
|
-
when :
|
135
|
-
|
137
|
+
when :Time
|
138
|
+
Time.parse(value)
|
136
139
|
when :Date
|
137
140
|
Date.parse(value)
|
138
141
|
when :String
|
@@ -211,5 +214,6 @@ module VeloPayments
|
|
211
214
|
value
|
212
215
|
end
|
213
216
|
end
|
217
|
+
|
214
218
|
end
|
215
219
|
end
|
@@ -3,14 +3,15 @@
|
|
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.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
17
|
class FailedSubmission2
|
@@ -111,7 +112,9 @@ module VeloPayments
|
|
111
112
|
def build_from_hash(attributes)
|
112
113
|
return nil unless attributes.is_a?(Hash)
|
113
114
|
self.class.openapi_types.each_pair do |key, type|
|
114
|
-
if
|
115
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
116
|
+
self.send("#{key}=", nil)
|
117
|
+
elsif type =~ /\AArray<(.*)>/i
|
115
118
|
# check to ensure the input is an array given that the attribute
|
116
119
|
# is documented as an array but the input is not
|
117
120
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -119,7 +122,7 @@ module VeloPayments
|
|
119
122
|
end
|
120
123
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
121
124
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
122
|
-
end
|
125
|
+
end
|
123
126
|
end
|
124
127
|
|
125
128
|
self
|
@@ -131,8 +134,8 @@ module VeloPayments
|
|
131
134
|
# @return [Object] Deserialized data
|
132
135
|
def _deserialize(type, value)
|
133
136
|
case type.to_sym
|
134
|
-
when :
|
135
|
-
|
137
|
+
when :Time
|
138
|
+
Time.parse(value)
|
136
139
|
when :Date
|
137
140
|
Date.parse(value)
|
138
141
|
when :String
|
@@ -211,5 +214,6 @@ module VeloPayments
|
|
211
214
|
value
|
212
215
|
end
|
213
216
|
end
|
217
|
+
|
214
218
|
end
|
215
219
|
end
|
@@ -3,14 +3,15 @@
|
|
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.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
17
|
class FundingAccountResponse
|
@@ -19,14 +20,29 @@ module VeloPayments
|
|
19
20
|
|
20
21
|
attr_accessor :payor_id
|
21
22
|
|
23
|
+
# name on the bank account
|
22
24
|
attr_accessor :account_name
|
23
25
|
|
26
|
+
# bank account number
|
24
27
|
attr_accessor :account_number
|
25
28
|
|
29
|
+
# bank account routing number
|
26
30
|
attr_accessor :routing_number
|
27
31
|
|
28
32
|
attr_accessor :source_account_ids
|
29
33
|
|
34
|
+
# name of funding account
|
35
|
+
attr_accessor :name
|
36
|
+
|
37
|
+
# ISO 4217 currency code
|
38
|
+
attr_accessor :currency
|
39
|
+
|
40
|
+
# ISO 3166-1 2 letter country code (upper case)
|
41
|
+
attr_accessor :country
|
42
|
+
|
43
|
+
# Funding account type
|
44
|
+
attr_accessor :type
|
45
|
+
|
30
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
47
|
def self.attribute_map
|
32
48
|
{
|
@@ -35,7 +51,11 @@ module VeloPayments
|
|
35
51
|
:'account_name' => :'accountName',
|
36
52
|
:'account_number' => :'accountNumber',
|
37
53
|
:'routing_number' => :'routingNumber',
|
38
|
-
:'source_account_ids' => :'sourceAccountIds'
|
54
|
+
:'source_account_ids' => :'sourceAccountIds',
|
55
|
+
:'name' => :'name',
|
56
|
+
:'currency' => :'currency',
|
57
|
+
:'country' => :'country',
|
58
|
+
:'type' => :'type'
|
39
59
|
}
|
40
60
|
end
|
41
61
|
|
@@ -47,7 +67,11 @@ module VeloPayments
|
|
47
67
|
:'account_name' => :'String',
|
48
68
|
:'account_number' => :'String',
|
49
69
|
:'routing_number' => :'String',
|
50
|
-
:'source_account_ids' => :'Array<String>'
|
70
|
+
:'source_account_ids' => :'Array<String>',
|
71
|
+
:'name' => :'String',
|
72
|
+
:'currency' => :'String',
|
73
|
+
:'country' => :'String',
|
74
|
+
:'type' => :'String'
|
51
75
|
}
|
52
76
|
end
|
53
77
|
|
@@ -97,21 +121,85 @@ module VeloPayments
|
|
97
121
|
self.source_account_ids = value
|
98
122
|
end
|
99
123
|
end
|
124
|
+
|
125
|
+
if attributes.key?(:'name')
|
126
|
+
self.name = attributes[:'name']
|
127
|
+
end
|
128
|
+
|
129
|
+
if attributes.key?(:'currency')
|
130
|
+
self.currency = attributes[:'currency']
|
131
|
+
end
|
132
|
+
|
133
|
+
if attributes.key?(:'country')
|
134
|
+
self.country = attributes[:'country']
|
135
|
+
end
|
136
|
+
|
137
|
+
if attributes.key?(:'type')
|
138
|
+
self.type = attributes[:'type']
|
139
|
+
end
|
100
140
|
end
|
101
141
|
|
102
142
|
# Show invalid properties with the reasons. Usually used together with valid?
|
103
143
|
# @return Array for valid properties with the reasons
|
104
144
|
def list_invalid_properties
|
105
145
|
invalid_properties = Array.new
|
146
|
+
if !@currency.nil? && @currency.to_s.length > 3
|
147
|
+
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
148
|
+
end
|
149
|
+
|
150
|
+
if !@currency.nil? && @currency.to_s.length < 3
|
151
|
+
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
152
|
+
end
|
153
|
+
|
154
|
+
if !@country.nil? && @country.to_s.length > 2
|
155
|
+
invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
|
156
|
+
end
|
157
|
+
|
158
|
+
if !@country.nil? && @country.to_s.length < 2
|
159
|
+
invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
|
160
|
+
end
|
161
|
+
|
106
162
|
invalid_properties
|
107
163
|
end
|
108
164
|
|
109
165
|
# Check to see if the all the properties in the model are valid
|
110
166
|
# @return true if the model is valid
|
111
167
|
def valid?
|
168
|
+
return false if !@currency.nil? && @currency.to_s.length > 3
|
169
|
+
return false if !@currency.nil? && @currency.to_s.length < 3
|
170
|
+
return false if !@country.nil? && @country.to_s.length > 2
|
171
|
+
return false if !@country.nil? && @country.to_s.length < 2
|
112
172
|
true
|
113
173
|
end
|
114
174
|
|
175
|
+
# Custom attribute writer method with validation
|
176
|
+
# @param [Object] currency Value to be assigned
|
177
|
+
def currency=(currency)
|
178
|
+
if !currency.nil? && currency.to_s.length > 3
|
179
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
180
|
+
end
|
181
|
+
|
182
|
+
if !currency.nil? && currency.to_s.length < 3
|
183
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
184
|
+
end
|
185
|
+
|
186
|
+
@currency = currency
|
187
|
+
end
|
188
|
+
|
189
|
+
# Custom attribute writer method with validation
|
190
|
+
# @param [Object] country Value to be assigned
|
191
|
+
def country=(country)
|
192
|
+
if !country.nil? && country.to_s.length > 2
|
193
|
+
fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
|
194
|
+
end
|
195
|
+
|
196
|
+
if !country.nil? && country.to_s.length < 2
|
197
|
+
fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
|
198
|
+
end
|
199
|
+
|
200
|
+
@country = country
|
201
|
+
end
|
202
|
+
|
115
203
|
# Checks equality by comparing each attribute.
|
116
204
|
# @param [Object] Object to be compared
|
117
205
|
def ==(o)
|
@@ -122,7 +210,11 @@ module VeloPayments
|
|
122
210
|
account_name == o.account_name &&
|
123
211
|
account_number == o.account_number &&
|
124
212
|
routing_number == o.routing_number &&
|
125
|
-
source_account_ids == o.source_account_ids
|
213
|
+
source_account_ids == o.source_account_ids &&
|
214
|
+
name == o.name &&
|
215
|
+
currency == o.currency &&
|
216
|
+
country == o.country &&
|
217
|
+
type == o.type
|
126
218
|
end
|
127
219
|
|
128
220
|
# @see the `==` method
|
@@ -134,7 +226,7 @@ module VeloPayments
|
|
134
226
|
# Calculates hash code according to all attributes.
|
135
227
|
# @return [Integer] Hash code
|
136
228
|
def hash
|
137
|
-
[id, payor_id, account_name, account_number, routing_number, source_account_ids].hash
|
229
|
+
[id, payor_id, account_name, account_number, routing_number, source_account_ids, name, currency, country, type].hash
|
138
230
|
end
|
139
231
|
|
140
232
|
# Builds the object from hash
|
@@ -150,7 +242,9 @@ module VeloPayments
|
|
150
242
|
def build_from_hash(attributes)
|
151
243
|
return nil unless attributes.is_a?(Hash)
|
152
244
|
self.class.openapi_types.each_pair do |key, type|
|
153
|
-
if
|
245
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
246
|
+
self.send("#{key}=", nil)
|
247
|
+
elsif type =~ /\AArray<(.*)>/i
|
154
248
|
# check to ensure the input is an array given that the attribute
|
155
249
|
# is documented as an array but the input is not
|
156
250
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -158,7 +252,7 @@ module VeloPayments
|
|
158
252
|
end
|
159
253
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
160
254
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
161
|
-
end
|
255
|
+
end
|
162
256
|
end
|
163
257
|
|
164
258
|
self
|
@@ -170,8 +264,8 @@ module VeloPayments
|
|
170
264
|
# @return [Object] Deserialized data
|
171
265
|
def _deserialize(type, value)
|
172
266
|
case type.to_sym
|
173
|
-
when :
|
174
|
-
|
267
|
+
when :Time
|
268
|
+
Time.parse(value)
|
175
269
|
when :Date
|
176
270
|
Date.parse(value)
|
177
271
|
when :String
|
@@ -250,5 +344,6 @@ module VeloPayments
|
|
250
344
|
value
|
251
345
|
end
|
252
346
|
end
|
347
|
+
|
253
348
|
end
|
254
349
|
end
|
data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb}
RENAMED
@@ -3,42 +3,76 @@
|
|
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.23.78
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'date'
|
14
|
+
require 'time'
|
14
15
|
|
15
16
|
module VeloPayments
|
16
|
-
class
|
17
|
+
class FundingAccountResponse2
|
18
|
+
# Funding Account Id
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
attr_accessor :payor_id
|
22
|
+
|
23
|
+
# name on the bank account
|
17
24
|
attr_accessor :account_name
|
18
25
|
|
26
|
+
# bank account number
|
19
27
|
attr_accessor :account_number
|
20
28
|
|
29
|
+
# bank account routing number
|
21
30
|
attr_accessor :routing_number
|
22
31
|
|
23
|
-
|
32
|
+
# name of funding account
|
33
|
+
attr_accessor :name
|
34
|
+
|
35
|
+
# ISO 4217 currency code
|
36
|
+
attr_accessor :currency
|
37
|
+
|
38
|
+
# ISO 3166-1 2 letter country code (upper case)
|
39
|
+
attr_accessor :country
|
40
|
+
|
41
|
+
# Funding account type
|
42
|
+
attr_accessor :type
|
43
|
+
|
44
|
+
# A flag for whether the funding account has been archived. Only present in the response if true.
|
45
|
+
attr_accessor :archived
|
24
46
|
|
25
47
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
48
|
def self.attribute_map
|
27
49
|
{
|
50
|
+
:'id' => :'id',
|
51
|
+
:'payor_id' => :'payorId',
|
28
52
|
:'account_name' => :'accountName',
|
29
53
|
:'account_number' => :'accountNumber',
|
30
54
|
:'routing_number' => :'routingNumber',
|
31
|
-
:'
|
55
|
+
:'name' => :'name',
|
56
|
+
:'currency' => :'currency',
|
57
|
+
:'country' => :'country',
|
58
|
+
:'type' => :'type',
|
59
|
+
:'archived' => :'archived'
|
32
60
|
}
|
33
61
|
end
|
34
62
|
|
35
63
|
# Attribute type mapping.
|
36
64
|
def self.openapi_types
|
37
65
|
{
|
66
|
+
:'id' => :'String',
|
67
|
+
:'payor_id' => :'String',
|
38
68
|
:'account_name' => :'String',
|
39
69
|
:'account_number' => :'String',
|
40
70
|
:'routing_number' => :'String',
|
41
|
-
:'
|
71
|
+
:'name' => :'String',
|
72
|
+
:'currency' => :'String',
|
73
|
+
:'country' => :'String',
|
74
|
+
:'type' => :'String',
|
75
|
+
:'archived' => :'Boolean'
|
42
76
|
}
|
43
77
|
end
|
44
78
|
|
@@ -52,17 +86,25 @@ module VeloPayments
|
|
52
86
|
# @param [Hash] attributes Model attributes in the form of hash
|
53
87
|
def initialize(attributes = {})
|
54
88
|
if (!attributes.is_a?(Hash))
|
55
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
89
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::FundingAccountResponse2` initialize method"
|
56
90
|
end
|
57
91
|
|
58
92
|
# check to see if the attribute exists and convert string to symbol for hash key
|
59
93
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
60
94
|
if (!self.class.attribute_map.key?(k.to_sym))
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
95
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::FundingAccountResponse2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
62
96
|
end
|
63
97
|
h[k.to_sym] = v
|
64
98
|
}
|
65
99
|
|
100
|
+
if attributes.key?(:'id')
|
101
|
+
self.id = attributes[:'id']
|
102
|
+
end
|
103
|
+
|
104
|
+
if attributes.key?(:'payor_id')
|
105
|
+
self.payor_id = attributes[:'payor_id']
|
106
|
+
end
|
107
|
+
|
66
108
|
if attributes.key?(:'account_name')
|
67
109
|
self.account_name = attributes[:'account_name']
|
68
110
|
end
|
@@ -75,53 +117,45 @@ module VeloPayments
|
|
75
117
|
self.routing_number = attributes[:'routing_number']
|
76
118
|
end
|
77
119
|
|
78
|
-
if attributes.key?(:'
|
79
|
-
self.
|
80
|
-
end
|
81
|
-
end
|
82
|
-
|
83
|
-
# Show invalid properties with the reasons. Usually used together with valid?
|
84
|
-
# @return Array for valid properties with the reasons
|
85
|
-
def list_invalid_properties
|
86
|
-
invalid_properties = Array.new
|
87
|
-
if @account_name.nil?
|
88
|
-
invalid_properties.push('invalid value for "account_name", account_name cannot be nil.')
|
120
|
+
if attributes.key?(:'name')
|
121
|
+
self.name = attributes[:'name']
|
89
122
|
end
|
90
123
|
|
91
|
-
if
|
92
|
-
|
124
|
+
if attributes.key?(:'currency')
|
125
|
+
self.currency = attributes[:'currency']
|
93
126
|
end
|
94
127
|
|
95
|
-
if
|
96
|
-
|
128
|
+
if attributes.key?(:'country')
|
129
|
+
self.country = attributes[:'country']
|
97
130
|
end
|
98
131
|
|
99
|
-
if
|
100
|
-
|
132
|
+
if attributes.key?(:'type')
|
133
|
+
self.type = attributes[:'type']
|
101
134
|
end
|
102
135
|
|
103
|
-
if
|
104
|
-
|
105
|
-
end
|
106
|
-
|
107
|
-
if @account_number.to_s.length < 4
|
108
|
-
invalid_properties.push('invalid value for "account_number", the character length must be great than or equal to 4.')
|
136
|
+
if attributes.key?(:'archived')
|
137
|
+
self.archived = attributes[:'archived']
|
109
138
|
end
|
139
|
+
end
|
110
140
|
|
111
|
-
|
112
|
-
|
141
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
142
|
+
# @return Array for valid properties with the reasons
|
143
|
+
def list_invalid_properties
|
144
|
+
invalid_properties = Array.new
|
145
|
+
if !@currency.nil? && @currency.to_s.length > 3
|
146
|
+
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
113
147
|
end
|
114
148
|
|
115
|
-
if @
|
116
|
-
invalid_properties.push('invalid value for "
|
149
|
+
if !@currency.nil? && @currency.to_s.length < 3
|
150
|
+
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
117
151
|
end
|
118
152
|
|
119
|
-
if @
|
120
|
-
invalid_properties.push('invalid value for "
|
153
|
+
if !@country.nil? && @country.to_s.length > 2
|
154
|
+
invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
|
121
155
|
end
|
122
156
|
|
123
|
-
if
|
124
|
-
invalid_properties.push('invalid value for "
|
157
|
+
if !@country.nil? && @country.to_s.length < 2
|
158
|
+
invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
|
125
159
|
end
|
126
160
|
|
127
161
|
invalid_properties
|
@@ -130,71 +164,39 @@ module VeloPayments
|
|
130
164
|
# Check to see if the all the properties in the model are valid
|
131
165
|
# @return true if the model is valid
|
132
166
|
def valid?
|
133
|
-
return false if
|
134
|
-
return false if @
|
135
|
-
return false if @
|
136
|
-
return false if
|
137
|
-
return false if @account_number.to_s.length > 17
|
138
|
-
return false if @account_number.to_s.length < 4
|
139
|
-
return false if @routing_number.nil?
|
140
|
-
return false if @routing_number.to_s.length > 9
|
141
|
-
return false if @routing_number.to_s.length < 9
|
142
|
-
return false if @payor_id.nil?
|
167
|
+
return false if !@currency.nil? && @currency.to_s.length > 3
|
168
|
+
return false if !@currency.nil? && @currency.to_s.length < 3
|
169
|
+
return false if !@country.nil? && @country.to_s.length > 2
|
170
|
+
return false if !@country.nil? && @country.to_s.length < 2
|
143
171
|
true
|
144
172
|
end
|
145
173
|
|
146
174
|
# Custom attribute writer method with validation
|
147
|
-
# @param [Object]
|
148
|
-
def
|
149
|
-
if
|
150
|
-
fail ArgumentError, '
|
151
|
-
end
|
152
|
-
|
153
|
-
if account_name.to_s.length > 22
|
154
|
-
fail ArgumentError, 'invalid value for "account_name", the character length must be smaller than or equal to 22.'
|
155
|
-
end
|
156
|
-
|
157
|
-
if account_name.to_s.length < 1
|
158
|
-
fail ArgumentError, 'invalid value for "account_name", the character length must be great than or equal to 1.'
|
159
|
-
end
|
160
|
-
|
161
|
-
@account_name = account_name
|
162
|
-
end
|
163
|
-
|
164
|
-
# Custom attribute writer method with validation
|
165
|
-
# @param [Object] account_number Value to be assigned
|
166
|
-
def account_number=(account_number)
|
167
|
-
if account_number.nil?
|
168
|
-
fail ArgumentError, 'account_number cannot be nil'
|
175
|
+
# @param [Object] currency Value to be assigned
|
176
|
+
def currency=(currency)
|
177
|
+
if !currency.nil? && currency.to_s.length > 3
|
178
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
169
179
|
end
|
170
180
|
|
171
|
-
if
|
172
|
-
fail ArgumentError, 'invalid value for "
|
181
|
+
if !currency.nil? && currency.to_s.length < 3
|
182
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
173
183
|
end
|
174
184
|
|
175
|
-
|
176
|
-
fail ArgumentError, 'invalid value for "account_number", the character length must be great than or equal to 4.'
|
177
|
-
end
|
178
|
-
|
179
|
-
@account_number = account_number
|
185
|
+
@currency = currency
|
180
186
|
end
|
181
187
|
|
182
188
|
# Custom attribute writer method with validation
|
183
|
-
# @param [Object]
|
184
|
-
def
|
185
|
-
if
|
186
|
-
fail ArgumentError, '
|
187
|
-
end
|
188
|
-
|
189
|
-
if routing_number.to_s.length > 9
|
190
|
-
fail ArgumentError, 'invalid value for "routing_number", the character length must be smaller than or equal to 9.'
|
189
|
+
# @param [Object] country Value to be assigned
|
190
|
+
def country=(country)
|
191
|
+
if !country.nil? && country.to_s.length > 2
|
192
|
+
fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
|
191
193
|
end
|
192
194
|
|
193
|
-
if
|
194
|
-
fail ArgumentError, 'invalid value for "
|
195
|
+
if !country.nil? && country.to_s.length < 2
|
196
|
+
fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
|
195
197
|
end
|
196
198
|
|
197
|
-
@
|
199
|
+
@country = country
|
198
200
|
end
|
199
201
|
|
200
202
|
# Checks equality by comparing each attribute.
|
@@ -202,10 +204,16 @@ module VeloPayments
|
|
202
204
|
def ==(o)
|
203
205
|
return true if self.equal?(o)
|
204
206
|
self.class == o.class &&
|
207
|
+
id == o.id &&
|
208
|
+
payor_id == o.payor_id &&
|
205
209
|
account_name == o.account_name &&
|
206
210
|
account_number == o.account_number &&
|
207
211
|
routing_number == o.routing_number &&
|
208
|
-
|
212
|
+
name == o.name &&
|
213
|
+
currency == o.currency &&
|
214
|
+
country == o.country &&
|
215
|
+
type == o.type &&
|
216
|
+
archived == o.archived
|
209
217
|
end
|
210
218
|
|
211
219
|
# @see the `==` method
|
@@ -217,7 +225,7 @@ module VeloPayments
|
|
217
225
|
# Calculates hash code according to all attributes.
|
218
226
|
# @return [Integer] Hash code
|
219
227
|
def hash
|
220
|
-
[account_name, account_number, routing_number,
|
228
|
+
[id, payor_id, account_name, account_number, routing_number, name, currency, country, type, archived].hash
|
221
229
|
end
|
222
230
|
|
223
231
|
# Builds the object from hash
|
@@ -233,7 +241,9 @@ module VeloPayments
|
|
233
241
|
def build_from_hash(attributes)
|
234
242
|
return nil unless attributes.is_a?(Hash)
|
235
243
|
self.class.openapi_types.each_pair do |key, type|
|
236
|
-
if
|
244
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
245
|
+
self.send("#{key}=", nil)
|
246
|
+
elsif type =~ /\AArray<(.*)>/i
|
237
247
|
# check to ensure the input is an array given that the attribute
|
238
248
|
# is documented as an array but the input is not
|
239
249
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -241,7 +251,7 @@ module VeloPayments
|
|
241
251
|
end
|
242
252
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
243
253
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
244
|
-
end
|
254
|
+
end
|
245
255
|
end
|
246
256
|
|
247
257
|
self
|
@@ -253,8 +263,8 @@ module VeloPayments
|
|
253
263
|
# @return [Object] Deserialized data
|
254
264
|
def _deserialize(type, value)
|
255
265
|
case type.to_sym
|
256
|
-
when :
|
257
|
-
|
266
|
+
when :Time
|
267
|
+
Time.parse(value)
|
258
268
|
when :Date
|
259
269
|
Date.parse(value)
|
260
270
|
when :String
|
@@ -333,5 +343,6 @@ module VeloPayments
|
|
333
343
|
value
|
334
344
|
end
|
335
345
|
end
|
346
|
+
|
336
347
|
end
|
337
348
|
end
|