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
|
class SourceAccountSummaryV4
|
@@ -130,7 +131,9 @@ module VeloPayments
|
|
130
131
|
def build_from_hash(attributes)
|
131
132
|
return nil unless attributes.is_a?(Hash)
|
132
133
|
self.class.openapi_types.each_pair do |key, type|
|
133
|
-
if
|
134
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
135
|
+
self.send("#{key}=", nil)
|
136
|
+
elsif type =~ /\AArray<(.*)>/i
|
134
137
|
# check to ensure the input is an array given that the attribute
|
135
138
|
# is documented as an array but the input is not
|
136
139
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -138,7 +141,7 @@ module VeloPayments
|
|
138
141
|
end
|
139
142
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
140
143
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
141
|
-
end
|
144
|
+
end
|
142
145
|
end
|
143
146
|
|
144
147
|
self
|
@@ -150,8 +153,8 @@ module VeloPayments
|
|
150
153
|
# @return [Object] Deserialized data
|
151
154
|
def _deserialize(type, value)
|
152
155
|
case type.to_sym
|
153
|
-
when :
|
154
|
-
|
156
|
+
when :Time
|
157
|
+
Time.parse(value)
|
155
158
|
when :Date
|
156
159
|
Date.parse(value)
|
157
160
|
when :String
|
@@ -230,5 +233,6 @@ module VeloPayments
|
|
230
233
|
value
|
231
234
|
end
|
232
235
|
end
|
236
|
+
|
233
237
|
end
|
234
238
|
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
=begin
|
2
|
+
#Velo Payments APIs
|
3
|
+
|
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
|
+
|
6
|
+
The version of the OpenAPI document: 2.23.78
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module VeloPayments
|
17
|
+
class SourceAccountType
|
18
|
+
FBO = "FBO".freeze
|
19
|
+
WUBS_DECOUPLED = "WUBS_DECOUPLED".freeze
|
20
|
+
|
21
|
+
# Builds the enum from string
|
22
|
+
# @param [String] The enum value in the form of the string
|
23
|
+
# @return [String] The enum value
|
24
|
+
def self.build_from_hash(value)
|
25
|
+
new.build_from_hash(value)
|
26
|
+
end
|
27
|
+
|
28
|
+
# Builds the enum from string
|
29
|
+
# @param [String] The enum value in the form of the string
|
30
|
+
# @return [String] The enum value
|
31
|
+
def build_from_hash(value)
|
32
|
+
constantValues = SourceAccountType.constants.select { |c| SourceAccountType::const_get(c) == value }
|
33
|
+
raise "Invalid ENUM value #{value} for class #SourceAccountType" if constantValues.empty?
|
34
|
+
value
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -3,17 +3,18 @@
|
|
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 SourceAccountV3
|
17
18
|
attr_accessor :source_account_name
|
18
19
|
|
19
20
|
attr_accessor :source_account_id
|
@@ -53,13 +54,13 @@ module VeloPayments
|
|
53
54
|
# @param [Hash] attributes Model attributes in the form of hash
|
54
55
|
def initialize(attributes = {})
|
55
56
|
if (!attributes.is_a?(Hash))
|
56
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
57
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::SourceAccountV3` initialize method"
|
57
58
|
end
|
58
59
|
|
59
60
|
# check to see if the attribute exists and convert string to symbol for hash key
|
60
61
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
61
62
|
if (!self.class.attribute_map.key?(k.to_sym))
|
62
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::SourceAccountV3`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
63
64
|
end
|
64
65
|
h[k.to_sym] = v
|
65
66
|
}
|
@@ -189,7 +190,9 @@ module VeloPayments
|
|
189
190
|
def build_from_hash(attributes)
|
190
191
|
return nil unless attributes.is_a?(Hash)
|
191
192
|
self.class.openapi_types.each_pair do |key, type|
|
192
|
-
if
|
193
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
194
|
+
self.send("#{key}=", nil)
|
195
|
+
elsif type =~ /\AArray<(.*)>/i
|
193
196
|
# check to ensure the input is an array given that the attribute
|
194
197
|
# is documented as an array but the input is not
|
195
198
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -197,7 +200,7 @@ module VeloPayments
|
|
197
200
|
end
|
198
201
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
199
202
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
200
|
-
end
|
203
|
+
end
|
201
204
|
end
|
202
205
|
|
203
206
|
self
|
@@ -209,8 +212,8 @@ module VeloPayments
|
|
209
212
|
# @return [Object] Deserialized data
|
210
213
|
def _deserialize(type, value)
|
211
214
|
case type.to_sym
|
212
|
-
when :
|
213
|
-
|
215
|
+
when :Time
|
216
|
+
Time.parse(value)
|
214
217
|
when :Date
|
215
218
|
Date.parse(value)
|
216
219
|
when :String
|
@@ -289,5 +292,6 @@ module VeloPayments
|
|
289
292
|
value
|
290
293
|
end
|
291
294
|
end
|
295
|
+
|
292
296
|
end
|
293
297
|
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 SupportedCountriesResponse
|
@@ -104,7 +105,9 @@ module VeloPayments
|
|
104
105
|
def build_from_hash(attributes)
|
105
106
|
return nil unless attributes.is_a?(Hash)
|
106
107
|
self.class.openapi_types.each_pair do |key, type|
|
107
|
-
if
|
108
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
109
|
+
self.send("#{key}=", nil)
|
110
|
+
elsif type =~ /\AArray<(.*)>/i
|
108
111
|
# check to ensure the input is an array given that the attribute
|
109
112
|
# is documented as an array but the input is not
|
110
113
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -112,7 +115,7 @@ module VeloPayments
|
|
112
115
|
end
|
113
116
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
114
117
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
115
|
-
end
|
118
|
+
end
|
116
119
|
end
|
117
120
|
|
118
121
|
self
|
@@ -124,8 +127,8 @@ module VeloPayments
|
|
124
127
|
# @return [Object] Deserialized data
|
125
128
|
def _deserialize(type, value)
|
126
129
|
case type.to_sym
|
127
|
-
when :
|
128
|
-
|
130
|
+
when :Time
|
131
|
+
Time.parse(value)
|
129
132
|
when :Date
|
130
133
|
Date.parse(value)
|
131
134
|
when :String
|
@@ -204,5 +207,6 @@ module VeloPayments
|
|
204
207
|
value
|
205
208
|
end
|
206
209
|
end
|
210
|
+
|
207
211
|
end
|
208
212
|
end
|
data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb}
RENAMED
@@ -3,17 +3,18 @@
|
|
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 SupportedCountriesResponseV2
|
17
18
|
attr_accessor :countries
|
18
19
|
|
19
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -26,7 +27,7 @@ module VeloPayments
|
|
26
27
|
# Attribute type mapping.
|
27
28
|
def self.openapi_types
|
28
29
|
{
|
29
|
-
:'countries' => :'Array<
|
30
|
+
:'countries' => :'Array<SupportedCountryV2>'
|
30
31
|
}
|
31
32
|
end
|
32
33
|
|
@@ -40,13 +41,13 @@ module VeloPayments
|
|
40
41
|
# @param [Hash] attributes Model attributes in the form of hash
|
41
42
|
def initialize(attributes = {})
|
42
43
|
if (!attributes.is_a?(Hash))
|
43
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
44
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::SupportedCountriesResponseV2` initialize method"
|
44
45
|
end
|
45
46
|
|
46
47
|
# check to see if the attribute exists and convert string to symbol for hash key
|
47
48
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
48
49
|
if (!self.class.attribute_map.key?(k.to_sym))
|
49
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
50
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::SupportedCountriesResponseV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
50
51
|
end
|
51
52
|
h[k.to_sym] = v
|
52
53
|
}
|
@@ -104,7 +105,9 @@ module VeloPayments
|
|
104
105
|
def build_from_hash(attributes)
|
105
106
|
return nil unless attributes.is_a?(Hash)
|
106
107
|
self.class.openapi_types.each_pair do |key, type|
|
107
|
-
if
|
108
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
109
|
+
self.send("#{key}=", nil)
|
110
|
+
elsif type =~ /\AArray<(.*)>/i
|
108
111
|
# check to ensure the input is an array given that the attribute
|
109
112
|
# is documented as an array but the input is not
|
110
113
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -112,7 +115,7 @@ module VeloPayments
|
|
112
115
|
end
|
113
116
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
114
117
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
115
|
-
end
|
118
|
+
end
|
116
119
|
end
|
117
120
|
|
118
121
|
self
|
@@ -124,8 +127,8 @@ module VeloPayments
|
|
124
127
|
# @return [Object] Deserialized data
|
125
128
|
def _deserialize(type, value)
|
126
129
|
case type.to_sym
|
127
|
-
when :
|
128
|
-
|
130
|
+
when :Time
|
131
|
+
Time.parse(value)
|
129
132
|
when :Date
|
130
133
|
Date.parse(value)
|
131
134
|
when :String
|
@@ -204,5 +207,6 @@ module VeloPayments
|
|
204
207
|
value
|
205
208
|
end
|
206
209
|
end
|
210
|
+
|
207
211
|
end
|
208
212
|
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 SupportedCountry
|
@@ -149,7 +150,9 @@ module VeloPayments
|
|
149
150
|
def build_from_hash(attributes)
|
150
151
|
return nil unless attributes.is_a?(Hash)
|
151
152
|
self.class.openapi_types.each_pair do |key, type|
|
152
|
-
if
|
153
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
154
|
+
self.send("#{key}=", nil)
|
155
|
+
elsif type =~ /\AArray<(.*)>/i
|
153
156
|
# check to ensure the input is an array given that the attribute
|
154
157
|
# is documented as an array but the input is not
|
155
158
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -157,7 +160,7 @@ module VeloPayments
|
|
157
160
|
end
|
158
161
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
159
162
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
160
|
-
end
|
163
|
+
end
|
161
164
|
end
|
162
165
|
|
163
166
|
self
|
@@ -169,8 +172,8 @@ module VeloPayments
|
|
169
172
|
# @return [Object] Deserialized data
|
170
173
|
def _deserialize(type, value)
|
171
174
|
case type.to_sym
|
172
|
-
when :
|
173
|
-
|
175
|
+
when :Time
|
176
|
+
Time.parse(value)
|
174
177
|
when :Date
|
175
178
|
Date.parse(value)
|
176
179
|
when :String
|
@@ -249,5 +252,6 @@ module VeloPayments
|
|
249
252
|
value
|
250
253
|
end
|
251
254
|
end
|
255
|
+
|
252
256
|
end
|
253
257
|
end
|
@@ -3,17 +3,18 @@
|
|
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 SupportedCountryV2
|
17
18
|
# Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details.
|
18
19
|
attr_accessor :iso_country_code
|
19
20
|
|
@@ -35,7 +36,7 @@ module VeloPayments
|
|
35
36
|
{
|
36
37
|
:'iso_country_code' => :'String',
|
37
38
|
:'currencies' => :'Array<String>',
|
38
|
-
:'regions' => :'Array<
|
39
|
+
:'regions' => :'Array<RegionV2>'
|
39
40
|
}
|
40
41
|
end
|
41
42
|
|
@@ -49,13 +50,13 @@ module VeloPayments
|
|
49
50
|
# @param [Hash] attributes Model attributes in the form of hash
|
50
51
|
def initialize(attributes = {})
|
51
52
|
if (!attributes.is_a?(Hash))
|
52
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
53
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::SupportedCountryV2` initialize method"
|
53
54
|
end
|
54
55
|
|
55
56
|
# check to see if the attribute exists and convert string to symbol for hash key
|
56
57
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
57
58
|
if (!self.class.attribute_map.key?(k.to_sym))
|
58
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
59
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::SupportedCountryV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
59
60
|
end
|
60
61
|
h[k.to_sym] = v
|
61
62
|
}
|
@@ -160,7 +161,9 @@ module VeloPayments
|
|
160
161
|
def build_from_hash(attributes)
|
161
162
|
return nil unless attributes.is_a?(Hash)
|
162
163
|
self.class.openapi_types.each_pair do |key, type|
|
163
|
-
if
|
164
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
165
|
+
self.send("#{key}=", nil)
|
166
|
+
elsif type =~ /\AArray<(.*)>/i
|
164
167
|
# check to ensure the input is an array given that the attribute
|
165
168
|
# is documented as an array but the input is not
|
166
169
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -168,7 +171,7 @@ module VeloPayments
|
|
168
171
|
end
|
169
172
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
170
173
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
171
|
-
end
|
174
|
+
end
|
172
175
|
end
|
173
176
|
|
174
177
|
self
|
@@ -180,8 +183,8 @@ module VeloPayments
|
|
180
183
|
# @return [Object] Deserialized data
|
181
184
|
def _deserialize(type, value)
|
182
185
|
case type.to_sym
|
183
|
-
when :
|
184
|
-
|
186
|
+
when :Time
|
187
|
+
Time.parse(value)
|
185
188
|
when :Date
|
186
189
|
Date.parse(value)
|
187
190
|
when :String
|
@@ -260,5 +263,6 @@ module VeloPayments
|
|
260
263
|
value
|
261
264
|
end
|
262
265
|
end
|
266
|
+
|
263
267
|
end
|
264
268
|
end
|
data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb}
RENAMED
@@ -3,17 +3,18 @@
|
|
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 SupportedCurrencyResponseV2
|
17
18
|
attr_accessor :currencies
|
18
19
|
|
19
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -26,7 +27,7 @@ module VeloPayments
|
|
26
27
|
# Attribute type mapping.
|
27
28
|
def self.openapi_types
|
28
29
|
{
|
29
|
-
:'currencies' => :'Array<
|
30
|
+
:'currencies' => :'Array<SupportedCurrencyV2>'
|
30
31
|
}
|
31
32
|
end
|
32
33
|
|
@@ -40,13 +41,13 @@ module VeloPayments
|
|
40
41
|
# @param [Hash] attributes Model attributes in the form of hash
|
41
42
|
def initialize(attributes = {})
|
42
43
|
if (!attributes.is_a?(Hash))
|
43
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
44
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::SupportedCurrencyResponseV2` initialize method"
|
44
45
|
end
|
45
46
|
|
46
47
|
# check to see if the attribute exists and convert string to symbol for hash key
|
47
48
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
48
49
|
if (!self.class.attribute_map.key?(k.to_sym))
|
49
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
50
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::SupportedCurrencyResponseV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
50
51
|
end
|
51
52
|
h[k.to_sym] = v
|
52
53
|
}
|
@@ -104,7 +105,9 @@ module VeloPayments
|
|
104
105
|
def build_from_hash(attributes)
|
105
106
|
return nil unless attributes.is_a?(Hash)
|
106
107
|
self.class.openapi_types.each_pair do |key, type|
|
107
|
-
if
|
108
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
109
|
+
self.send("#{key}=", nil)
|
110
|
+
elsif type =~ /\AArray<(.*)>/i
|
108
111
|
# check to ensure the input is an array given that the attribute
|
109
112
|
# is documented as an array but the input is not
|
110
113
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -112,7 +115,7 @@ module VeloPayments
|
|
112
115
|
end
|
113
116
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
114
117
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
115
|
-
end
|
118
|
+
end
|
116
119
|
end
|
117
120
|
|
118
121
|
self
|
@@ -124,8 +127,8 @@ module VeloPayments
|
|
124
127
|
# @return [Object] Deserialized data
|
125
128
|
def _deserialize(type, value)
|
126
129
|
case type.to_sym
|
127
|
-
when :
|
128
|
-
|
130
|
+
when :Time
|
131
|
+
Time.parse(value)
|
129
132
|
when :Date
|
130
133
|
Date.parse(value)
|
131
134
|
when :String
|
@@ -204,5 +207,6 @@ module VeloPayments
|
|
204
207
|
value
|
205
208
|
end
|
206
209
|
end
|
210
|
+
|
207
211
|
end
|
208
212
|
end
|