velopayments 2.17.8 → 2.18.31.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Makefile +11 -6
- data/README.md +123 -35
- data/docs/AcceptedPayment.md +27 -0
- data/docs/AccessTokenResponse.md +29 -0
- data/docs/AccessTokenValidationRequest.md +17 -0
- data/docs/CheckTokenResponse.md +25 -0
- data/docs/CountriesApi.md +51 -2
- data/docs/CreateFundingAccountRequest.md +23 -0
- data/docs/CreatePayorLinkRequest.md +21 -0
- data/docs/CurrencyType.md +17 -0
- data/docs/DefaultApi.md +62 -0
- data/docs/EmailUpdateRequest.md +19 -0
- data/docs/FundingAccountResponse.md +27 -0
- data/docs/FundingManagerApi.md +197 -21
- data/docs/FundingPayorStatusAuditResponse.md +23 -0
- data/docs/GenerateOTPRequest.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +2 -0
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +15 -13
- data/docs/GetPayoutApi.md +5 -5
- data/docs/GetPayoutsResponseV3.md +1 -3
- data/docs/GetPayoutsResponseV4.md +1 -3
- data/docs/InstructPayoutApi.md +5 -5
- data/docs/InviteUserRequest.md +35 -0
- data/docs/KycState.md +16 -0
- data/docs/LinkForResponse.md +19 -0
- data/docs/ListFundingAccountsResponse.md +21 -0
- data/docs/ListPaymentsResponse.md +1 -3
- data/docs/ListPaymentsResponseV4.md +21 -0
- data/docs/ListSourceAccountResponseV2.md +1 -1
- data/docs/LoginApi.md +212 -0
- data/docs/MFADetails.md +19 -0
- data/docs/MFAStatus.md +16 -0
- data/docs/MFAType.md +16 -0
- data/docs/OTPType.md +16 -0
- data/docs/PageForResponse.md +25 -0
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +21 -0
- data/docs/PagedUserResponse.md +21 -0
- data/docs/PagedUserResponseLinks.md +19 -0
- data/docs/{ListSourceAccountResponseV2Page.md → PagedUserResponsePage.md} +2 -2
- data/docs/PasswordRequest.md +17 -0
- data/docs/PayeeInvitationStatus.md +1 -1
- data/docs/PaymentAuditServiceApi.md +85 -24
- data/docs/PaymentRails.md +16 -0
- data/docs/PaymentResponseV3.md +30 -24
- data/docs/PaymentResponseV4.md +47 -41
- data/docs/PaymentResponseV4Payout.md +3 -1
- data/docs/PayorAmlTransactionV3.md +71 -0
- data/docs/PayorAmlTransactionV4.md +71 -0
- data/docs/PayorV1.md +2 -2
- data/docs/PayorV2.md +8 -4
- data/docs/PayorsApi.md +113 -2
- data/docs/PayorsPrivateApi.md +60 -0
- data/docs/PayoutHistoryApi.md +5 -5
- data/docs/PayoutSummaryAuditV3.md +0 -2
- data/docs/PayoutSummaryAuditV4.md +5 -3
- data/docs/PayoutSummaryResponse.md +2 -0
- data/docs/Region.md +19 -0
- data/docs/RegisterMFARequest.md +17 -0
- data/docs/RegisterMFAResponse.md +19 -0
- data/docs/RegisterSmsRequest.md +17 -0
- data/docs/ResendTokenRequest.md +19 -0
- data/docs/ResetPasswordRequest.md +17 -0
- data/docs/Role.md +17 -0
- data/docs/SelfMFATypeUnregisterRequest.md +17 -0
- data/docs/SelfUpdatePasswordRequest.md +19 -0
- data/docs/SupportedCountriesResponse2.md +17 -0
- data/docs/SupportedCountry2.md +21 -0
- data/docs/TokenType.md +16 -0
- data/docs/TokensApi.md +560 -0
- data/docs/TransferRequest.md +21 -0
- data/docs/UnregisterMFARequest.md +19 -0
- data/docs/UserInfo.md +21 -0
- data/docs/UserResponse.md +43 -0
- data/docs/UserResponse2.md +45 -0
- data/docs/UserResponse2Roles.md +17 -0
- data/docs/UserStatus.md +16 -0
- data/docs/UserType.md +16 -0
- data/docs/UserType2.md +16 -0
- data/docs/UsersApi.md +806 -0
- data/docs/ValidateMFARequest.md +17 -0
- data/docs/ValidateOTPRequest.md +17 -0
- data/docs/ValidatePasswordResponse.md +23 -0
- data/docs/WithdrawPayoutApi.md +5 -5
- data/lib/velopayments/api/countries_api.rb +61 -5
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/{auth_api.rb → default_api.rb} +23 -22
- data/lib/velopayments/api/funding_manager_api.rb +237 -22
- data/lib/velopayments/api/get_payout_api.rb +8 -8
- data/lib/velopayments/api/instruct_payout_api.rb +8 -8
- data/lib/velopayments/api/login_api.rb +265 -0
- data/lib/velopayments/api/payee_invitation_api.rb +2 -2
- data/lib/velopayments/api/payees_api.rb +2 -2
- data/lib/velopayments/api/payment_audit_service_api.rb +100 -36
- data/lib/velopayments/api/payors_api.rb +152 -2
- data/lib/velopayments/api/payors_private_api.rb +86 -0
- data/lib/velopayments/api/payout_history_api.rb +7 -7
- data/lib/velopayments/api/quote_payout_api.rb +2 -2
- data/lib/velopayments/api/submit_payout_api.rb +2 -2
- data/lib/velopayments/api/tokens_api.rb +785 -0
- data/lib/velopayments/api/users_api.rb +997 -0
- data/lib/velopayments/api/withdraw_payout_api.rb +8 -8
- data/lib/velopayments/api_client.rb +2 -2
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -2
- data/lib/velopayments/models/accepted_payment.rb +304 -0
- data/lib/velopayments/models/access_token_response.rb +270 -0
- data/lib/velopayments/models/access_token_validation_request.rb +240 -0
- data/lib/velopayments/models/auth_response.rb +13 -3
- data/lib/velopayments/models/auto_top_up_config.rb +15 -3
- data/lib/velopayments/models/challenge.rb +13 -3
- data/lib/velopayments/models/check_token_response.rb +244 -0
- data/lib/velopayments/models/company_response.rb +14 -3
- data/lib/velopayments/models/company_v1.rb +15 -3
- data/lib/velopayments/models/create_funding_account_request.rb +337 -0
- data/lib/velopayments/models/create_individual.rb +13 -3
- data/lib/velopayments/models/create_individual2.rb +13 -3
- data/lib/velopayments/models/create_payee.rb +15 -3
- data/lib/velopayments/models/create_payee2.rb +15 -3
- data/lib/velopayments/models/create_payee_address.rb +18 -3
- data/lib/velopayments/models/create_payee_address2.rb +18 -3
- data/lib/velopayments/models/create_payees_csv_request.rb +13 -3
- data/lib/velopayments/models/create_payees_csv_request2.rb +13 -3
- data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
- data/lib/velopayments/models/create_payees_csv_response2.rb +13 -3
- data/lib/velopayments/models/create_payees_request.rb +13 -3
- data/lib/velopayments/models/create_payees_request2.rb +13 -3
- data/lib/velopayments/models/create_payment_channel.rb +13 -3
- data/lib/velopayments/models/create_payment_channel2.rb +13 -3
- data/lib/velopayments/models/create_payor_link_request.rb +273 -0
- data/lib/velopayments/models/create_payout_request.rb +13 -3
- data/lib/velopayments/models/{get_payouts_response_v3_summary.rb → currency_type.rb} +55 -48
- data/lib/velopayments/models/email_update_request.rb +246 -0
- data/lib/velopayments/models/error.rb +13 -3
- data/lib/velopayments/models/error_response.rb +15 -3
- data/lib/velopayments/models/failed_submission.rb +13 -3
- data/lib/velopayments/models/funding_account_response.rb +254 -0
- data/lib/velopayments/models/funding_audit.rb +25 -3
- data/lib/velopayments/models/funding_event.rb +13 -3
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +233 -0
- data/lib/velopayments/models/funding_request_v1.rb +13 -3
- data/lib/velopayments/models/funding_request_v2.rb +13 -3
- data/lib/velopayments/models/fx_summary_v3.rb +13 -3
- data/lib/velopayments/models/fx_summary_v4.rb +13 -3
- data/lib/velopayments/models/generate_otp_request.rb +211 -0
- data/lib/velopayments/models/get_fundings_response.rb +13 -3
- data/lib/velopayments/models/get_fundings_response_all_of.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +24 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +83 -64
- data/lib/velopayments/models/get_payout_statistics.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3.rb +14 -13
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v4.rb +14 -13
- data/lib/velopayments/models/individual_response.rb +13 -3
- data/lib/velopayments/models/individual_v1.rb +13 -3
- data/lib/velopayments/models/individual_v1_name.rb +13 -3
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status_response.rb +13 -3
- data/lib/velopayments/models/invite_payee_request.rb +13 -3
- data/lib/velopayments/models/invite_user_request.rb +490 -0
- data/lib/velopayments/models/kyc_state.rb +37 -0
- data/lib/velopayments/models/language.rb +2 -2
- data/lib/velopayments/models/{funding_delta_response_links.rb → link_for_response.rb} +16 -6
- data/lib/velopayments/models/{list_payments_response_summary.rb → list_funding_accounts_response.rb} +40 -43
- data/lib/velopayments/models/list_payments_response.rb +14 -13
- data/lib/velopayments/models/list_payments_response_page.rb +13 -3
- data/lib/velopayments/models/list_payments_response_v4.rb +229 -0
- data/lib/velopayments/models/list_source_account_response.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_v2.rb +14 -4
- data/lib/velopayments/models/marketing_opt_in.rb +13 -3
- data/lib/velopayments/models/mfa_details.rb +216 -0
- data/lib/velopayments/models/mfa_status.rb +36 -0
- data/lib/velopayments/models/mfa_type.rb +37 -0
- data/lib/velopayments/models/notifications.rb +13 -3
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/otp_type.rb +35 -0
- data/lib/velopayments/models/{list_source_account_response_v2_page.rb → page_for_response.rb} +16 -6
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +228 -0
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +13 -3
- data/lib/velopayments/models/paged_payee_response.rb +13 -3
- data/lib/velopayments/models/paged_payee_response2.rb +13 -3
- data/lib/velopayments/models/paged_payee_response2_summary.rb +13 -3
- data/lib/velopayments/models/paged_payee_response_links.rb +13 -3
- data/lib/velopayments/models/paged_payee_response_page.rb +13 -3
- data/lib/velopayments/models/paged_payee_response_summary.rb +13 -3
- data/lib/velopayments/models/paged_response.rb +13 -3
- data/lib/velopayments/models/paged_response_page.rb +13 -3
- data/lib/velopayments/models/{funding_delta_response.rb → paged_user_response.rb} +20 -10
- data/lib/velopayments/models/paged_user_response_links.rb +215 -0
- data/lib/velopayments/models/paged_user_response_page.rb +242 -0
- data/lib/velopayments/models/password_request.rb +240 -0
- data/lib/velopayments/models/payee.rb +19 -3
- data/lib/velopayments/models/payee_address.rb +18 -3
- data/lib/velopayments/models/payee_delta.rb +14 -3
- data/lib/velopayments/models/payee_delta_response.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
- data/lib/velopayments/models/payee_payment_channel.rb +13 -3
- data/lib/velopayments/models/payee_payor_ref.rb +13 -3
- data/lib/velopayments/models/payee_payor_ref2.rb +13 -3
- data/lib/velopayments/models/payee_response.rb +19 -3
- data/lib/velopayments/models/payee_response2.rb +19 -3
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +13 -3
- data/lib/velopayments/models/payment_channel_rule.rb +13 -3
- data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
- data/lib/velopayments/models/payment_delta.rb +19 -3
- data/lib/velopayments/models/payment_delta_response.rb +13 -3
- data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
- data/lib/velopayments/models/payment_instruction.rb +13 -3
- data/lib/velopayments/models/payment_rails.rb +36 -0
- data/lib/velopayments/models/payment_response_v3.rb +69 -7
- data/lib/velopayments/models/payment_response_v4.rb +66 -5
- data/lib/velopayments/models/payment_response_v4_payout.rb +23 -4
- data/lib/velopayments/models/payment_status.rb +2 -2
- data/lib/velopayments/models/payor_address.rb +18 -3
- data/lib/velopayments/models/payor_address_v2.rb +18 -3
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +454 -0
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +454 -0
- data/lib/velopayments/models/payor_branding_response.rb +16 -3
- data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
- data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
- data/lib/velopayments/models/payor_create_application_request.rb +14 -3
- data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
- data/lib/velopayments/models/payor_links_response.rb +13 -3
- data/lib/velopayments/models/payor_links_response_links.rb +13 -3
- data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
- data/lib/velopayments/models/payor_logo_request.rb +13 -3
- data/lib/velopayments/models/payor_v1.rb +14 -17
- data/lib/velopayments/models/payor_v2.rb +41 -21
- data/lib/velopayments/models/payout_payor_v4.rb +13 -3
- data/lib/velopayments/models/payout_principal_v4.rb +13 -3
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/payout_status_v4.rb +2 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +14 -13
- data/lib/velopayments/models/payout_summary_audit_v4.rb +31 -13
- data/lib/velopayments/models/payout_summary_response.rb +30 -4
- data/lib/velopayments/models/payout_type_v4.rb +2 -2
- data/lib/velopayments/models/query_batch_response.rb +13 -3
- data/lib/velopayments/models/quote_fx_summary.rb +13 -3
- data/lib/velopayments/models/quote_response.rb +13 -3
- data/lib/velopayments/models/region.rb +215 -0
- data/lib/velopayments/models/register_mfa_request.rb +211 -0
- data/lib/velopayments/models/register_mfa_response.rb +217 -0
- data/lib/velopayments/models/register_sms_request.rb +233 -0
- data/lib/velopayments/models/rejected_payment.rb +13 -3
- data/lib/velopayments/models/resend_token_request.rb +280 -0
- data/lib/velopayments/models/reset_password_request.rb +212 -0
- data/lib/velopayments/models/role.rb +212 -0
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +246 -0
- data/lib/velopayments/models/self_update_password_request.rb +283 -0
- data/lib/velopayments/models/set_notifications_request.rb +13 -3
- data/lib/velopayments/models/source_account.rb +13 -3
- data/lib/velopayments/models/source_account_response.rb +15 -3
- data/lib/velopayments/models/source_account_response_v2.rb +15 -3
- data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
- data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
- data/lib/velopayments/models/supported_countries_response.rb +13 -3
- data/lib/velopayments/models/supported_countries_response2.rb +208 -0
- data/lib/velopayments/models/supported_country.rb +13 -3
- data/lib/velopayments/models/supported_country2.rb +260 -0
- data/lib/velopayments/models/supported_currency.rb +13 -3
- data/lib/velopayments/models/supported_currency_response.rb +13 -3
- data/lib/velopayments/models/token_type.rb +38 -0
- data/lib/velopayments/models/{funding_delta.rb → transfer_request.rb} +68 -57
- data/lib/velopayments/models/unregister_mfa_request.rb +280 -0
- data/lib/velopayments/models/update_remote_id_request.rb +13 -3
- data/lib/velopayments/models/user_info.rb +225 -0
- data/lib/velopayments/models/user_response.rb +495 -0
- data/lib/velopayments/models/user_response2.rb +505 -0
- data/lib/velopayments/models/user_response2_roles.rb +206 -0
- data/lib/velopayments/models/user_status.rb +37 -0
- data/lib/velopayments/models/user_type.rb +37 -0
- data/lib/velopayments/models/user_type2.rb +37 -0
- data/lib/velopayments/models/validate_mfa_request.rb +240 -0
- data/lib/velopayments/models/validate_otp_request.rb +240 -0
- data/lib/velopayments/models/validate_password_response.rb +262 -0
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/version.rb +3 -3
- data/lib/velopayments.rb +60 -10
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +14 -3
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/{auth_api_spec.rb → default_api_spec.rb} +14 -14
- data/spec/api/funding_manager_api_spec.rb +54 -11
- data/spec/api/get_payout_api_spec.rb +4 -4
- data/spec/api/instruct_payout_api_spec.rb +4 -4
- data/spec/api/login_api_spec.rb +82 -0
- data/spec/api/payee_invitation_api_spec.rb +2 -2
- data/spec/api/payees_api_spec.rb +2 -2
- data/spec/api/payment_audit_service_api_spec.rb +27 -12
- data/spec/api/payors_api_spec.rb +29 -2
- data/spec/api/payors_private_api_spec.rb +47 -0
- data/spec/api/payout_history_api_spec.rb +4 -4
- data/spec/api/quote_payout_api_spec.rb +2 -2
- data/spec/api/submit_payout_api_spec.rb +2 -2
- data/spec/api/tokens_api_spec.rb +177 -0
- data/spec/api/users_api_spec.rb +222 -0
- data/spec/api/withdraw_payout_api_spec.rb +4 -4
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_spec.rb +71 -0
- data/spec/models/access_token_response_spec.rb +77 -0
- data/spec/models/access_token_validation_request_spec.rb +41 -0
- data/spec/models/auth_response_spec.rb +2 -2
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/{list_payments_response_summary_spec.rb → check_token_response_spec.rb} +13 -13
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_spec.rb +59 -0
- 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_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 +57 -0
- data/spec/models/create_payout_request_spec.rb +2 -2
- data/spec/models/currency_type_spec.rb +41 -0
- data/spec/models/email_update_request_spec.rb +47 -0
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response_spec.rb +71 -0
- data/spec/models/funding_audit_spec.rb +6 -2
- data/spec/models/funding_event_spec.rb +2 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/{funding_delta_spec.rb → funding_payor_status_audit_response_spec.rb} +12 -12
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/generate_otp_request_spec.rb +41 -0
- data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
- data/spec/models/get_fundings_response_spec.rb +2 -2
- 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 +8 -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 +22 -16
- 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 -8
- data/spec/models/get_payouts_response_v4_spec.rb +2 -8
- data/spec/models/individual_response_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/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/invite_user_request_spec.rb +99 -0
- data/spec/models/kyc_state_spec.rb +35 -0
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/{funding_delta_response_links_spec.rb → link_for_response_spec.rb} +8 -8
- data/spec/models/list_funding_accounts_response_spec.rb +53 -0
- data/spec/models/list_payments_response_page_spec.rb +2 -2
- data/spec/models/list_payments_response_spec.rb +2 -8
- data/spec/models/list_payments_response_v4_spec.rb +53 -0
- 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_spec.rb +2 -2
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/mfa_details_spec.rb +47 -0
- data/spec/models/mfa_status_spec.rb +35 -0
- data/spec/models/mfa_type_spec.rb +35 -0
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/otp_type_spec.rb +35 -0
- data/spec/models/{list_source_account_response_v2_page_spec.rb → page_for_response_spec.rb} +8 -8
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +53 -0
- 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_response_page_spec.rb +2 -2
- data/spec/models/paged_response_spec.rb +2 -2
- data/spec/models/paged_user_response_links_spec.rb +47 -0
- data/spec/models/{get_payouts_response_v3_summary_spec.rb → paged_user_response_page_spec.rb} +13 -13
- data/spec/models/{funding_delta_response_spec.rb → paged_user_response_spec.rb} +8 -8
- data/spec/models/password_request_spec.rb +41 -0
- data/spec/models/payee_address_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_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel_spec.rb +2 -2
- data/spec/models/payee_payor_ref2_spec.rb +2 -2
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_response2_spec.rb +2 -2
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type_spec.rb +2 -2
- 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_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/payment_rails_spec.rb +35 -0
- data/spec/models/payment_response_v3_spec.rb +20 -2
- data/spec/models/payment_response_v4_payout_spec.rb +8 -2
- data/spec/models/payment_response_v4_spec.rb +20 -2
- data/spec/models/payment_status_spec.rb +2 -2
- 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 +203 -0
- data/spec/models/payor_aml_transaction_v4_spec.rb +203 -0
- 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 +2 -6
- data/spec/models/payor_v2_spec.rb +14 -6
- 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 -8
- data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
- data/spec/models/payout_summary_response_spec.rb +8 -2
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/quote_fx_summary_spec.rb +2 -2
- data/spec/models/quote_response_spec.rb +2 -2
- data/spec/models/region_spec.rb +47 -0
- data/spec/models/register_mfa_request_spec.rb +41 -0
- data/spec/models/register_mfa_response_spec.rb +47 -0
- data/spec/models/register_sms_request_spec.rb +41 -0
- data/spec/models/rejected_payment_spec.rb +2 -2
- data/spec/models/resend_token_request_spec.rb +51 -0
- data/spec/models/reset_password_request_spec.rb +41 -0
- data/spec/models/role_spec.rb +41 -0
- data/spec/models/self_mfa_type_unregister_request_spec.rb +45 -0
- data/spec/models/self_update_password_request_spec.rb +47 -0
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +2 -2
- data/spec/models/source_account_response_v2_spec.rb +2 -2
- data/spec/models/source_account_spec.rb +2 -2
- 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/supported_countries_response2_spec.rb +41 -0
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/supported_country2_spec.rb +61 -0
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/supported_currency_response_spec.rb +2 -2
- data/spec/models/supported_currency_spec.rb +2 -2
- data/spec/models/token_type_spec.rb +35 -0
- data/spec/models/transfer_request_spec.rb +53 -0
- data/spec/models/unregister_mfa_request_spec.rb +51 -0
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/user_info_spec.rb +53 -0
- data/spec/models/user_response2_roles_spec.rb +41 -0
- data/spec/models/user_response2_spec.rb +137 -0
- data/spec/models/user_response_spec.rb +131 -0
- data/spec/models/user_status_spec.rb +35 -0
- data/spec/models/user_type2_spec.rb +35 -0
- data/spec/models/user_type_spec.rb +35 -0
- data/spec/models/validate_mfa_request_spec.rb +41 -0
- data/spec/models/validate_otp_request_spec.rb +41 -0
- data/spec/models/validate_password_response_spec.rb +59 -0
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/velopayments.gemspec +2 -2
- metadata +358 -159
- data/Jenkinsfile +0 -41
- data/docs/AuthApi.md +0 -64
- data/docs/FundingDelta.md +0 -23
- data/docs/FundingDeltaResponse.md +0 -21
- data/docs/FundingDeltaResponseLinks.md +0 -19
- data/docs/GetPayoutsResponseV3Summary.md +0 -25
- data/docs/ListPaymentsResponseSummary.md +0 -25
- data/docs/PayorApplicationsApi.md +0 -119
- data/lib/velopayments/api/payor_applications_api.rb +0 -166
- data/spec/api/payor_applications_api_spec.rb +0 -62
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -78,6 +78,12 @@ module VeloPayments
|
|
78
78
|
}
|
79
79
|
end
|
80
80
|
|
81
|
+
# List of attributes with nullable: true
|
82
|
+
def self.openapi_nullable
|
83
|
+
Set.new([
|
84
|
+
])
|
85
|
+
end
|
86
|
+
|
81
87
|
# Initializes the object
|
82
88
|
# @param [Hash] attributes Model attributes in the form of hash
|
83
89
|
def initialize(attributes = {})
|
@@ -403,7 +409,11 @@ module VeloPayments
|
|
403
409
|
hash = {}
|
404
410
|
self.class.attribute_map.each_pair do |attr, param|
|
405
411
|
value = self.send(attr)
|
406
|
-
|
412
|
+
if value.nil?
|
413
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
414
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
415
|
+
end
|
416
|
+
|
407
417
|
hash[param] = _to_hash(value)
|
408
418
|
end
|
409
419
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -38,6 +38,12 @@ module VeloPayments
|
|
38
38
|
}
|
39
39
|
end
|
40
40
|
|
41
|
+
# List of attributes with nullable: true
|
42
|
+
def self.openapi_nullable
|
43
|
+
Set.new([
|
44
|
+
])
|
45
|
+
end
|
46
|
+
|
41
47
|
# Initializes the object
|
42
48
|
# @param [Hash] attributes Model attributes in the form of hash
|
43
49
|
def initialize(attributes = {})
|
@@ -187,7 +193,11 @@ module VeloPayments
|
|
187
193
|
hash = {}
|
188
194
|
self.class.attribute_map.each_pair do |attr, param|
|
189
195
|
value = self.send(attr)
|
190
|
-
|
196
|
+
if value.nil?
|
197
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
198
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
199
|
+
end
|
200
|
+
|
191
201
|
hash[param] = _to_hash(value)
|
192
202
|
end
|
193
203
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -38,6 +38,12 @@ module VeloPayments
|
|
38
38
|
}
|
39
39
|
end
|
40
40
|
|
41
|
+
# List of attributes with nullable: true
|
42
|
+
def self.openapi_nullable
|
43
|
+
Set.new([
|
44
|
+
])
|
45
|
+
end
|
46
|
+
|
41
47
|
# Initializes the object
|
42
48
|
# @param [Hash] attributes Model attributes in the form of hash
|
43
49
|
def initialize(attributes = {})
|
@@ -187,7 +193,11 @@ module VeloPayments
|
|
187
193
|
hash = {}
|
188
194
|
self.class.attribute_map.each_pair do |attr, param|
|
189
195
|
value = self.send(attr)
|
190
|
-
|
196
|
+
if value.nil?
|
197
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
198
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
199
|
+
end
|
200
|
+
|
191
201
|
hash[param] = _to_hash(value)
|
192
202
|
end
|
193
203
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -107,6 +107,18 @@ module VeloPayments
|
|
107
107
|
}
|
108
108
|
end
|
109
109
|
|
110
|
+
# List of attributes with nullable: true
|
111
|
+
def self.openapi_nullable
|
112
|
+
Set.new([
|
113
|
+
:'payor_refs',
|
114
|
+
:'email',
|
115
|
+
:'accept_terms_and_conditions_timestamp',
|
116
|
+
:'company',
|
117
|
+
:'grace_period_end_date',
|
118
|
+
:'last_ofac_check_timestamp',
|
119
|
+
])
|
120
|
+
end
|
121
|
+
|
110
122
|
# Initializes the object
|
111
123
|
# @param [Hash] attributes Model attributes in the form of hash
|
112
124
|
def initialize(attributes = {})
|
@@ -345,7 +357,11 @@ module VeloPayments
|
|
345
357
|
hash = {}
|
346
358
|
self.class.attribute_map.each_pair do |attr, param|
|
347
359
|
value = self.send(attr)
|
348
|
-
|
360
|
+
if value.nil?
|
361
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
362
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
363
|
+
end
|
364
|
+
|
349
365
|
hash[param] = _to_hash(value)
|
350
366
|
end
|
351
367
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -107,6 +107,18 @@ module VeloPayments
|
|
107
107
|
}
|
108
108
|
end
|
109
109
|
|
110
|
+
# List of attributes with nullable: true
|
111
|
+
def self.openapi_nullable
|
112
|
+
Set.new([
|
113
|
+
:'payor_refs',
|
114
|
+
:'email',
|
115
|
+
:'accept_terms_and_conditions_timestamp',
|
116
|
+
:'company',
|
117
|
+
:'grace_period_end_date',
|
118
|
+
:'watchlist_status_updated_timestamp',
|
119
|
+
])
|
120
|
+
end
|
121
|
+
|
110
122
|
# Initializes the object
|
111
123
|
# @param [Hash] attributes Model attributes in the form of hash
|
112
124
|
def initialize(attributes = {})
|
@@ -345,7 +357,11 @@ module VeloPayments
|
|
345
357
|
hash = {}
|
346
358
|
self.class.attribute_map.each_pair do |attr, param|
|
347
359
|
value = self.send(attr)
|
348
|
-
|
360
|
+
if value.nil?
|
361
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
362
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
363
|
+
end
|
364
|
+
|
349
365
|
hash[param] = _to_hash(value)
|
350
366
|
end
|
351
367
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -34,6 +34,12 @@ module VeloPayments
|
|
34
34
|
}
|
35
35
|
end
|
36
36
|
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
37
43
|
# Initializes the object
|
38
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
39
45
|
def initialize(attributes = {})
|
@@ -180,7 +186,11 @@ module VeloPayments
|
|
180
186
|
hash = {}
|
181
187
|
self.class.attribute_map.each_pair do |attr, param|
|
182
188
|
value = self.send(attr)
|
183
|
-
|
189
|
+
if value.nil?
|
190
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
191
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
192
|
+
end
|
193
|
+
|
184
194
|
hash[param] = _to_hash(value)
|
185
195
|
end
|
186
196
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -54,6 +54,12 @@ module VeloPayments
|
|
54
54
|
}
|
55
55
|
end
|
56
56
|
|
57
|
+
# List of attributes with nullable: true
|
58
|
+
def self.openapi_nullable
|
59
|
+
Set.new([
|
60
|
+
])
|
61
|
+
end
|
62
|
+
|
57
63
|
# Initializes the object
|
58
64
|
# @param [Hash] attributes Model attributes in the form of hash
|
59
65
|
def initialize(attributes = {})
|
@@ -223,7 +229,11 @@ module VeloPayments
|
|
223
229
|
hash = {}
|
224
230
|
self.class.attribute_map.each_pair do |attr, param|
|
225
231
|
value = self.send(attr)
|
226
|
-
|
232
|
+
if value.nil?
|
233
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
234
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
235
|
+
end
|
236
|
+
|
227
237
|
hash[param] = _to_hash(value)
|
228
238
|
end
|
229
239
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -30,6 +30,12 @@ module VeloPayments
|
|
30
30
|
}
|
31
31
|
end
|
32
32
|
|
33
|
+
# List of attributes with nullable: true
|
34
|
+
def self.openapi_nullable
|
35
|
+
Set.new([
|
36
|
+
])
|
37
|
+
end
|
38
|
+
|
33
39
|
# Initializes the object
|
34
40
|
# @param [Hash] attributes Model attributes in the form of hash
|
35
41
|
def initialize(attributes = {})
|
@@ -171,7 +177,11 @@ module VeloPayments
|
|
171
177
|
hash = {}
|
172
178
|
self.class.attribute_map.each_pair do |attr, param|
|
173
179
|
value = self.send(attr)
|
174
|
-
|
180
|
+
if value.nil?
|
181
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
182
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
183
|
+
end
|
184
|
+
|
175
185
|
hash[param] = _to_hash(value)
|
176
186
|
end
|
177
187
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -58,6 +58,18 @@ module VeloPayments
|
|
58
58
|
}
|
59
59
|
end
|
60
60
|
|
61
|
+
# List of attributes with nullable: true
|
62
|
+
def self.openapi_nullable
|
63
|
+
Set.new([
|
64
|
+
:'payor_payment_id',
|
65
|
+
:'payment_currency',
|
66
|
+
:'payment_amount',
|
67
|
+
:'status',
|
68
|
+
:'source_currency',
|
69
|
+
:'source_amount'
|
70
|
+
])
|
71
|
+
end
|
72
|
+
|
61
73
|
# Initializes the object
|
62
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
63
75
|
def initialize(attributes = {})
|
@@ -242,7 +254,11 @@ module VeloPayments
|
|
242
254
|
hash = {}
|
243
255
|
self.class.attribute_map.each_pair do |attr, param|
|
244
256
|
value = self.send(attr)
|
245
|
-
|
257
|
+
if value.nil?
|
258
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
259
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
260
|
+
end
|
261
|
+
|
246
262
|
hash[param] = _to_hash(value)
|
247
263
|
end
|
248
264
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -39,6 +39,12 @@ module VeloPayments
|
|
39
39
|
}
|
40
40
|
end
|
41
41
|
|
42
|
+
# List of attributes with nullable: true
|
43
|
+
def self.openapi_nullable
|
44
|
+
Set.new([
|
45
|
+
])
|
46
|
+
end
|
47
|
+
|
42
48
|
# Initializes the object
|
43
49
|
# @param [Hash] attributes Model attributes in the form of hash
|
44
50
|
def initialize(attributes = {})
|
@@ -192,7 +198,11 @@ module VeloPayments
|
|
192
198
|
hash = {}
|
193
199
|
self.class.attribute_map.each_pair do |attr, param|
|
194
200
|
value = self.send(attr)
|
195
|
-
|
201
|
+
if value.nil?
|
202
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
203
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
204
|
+
end
|
205
|
+
|
196
206
|
hash[param] = _to_hash(value)
|
197
207
|
end
|
198
208
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.18.31
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -103,6 +103,12 @@ module VeloPayments
|
|
103
103
|
}
|
104
104
|
end
|
105
105
|
|
106
|
+
# List of attributes with nullable: true
|
107
|
+
def self.openapi_nullable
|
108
|
+
Set.new([
|
109
|
+
])
|
110
|
+
end
|
111
|
+
|
106
112
|
# Initializes the object
|
107
113
|
# @param [Hash] attributes Model attributes in the form of hash
|
108
114
|
def initialize(attributes = {})
|
@@ -324,7 +330,11 @@ module VeloPayments
|
|
324
330
|
hash = {}
|
325
331
|
self.class.attribute_map.each_pair do |attr, param|
|
326
332
|
value = self.send(attr)
|
327
|
-
|
333
|
+
if value.nil?
|
334
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
335
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
336
|
+
end
|
337
|
+
|
328
338
|
hash[param] = _to_hash(value)
|
329
339
|
end
|
330
340
|
hash
|