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
|
|
@@ -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 = {})
|
@@ -174,7 +180,11 @@ module VeloPayments
|
|
174
180
|
hash = {}
|
175
181
|
self.class.attribute_map.each_pair do |attr, param|
|
176
182
|
value = self.send(attr)
|
177
|
-
|
183
|
+
if value.nil?
|
184
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
185
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
186
|
+
end
|
187
|
+
|
178
188
|
hash[param] = _to_hash(value)
|
179
189
|
end
|
180
190
|
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
|
|
@@ -35,6 +35,12 @@ module VeloPayments
|
|
35
35
|
}
|
36
36
|
end
|
37
37
|
|
38
|
+
# List of attributes with nullable: true
|
39
|
+
def self.openapi_nullable
|
40
|
+
Set.new([
|
41
|
+
])
|
42
|
+
end
|
43
|
+
|
38
44
|
# Initializes the object
|
39
45
|
# @param [Hash] attributes Model attributes in the form of hash
|
40
46
|
def initialize(attributes = {})
|
@@ -183,7 +189,11 @@ module VeloPayments
|
|
183
189
|
hash = {}
|
184
190
|
self.class.attribute_map.each_pair do |attr, param|
|
185
191
|
value = self.send(attr)
|
186
|
-
|
192
|
+
if value.nil?
|
193
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
194
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
195
|
+
end
|
196
|
+
|
187
197
|
hash[param] = _to_hash(value)
|
188
198
|
end
|
189
199
|
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
|
|
@@ -64,6 +64,12 @@ module VeloPayments
|
|
64
64
|
}
|
65
65
|
end
|
66
66
|
|
67
|
+
# List of attributes with nullable: true
|
68
|
+
def self.openapi_nullable
|
69
|
+
Set.new([
|
70
|
+
])
|
71
|
+
end
|
72
|
+
|
67
73
|
# Initializes the object
|
68
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
69
75
|
def initialize(attributes = {})
|
@@ -250,7 +256,11 @@ module VeloPayments
|
|
250
256
|
hash = {}
|
251
257
|
self.class.attribute_map.each_pair do |attr, param|
|
252
258
|
value = self.send(attr)
|
253
|
-
|
259
|
+
if value.nil?
|
260
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
261
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
262
|
+
end
|
263
|
+
|
254
264
|
hash[param] = _to_hash(value)
|
255
265
|
end
|
256
266
|
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
|
|
@@ -64,6 +64,12 @@ module VeloPayments
|
|
64
64
|
}
|
65
65
|
end
|
66
66
|
|
67
|
+
# List of attributes with nullable: true
|
68
|
+
def self.openapi_nullable
|
69
|
+
Set.new([
|
70
|
+
])
|
71
|
+
end
|
72
|
+
|
67
73
|
# Initializes the object
|
68
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
69
75
|
def initialize(attributes = {})
|
@@ -240,7 +246,11 @@ module VeloPayments
|
|
240
246
|
hash = {}
|
241
247
|
self.class.attribute_map.each_pair do |attr, param|
|
242
248
|
value = self.send(attr)
|
243
|
-
|
249
|
+
if value.nil?
|
250
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
251
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
252
|
+
end
|
253
|
+
|
244
254
|
hash[param] = _to_hash(value)
|
245
255
|
end
|
246
256
|
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 = {})
|
@@ -169,7 +175,11 @@ module VeloPayments
|
|
169
175
|
hash = {}
|
170
176
|
self.class.attribute_map.each_pair do |attr, param|
|
171
177
|
value = self.send(attr)
|
172
|
-
|
178
|
+
if value.nil?
|
179
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
180
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
181
|
+
end
|
182
|
+
|
173
183
|
hash[param] = _to_hash(value)
|
174
184
|
end
|
175
185
|
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,7 +39,6 @@ module VeloPayments
|
|
39
39
|
# The funding account name to be used for the payor.
|
40
40
|
attr_accessor :funding_account_account_name
|
41
41
|
|
42
|
-
# The kyc state of the payor.
|
43
42
|
attr_accessor :kyc_state
|
44
43
|
|
45
44
|
# Whether or not the payor has been manually locked by the backoffice.
|
@@ -134,7 +133,7 @@ module VeloPayments
|
|
134
133
|
:'funding_account_routing_number' => :'String',
|
135
134
|
:'funding_account_account_number' => :'String',
|
136
135
|
:'funding_account_account_name' => :'String',
|
137
|
-
:'kyc_state' => :'
|
136
|
+
:'kyc_state' => :'KycState',
|
138
137
|
:'manual_lockout' => :'Boolean',
|
139
138
|
:'payee_grace_period_processing_enabled' => :'Boolean',
|
140
139
|
:'payee_grace_period_days' => :'Integer',
|
@@ -149,6 +148,12 @@ module VeloPayments
|
|
149
148
|
}
|
150
149
|
end
|
151
150
|
|
151
|
+
# List of attributes with nullable: true
|
152
|
+
def self.openapi_nullable
|
153
|
+
Set.new([
|
154
|
+
])
|
155
|
+
end
|
156
|
+
|
152
157
|
# Initializes the object
|
153
158
|
# @param [Hash] attributes Model attributes in the form of hash
|
154
159
|
def initialize(attributes = {})
|
@@ -264,23 +269,11 @@ module VeloPayments
|
|
264
269
|
# @return true if the model is valid
|
265
270
|
def valid?
|
266
271
|
return false if @payor_name.nil?
|
267
|
-
kyc_state_validator = EnumAttributeValidator.new('String', ["FAILED_KYC", "PASSED_KYC", "REQUIRES_KYC"])
|
268
|
-
return false unless kyc_state_validator.valid?(@kyc_state)
|
269
272
|
language_validator = EnumAttributeValidator.new('String', ["EN", "FR"])
|
270
273
|
return false unless language_validator.valid?(@language)
|
271
274
|
true
|
272
275
|
end
|
273
276
|
|
274
|
-
# Custom attribute writer method checking allowed values (enum).
|
275
|
-
# @param [Object] kyc_state Object to be assigned
|
276
|
-
def kyc_state=(kyc_state)
|
277
|
-
validator = EnumAttributeValidator.new('String', ["FAILED_KYC", "PASSED_KYC", "REQUIRES_KYC"])
|
278
|
-
unless validator.valid?(kyc_state)
|
279
|
-
fail ArgumentError, "invalid value for \"kyc_state\", must be one of #{validator.allowable_values}."
|
280
|
-
end
|
281
|
-
@kyc_state = kyc_state
|
282
|
-
end
|
283
|
-
|
284
277
|
# Custom attribute writer method checking allowed values (enum).
|
285
278
|
# @param [Object] language Object to be assigned
|
286
279
|
def language=(language)
|
@@ -417,7 +410,11 @@ module VeloPayments
|
|
417
410
|
hash = {}
|
418
411
|
self.class.attribute_map.each_pair do |attr, param|
|
419
412
|
value = self.send(attr)
|
420
|
-
|
413
|
+
if value.nil?
|
414
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
415
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
416
|
+
end
|
417
|
+
|
421
418
|
hash[param] = _to_hash(value)
|
422
419
|
end
|
423
420
|
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,7 +30,6 @@ module VeloPayments
|
|
30
30
|
# Primary contact email for the payor.
|
31
31
|
attr_accessor :primary_contact_email
|
32
32
|
|
33
|
-
# The kyc state of the payor.
|
34
33
|
attr_accessor :kyc_state
|
35
34
|
|
36
35
|
# Whether or not the payor has been manually locked by the backoffice.
|
@@ -62,8 +61,12 @@ module VeloPayments
|
|
62
61
|
|
63
62
|
attr_accessor :includes_reports
|
64
63
|
|
64
|
+
attr_accessor :wu_customer_id
|
65
|
+
|
65
66
|
attr_accessor :max_master_payor_admins
|
66
67
|
|
68
|
+
attr_accessor :payment_rails
|
69
|
+
|
67
70
|
class EnumAttributeValidator
|
68
71
|
attr_reader :datatype
|
69
72
|
attr_reader :allowable_values
|
@@ -106,7 +109,9 @@ module VeloPayments
|
|
106
109
|
:'reminder_emails_opt_out' => :'reminderEmailsOptOut',
|
107
110
|
:'language' => :'language',
|
108
111
|
:'includes_reports' => :'includesReports',
|
109
|
-
:'
|
112
|
+
:'wu_customer_id' => :'wuCustomerId',
|
113
|
+
:'max_master_payor_admins' => :'maxMasterPayorAdmins',
|
114
|
+
:'payment_rails' => :'paymentRails'
|
110
115
|
}
|
111
116
|
end
|
112
117
|
|
@@ -119,7 +124,7 @@ module VeloPayments
|
|
119
124
|
:'primary_contact_name' => :'String',
|
120
125
|
:'primary_contact_phone' => :'String',
|
121
126
|
:'primary_contact_email' => :'String',
|
122
|
-
:'kyc_state' => :'
|
127
|
+
:'kyc_state' => :'KycState',
|
123
128
|
:'manual_lockout' => :'Boolean',
|
124
129
|
:'payee_grace_period_processing_enabled' => :'Boolean',
|
125
130
|
:'payee_grace_period_days' => :'Integer',
|
@@ -130,10 +135,18 @@ module VeloPayments
|
|
130
135
|
:'reminder_emails_opt_out' => :'Boolean',
|
131
136
|
:'language' => :'String',
|
132
137
|
:'includes_reports' => :'Boolean',
|
133
|
-
:'
|
138
|
+
:'wu_customer_id' => :'String',
|
139
|
+
:'max_master_payor_admins' => :'Integer',
|
140
|
+
:'payment_rails' => :'PaymentRails'
|
134
141
|
}
|
135
142
|
end
|
136
143
|
|
144
|
+
# List of attributes with nullable: true
|
145
|
+
def self.openapi_nullable
|
146
|
+
Set.new([
|
147
|
+
])
|
148
|
+
end
|
149
|
+
|
137
150
|
# Initializes the object
|
138
151
|
# @param [Hash] attributes Model attributes in the form of hash
|
139
152
|
def initialize(attributes = {})
|
@@ -217,15 +230,27 @@ module VeloPayments
|
|
217
230
|
self.includes_reports = attributes[:'includes_reports']
|
218
231
|
end
|
219
232
|
|
233
|
+
if attributes.key?(:'wu_customer_id')
|
234
|
+
self.wu_customer_id = attributes[:'wu_customer_id']
|
235
|
+
end
|
236
|
+
|
220
237
|
if attributes.key?(:'max_master_payor_admins')
|
221
238
|
self.max_master_payor_admins = attributes[:'max_master_payor_admins']
|
222
239
|
end
|
240
|
+
|
241
|
+
if attributes.key?(:'payment_rails')
|
242
|
+
self.payment_rails = attributes[:'payment_rails']
|
243
|
+
end
|
223
244
|
end
|
224
245
|
|
225
246
|
# Show invalid properties with the reasons. Usually used together with valid?
|
226
247
|
# @return Array for valid properties with the reasons
|
227
248
|
def list_invalid_properties
|
228
249
|
invalid_properties = Array.new
|
250
|
+
if @payor_id.nil?
|
251
|
+
invalid_properties.push('invalid value for "payor_id", payor_id cannot be nil.')
|
252
|
+
end
|
253
|
+
|
229
254
|
if @payor_name.nil?
|
230
255
|
invalid_properties.push('invalid value for "payor_name", payor_name cannot be nil.')
|
231
256
|
end
|
@@ -236,24 +261,13 @@ module VeloPayments
|
|
236
261
|
# Check to see if the all the properties in the model are valid
|
237
262
|
# @return true if the model is valid
|
238
263
|
def valid?
|
264
|
+
return false if @payor_id.nil?
|
239
265
|
return false if @payor_name.nil?
|
240
|
-
kyc_state_validator = EnumAttributeValidator.new('String', ["FAILED_KYC", "PASSED_KYC", "REQUIRES_KYC"])
|
241
|
-
return false unless kyc_state_validator.valid?(@kyc_state)
|
242
266
|
language_validator = EnumAttributeValidator.new('String', ["EN", "FR"])
|
243
267
|
return false unless language_validator.valid?(@language)
|
244
268
|
true
|
245
269
|
end
|
246
270
|
|
247
|
-
# Custom attribute writer method checking allowed values (enum).
|
248
|
-
# @param [Object] kyc_state Object to be assigned
|
249
|
-
def kyc_state=(kyc_state)
|
250
|
-
validator = EnumAttributeValidator.new('String', ["FAILED_KYC", "PASSED_KYC", "REQUIRES_KYC"])
|
251
|
-
unless validator.valid?(kyc_state)
|
252
|
-
fail ArgumentError, "invalid value for \"kyc_state\", must be one of #{validator.allowable_values}."
|
253
|
-
end
|
254
|
-
@kyc_state = kyc_state
|
255
|
-
end
|
256
|
-
|
257
271
|
# Custom attribute writer method checking allowed values (enum).
|
258
272
|
# @param [Object] language Object to be assigned
|
259
273
|
def language=(language)
|
@@ -286,7 +300,9 @@ module VeloPayments
|
|
286
300
|
reminder_emails_opt_out == o.reminder_emails_opt_out &&
|
287
301
|
language == o.language &&
|
288
302
|
includes_reports == o.includes_reports &&
|
289
|
-
|
303
|
+
wu_customer_id == o.wu_customer_id &&
|
304
|
+
max_master_payor_admins == o.max_master_payor_admins &&
|
305
|
+
payment_rails == o.payment_rails
|
290
306
|
end
|
291
307
|
|
292
308
|
# @see the `==` method
|
@@ -298,7 +314,7 @@ module VeloPayments
|
|
298
314
|
# Calculates hash code according to all attributes.
|
299
315
|
# @return [Integer] Hash code
|
300
316
|
def hash
|
301
|
-
[payor_id, payor_name, address, primary_contact_name, primary_contact_phone, primary_contact_email, kyc_state, manual_lockout, payee_grace_period_processing_enabled, payee_grace_period_days, collective_alias, support_contact, dba_name, allows_language_choice, reminder_emails_opt_out, language, includes_reports, max_master_payor_admins].hash
|
317
|
+
[payor_id, payor_name, address, primary_contact_name, primary_contact_phone, primary_contact_email, kyc_state, manual_lockout, payee_grace_period_processing_enabled, payee_grace_period_days, collective_alias, support_contact, dba_name, allows_language_choice, reminder_emails_opt_out, language, includes_reports, wu_customer_id, max_master_payor_admins, payment_rails].hash
|
302
318
|
end
|
303
319
|
|
304
320
|
# Builds the object from hash
|
@@ -387,7 +403,11 @@ module VeloPayments
|
|
387
403
|
hash = {}
|
388
404
|
self.class.attribute_map.each_pair do |attr, param|
|
389
405
|
value = self.send(attr)
|
390
|
-
|
406
|
+
if value.nil?
|
407
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
408
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
409
|
+
end
|
410
|
+
|
391
411
|
hash[param] = _to_hash(value)
|
392
412
|
end
|
393
413
|
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
|
|
@@ -52,6 +52,12 @@ module VeloPayments
|
|
52
52
|
}
|
53
53
|
end
|
54
54
|
|
55
|
+
# List of attributes with nullable: true
|
56
|
+
def self.openapi_nullable
|
57
|
+
Set.new([
|
58
|
+
])
|
59
|
+
end
|
60
|
+
|
55
61
|
# Initializes the object
|
56
62
|
# @param [Hash] attributes Model attributes in the form of hash
|
57
63
|
def initialize(attributes = {})
|
@@ -236,7 +242,11 @@ module VeloPayments
|
|
236
242
|
hash = {}
|
237
243
|
self.class.attribute_map.each_pair do |attr, param|
|
238
244
|
value = self.send(attr)
|
239
|
-
|
245
|
+
if value.nil?
|
246
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
247
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
248
|
+
end
|
249
|
+
|
240
250
|
hash[param] = _to_hash(value)
|
241
251
|
end
|
242
252
|
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
|
|
@@ -37,6 +37,12 @@ module VeloPayments
|
|
37
37
|
}
|
38
38
|
end
|
39
39
|
|
40
|
+
# List of attributes with nullable: true
|
41
|
+
def self.openapi_nullable
|
42
|
+
Set.new([
|
43
|
+
])
|
44
|
+
end
|
45
|
+
|
40
46
|
# Initializes the object
|
41
47
|
# @param [Hash] attributes Model attributes in the form of hash
|
42
48
|
def initialize(attributes = {})
|
@@ -191,7 +197,11 @@ module VeloPayments
|
|
191
197
|
hash = {}
|
192
198
|
self.class.attribute_map.each_pair do |attr, param|
|
193
199
|
value = self.send(attr)
|
194
|
-
|
200
|
+
if value.nil?
|
201
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
202
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
203
|
+
end
|
204
|
+
|
195
205
|
hash[param] = _to_hash(value)
|
196
206
|
end
|
197
207
|
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
|
|