velopayments 2.18.113 → 2.19.40.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/README.md +62 -48
- data/docs/Challenge.md +2 -2
- data/docs/Company.md +21 -0
- data/docs/Company2.md +21 -0
- data/docs/CompanyResponse.md +2 -2
- data/docs/CompanyV1.md +3 -3
- data/docs/CountriesApi.md +3 -13
- data/docs/CreateIndividual.md +2 -2
- data/docs/CreateIndividual2.md +3 -3
- data/docs/CreateIndividual2Name.md +23 -0
- data/docs/CreatePayee.md +4 -4
- data/docs/CreatePayee2.md +4 -4
- data/docs/CreatePayeesCSVRequest.md +22 -22
- data/docs/CreatePayeesCSVRequest2.md +23 -23
- data/docs/CreatePayeesCSVResponse.md +2 -2
- data/docs/CreatePayeesCSVResponse2.md +2 -2
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
- data/docs/CreatePayeesRequest.md +1 -1
- data/docs/CreatePayeesRequest2.md +1 -1
- data/docs/CreatePaymentChannel.md +6 -6
- data/docs/CreatePaymentChannel2.md +6 -6
- data/docs/CreatePayoutRequest.md +3 -3
- data/docs/CurrenciesApi.md +1 -6
- data/docs/FailedSubmission.md +2 -2
- data/docs/FailedSubmission2.md +19 -0
- data/docs/FundingManagerApi.md +8 -4
- data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +4 -4
- data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
- data/docs/GetPayoutApi.md +5 -5
- data/docs/GetPayoutsResponseV4.md +1 -1
- data/docs/Individual.md +21 -0
- data/docs/Individual2.md +21 -0
- data/docs/IndividualV1.md +2 -2
- data/docs/IndividualV1Name.md +4 -4
- data/docs/InlineResponse400.md +19 -0
- data/docs/InlineResponse400Errors.md +23 -0
- data/docs/InlineResponse401.md +19 -0
- data/docs/InlineResponse401Errors.md +23 -0
- data/docs/InlineResponse403.md +19 -0
- data/docs/InlineResponse403Errors.md +23 -0
- data/docs/InstructPayoutApi.md +6 -6
- data/docs/InvitePayeeRequest.md +1 -1
- data/docs/{GenerateOTPRequest.md → InvitePayeeRequest2.md} +3 -3
- data/docs/InviteUserRequest.md +2 -2
- data/docs/{MFAStatus.md → Language2.md} +2 -2
- data/docs/{TokenType.md → LocationType.md} +2 -2
- data/docs/MarketingOptIn.md +1 -1
- data/docs/{OTPType.md → OfacStatus2.md} +2 -2
- data/docs/{PaymentStatus.md → OnboardedStatus2.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
- data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
- data/docs/PagedPayeeInvitationStatusResponsePage.md +25 -0
- data/docs/PagedPayeeResponse2Summary.md +5 -5
- data/docs/PagedPayeeResponsePage.md +5 -5
- data/docs/PagedPayeeResponseSummary.md +5 -5
- data/docs/Payee.md +9 -9
- data/docs/Payee2.md +57 -0
- data/docs/PayeeAddress2.md +31 -0
- data/docs/PayeeDelta.md +1 -1
- data/docs/PayeeDelta2.md +29 -0
- data/docs/PayeeDeltaResponse2.md +21 -0
- data/docs/PayeeDeltaResponse2Links.md +19 -0
- data/docs/PayeeInvitationApi.md +184 -64
- data/docs/PayeeInvitationStatus.md +1 -1
- data/docs/PayeeInvitationStatusResponse.md +3 -3
- data/docs/PayeeInvitationStatusResponse2.md +21 -0
- data/docs/PayeePaymentChannel.md +8 -8
- data/docs/PayeePaymentChannel2.md +29 -0
- data/docs/PayeePayorRef.md +1 -1
- data/docs/PayeePayorRefV2.md +25 -0
- data/docs/PayeePayorRefV3.md +25 -0
- data/docs/PayeeResponse.md +9 -9
- data/docs/PayeeResponse2.md +10 -10
- data/docs/PayeeResponseV2.md +73 -0
- data/docs/PayeeResponseV3.md +71 -0
- data/docs/PayeesApi.md +316 -35
- data/docs/PaymentAuditServiceApi.md +4 -4
- data/docs/PaymentChannelCountry.md +3 -3
- data/docs/PaymentChannelRule.md +11 -11
- data/docs/PaymentDelta.md +1 -1
- data/docs/PaymentDeltaResponse.md +1 -1
- data/docs/PaymentInstruction.md +1 -1
- data/docs/QueryBatchResponse2.md +23 -0
- data/docs/ResendTokenRequest.md +1 -1
- data/docs/RoleUpdateRequest.md +19 -0
- data/docs/SubmitPayoutApi.md +2 -2
- data/docs/SupportedCountriesResponse2.md +1 -1
- data/docs/{SupportedCountryV2.md → SupportedCountry2.md} +3 -3
- data/docs/SupportedCurrency.md +3 -3
- data/docs/TokensApi.md +0 -498
- data/docs/UnregisterMFARequest.md +1 -1
- data/docs/UpdateRemoteIdRequest.md +2 -2
- data/docs/UserDetailsUpdateRequest.md +31 -0
- data/docs/UsersApi.md +108 -54
- data/docs/WithdrawPayoutApi.md +6 -6
- data/lib/velopayments.rb +38 -16
- data/lib/velopayments/api/countries_api.rb +6 -6
- data/lib/velopayments/api/currencies_api.rb +3 -3
- data/lib/velopayments/api/funding_manager_api.rb +22 -6
- data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +5 -5
- data/lib/velopayments/api/get_payout_api.rb +8 -8
- data/lib/velopayments/api/instruct_payout_api.rb +10 -8
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +247 -111
- data/lib/velopayments/api/payees_api.rb +371 -35
- data/lib/velopayments/api/payment_audit_service_api.rb +6 -6
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_history_api.rb +2 -2
- data/lib/velopayments/api/quote_payout_api.rb +2 -2
- data/lib/velopayments/api/submit_payout_api.rb +6 -4
- data/lib/velopayments/api/tokens_api.rb +2 -695
- data/lib/velopayments/api/users_api.rb +142 -72
- data/lib/velopayments/api/withdraw_payout_api.rb +10 -8
- data/lib/velopayments/api_client.rb +2 -2
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +2 -2
- data/lib/velopayments/models/accepted_payment.rb +13 -3
- data/lib/velopayments/models/access_token_response.rb +13 -3
- data/lib/velopayments/models/access_token_validation_request.rb +13 -3
- 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/company.rb +308 -0
- data/lib/velopayments/models/company2.rb +308 -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 +13 -3
- data/lib/velopayments/models/create_individual.rb +13 -3
- data/lib/velopayments/models/create_individual2.rb +14 -4
- data/lib/velopayments/models/create_individual2_name.rb +347 -0
- data/lib/velopayments/models/create_payee.rb +16 -4
- data/lib/velopayments/models/create_payee2.rb +16 -4
- 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 +27 -11
- data/lib/velopayments/models/create_payees_csv_response.rb +14 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +14 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +224 -0
- 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 +13 -3
- data/lib/velopayments/models/create_payout_request.rb +28 -3
- data/lib/velopayments/models/currency_type.rb +13 -3
- data/lib/velopayments/models/error.rb +15 -5
- data/lib/velopayments/models/error_response.rb +15 -3
- data/lib/velopayments/models/failed_submission.rb +14 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → failed_submission2.rb} +29 -28
- data/lib/velopayments/models/funding_account_response.rb +13 -3
- data/lib/velopayments/models/funding_audit.rb +13 -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 +13 -3
- 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/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 +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +14 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +13 -3
- data/lib/velopayments/models/get_payout_statistics.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
- 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 -4
- data/lib/velopayments/models/individual.rb +260 -0
- data/lib/velopayments/models/individual2.rb +260 -0
- data/lib/velopayments/models/individual_response.rb +13 -3
- data/lib/velopayments/models/individual_v1.rb +37 -3
- data/lib/velopayments/models/individual_v1_name.rb +13 -3
- data/lib/velopayments/models/{generate_otp_request.rb → inline_response400.rb} +38 -18
- data/lib/velopayments/models/{validate_otp_request.rb → inline_response400_errors.rb} +52 -46
- data/lib/velopayments/models/inline_response401.rb +221 -0
- data/lib/velopayments/models/{validate_mfa_request.rb → inline_response401_errors.rb} +52 -46
- data/lib/velopayments/models/inline_response403.rb +221 -0
- data/lib/velopayments/models/{check_token_response.rb → inline_response403_errors.rb} +44 -42
- 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/{register_mfa_response.rb → invite_payee_request2.rb} +28 -24
- data/lib/velopayments/models/invite_user_request.rb +17 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/language.rb +2 -2
- data/lib/velopayments/models/{payment_status.rb → language2.rb} +16 -13
- data/lib/velopayments/models/link_for_response.rb +13 -3
- data/lib/velopayments/models/list_funding_accounts_response.rb +13 -3
- data/lib/velopayments/models/list_payments_response.rb +13 -3
- data/lib/velopayments/models/list_payments_response_page.rb +13 -3
- data/lib/velopayments/models/list_payments_response_v4.rb +13 -3
- 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 +13 -3
- data/lib/velopayments/models/{token_type.rb → location_type.rb} +10 -9
- data/lib/velopayments/models/marketing_opt_in.rb +13 -3
- data/lib/velopayments/models/mfa_details.rb +14 -3
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/notifications.rb +13 -3
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/{mfa_status.rb → ofac_status2.rb} +8 -7
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/{otp_type.rb → onboarded_status2.rb} +9 -6
- data/lib/velopayments/models/page_for_response.rb +13 -3
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +13 -3
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +14 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +229 -0
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +242 -0
- 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/paged_user_response.rb +13 -3
- data/lib/velopayments/models/paged_user_response_links.rb +13 -3
- data/lib/velopayments/models/paged_user_response_page.rb +13 -3
- data/lib/velopayments/models/password_request.rb +13 -3
- data/lib/velopayments/models/payee.rb +19 -3
- data/lib/velopayments/models/payee2.rb +456 -0
- data/lib/velopayments/models/payee_address.rb +18 -3
- data/lib/velopayments/models/payee_address2.rb +493 -0
- data/lib/velopayments/models/payee_delta.rb +14 -3
- data/lib/velopayments/models/payee_delta2.rb +299 -0
- data/lib/velopayments/models/payee_delta_response.rb +13 -3
- data/lib/velopayments/models/payee_delta_response2.rb +229 -0
- data/lib/velopayments/models/{register_mfa_request.rb → payee_delta_response2_links.rb} +32 -18
- 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 +48 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +268 -0
- data/lib/velopayments/models/payee_payment_channel.rb +60 -39
- data/lib/velopayments/models/payee_payment_channel2.rb +451 -0
- data/lib/velopayments/models/payee_payor_ref.rb +13 -3
- data/lib/velopayments/models/payee_payor_ref_v2.rb +278 -0
- data/lib/velopayments/models/payee_payor_ref_v3.rb +278 -0
- data/lib/velopayments/models/payee_response.rb +19 -3
- data/lib/velopayments/models/payee_response2.rb +20 -4
- data/lib/velopayments/models/payee_response_v2.rb +471 -0
- data/lib/velopayments/models/payee_response_v3.rb +462 -0
- 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 +25 -3
- data/lib/velopayments/models/payment_channel_rule.rb +40 -3
- data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
- data/lib/velopayments/models/payment_delta.rb +20 -4
- data/lib/velopayments/models/payment_delta_response.rb +14 -4
- 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 +14 -47
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/payment_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_response_v4.rb +13 -3
- data/lib/velopayments/models/payment_response_v4_payout.rb +13 -3
- 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 +13 -3
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +13 -3
- 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 +13 -3
- data/lib/velopayments/models/payor_v2.rb +13 -3
- 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 +13 -3
- data/lib/velopayments/models/payout_summary_audit_v4.rb +13 -3
- data/lib/velopayments/models/payout_summary_response.rb +13 -3
- data/lib/velopayments/models/payout_type_v4.rb +2 -2
- data/lib/velopayments/models/query_batch_response.rb +13 -3
- data/lib/velopayments/models/query_batch_response2.rb +270 -0
- 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 +13 -3
- data/lib/velopayments/models/register_sms_request.rb +13 -3
- data/lib/velopayments/models/rejected_payment.rb +13 -3
- data/lib/velopayments/models/resend_token_request.rb +15 -4
- data/lib/velopayments/models/reset_password_request.rb +13 -3
- data/lib/velopayments/models/role.rb +13 -3
- data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +31 -18
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +13 -3
- data/lib/velopayments/models/self_update_password_request.rb +13 -3
- 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 +14 -4
- data/lib/velopayments/models/supported_country.rb +13 -3
- data/lib/velopayments/models/{supported_country_v2.rb → supported_country2.rb} +20 -8
- data/lib/velopayments/models/supported_currency.rb +14 -3
- data/lib/velopayments/models/supported_currency_response.rb +13 -3
- data/lib/velopayments/models/transfer_request.rb +13 -3
- data/lib/velopayments/models/unregister_mfa_request.rb +17 -6
- data/lib/velopayments/models/update_remote_id_request.rb +13 -3
- data/lib/velopayments/models/user_details_update_request.rb +406 -0
- data/lib/velopayments/models/user_info.rb +13 -3
- data/lib/velopayments/models/user_response.rb +14 -3
- data/lib/velopayments/models/user_response2.rb +14 -3
- data/lib/velopayments/models/user_response2_roles.rb +13 -3
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +13 -3
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +3 -3
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +6 -4
- data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +8 -8
- 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 +2 -2
- data/spec/api/payee_invitation_api_spec.rb +62 -33
- data/spec/api/payees_api_spec.rb +81 -15
- data/spec/api/payment_audit_service_api_spec.rb +4 -4
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_history_api_spec.rb +2 -2
- data/spec/api/quote_payout_api_spec.rb +2 -2
- data/spec/api/submit_payout_api_spec.rb +3 -3
- data/spec/api/tokens_api_spec.rb +2 -131
- data/spec/api/users_api_spec.rb +28 -15
- 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 +2 -2
- data/spec/models/access_token_response_spec.rb +2 -2
- data/spec/models/access_token_validation_request_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +2 -2
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/{payee_payor_ref2_spec.rb → company2_spec.rb} +11 -11
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +53 -0
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_spec.rb +2 -2
- data/spec/models/create_individual2_name_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_rejected_csv_rows_spec.rb +53 -0
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payor_link_request_spec.rb +2 -2
- data/spec/models/create_payout_request_spec.rb +2 -2
- data/spec/models/currency_type_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/{register_mfa_response_spec.rb → failed_submission2_spec.rb} +10 -10
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response_spec.rb +2 -2
- data/spec/models/funding_audit_spec.rb +2 -2
- data/spec/models/funding_event_spec.rb +2 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +2 -2
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual2_spec.rb +53 -0
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +53 -0
- data/spec/models/individual_v1_name_spec.rb +2 -2
- data/spec/models/individual_v1_spec.rb +2 -2
- data/spec/models/inline_response400_errors_spec.rb +59 -0
- data/spec/models/{generate_otp_request_spec.rb → inline_response400_spec.rb} +15 -9
- data/spec/models/inline_response401_errors_spec.rb +59 -0
- data/spec/models/inline_response401_spec.rb +47 -0
- data/spec/models/inline_response403_errors_spec.rb +59 -0
- data/spec/models/inline_response403_spec.rb +47 -0
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/{register_mfa_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/invite_user_request_spec.rb +2 -2
- data/spec/models/kyc_state_spec.rb +2 -2
- data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/link_for_response_spec.rb +2 -2
- data/spec/models/list_funding_accounts_response_spec.rb +2 -2
- data/spec/models/list_payments_response_page_spec.rb +2 -2
- data/spec/models/list_payments_response_spec.rb +2 -2
- data/spec/models/list_payments_response_v4_spec.rb +2 -2
- data/spec/models/list_source_account_response_links_spec.rb +2 -2
- data/spec/models/list_source_account_response_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/{token_type_spec.rb → location_type_spec.rb} +8 -8
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/mfa_details_spec.rb +2 -2
- data/spec/models/mfa_type_spec.rb +2 -2
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/{payment_status_spec.rb → onboarded_status2_spec.rb} +8 -8
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/page_for_response_spec.rb +2 -2
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
- data/spec/models/{check_token_response_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +13 -13
- 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 +2 -2
- data/spec/models/paged_user_response_page_spec.rb +2 -2
- data/spec/models/paged_user_response_spec.rb +2 -2
- data/spec/models/password_request_spec.rb +2 -2
- data/spec/models/payee2_spec.rb +165 -0
- data/spec/models/payee_address2_spec.rb +83 -0
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +77 -0
- data/spec/models/payee_delta_response2_links_spec.rb +47 -0
- data/spec/models/payee_delta_response2_spec.rb +53 -0
- 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_response2_spec.rb +57 -0
- data/spec/models/payee_invitation_status_response_spec.rb +6 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +81 -0
- data/spec/models/payee_payment_channel_spec.rb +3 -3
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
- data/spec/models/payee_payor_ref_v3_spec.rb +69 -0
- data/spec/models/payee_response2_spec.rb +2 -2
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +209 -0
- data/spec/models/payee_response_v3_spec.rb +203 -0
- 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 -6
- data/spec/models/payment_rails_spec.rb +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +2 -2
- data/spec/models/payment_response_v4_spec.rb +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 +2 -2
- data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +2 -2
- data/spec/models/payor_v2_spec.rb +2 -2
- data/spec/models/payout_payor_v4_spec.rb +2 -2
- data/spec/models/payout_principal_v4_spec.rb +2 -2
- data/spec/models/payout_status_v3_spec.rb +2 -2
- data/spec/models/payout_status_v4_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
- data/spec/models/payout_summary_audit_v4_spec.rb +2 -2
- data/spec/models/payout_summary_response_spec.rb +2 -2
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/query_batch_response2_spec.rb +63 -0
- 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 +2 -2
- data/spec/models/register_sms_request_spec.rb +2 -2
- data/spec/models/rejected_payment_spec.rb +2 -2
- data/spec/models/resend_token_request_spec.rb +2 -2
- data/spec/models/reset_password_request_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
- data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
- data/spec/models/self_update_password_request_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +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 +2 -2
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/{supported_country_v2_spec.rb → supported_country2_spec.rb} +8 -8
- 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/transfer_request_spec.rb +2 -2
- data/spec/models/unregister_mfa_request_spec.rb +3 -3
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/user_details_update_request_spec.rb +83 -0
- data/spec/models/user_info_spec.rb +2 -2
- data/spec/models/user_response2_roles_spec.rb +2 -2
- data/spec/models/user_response2_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_status_spec.rb +2 -2
- data/spec/models/user_type2_spec.rb +2 -2
- data/spec/models/user_type_spec.rb +2 -2
- data/spec/models/validate_password_response_spec.rb +2 -2
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/velopayments.gemspec +2 -2
- metadata +310 -222
- data/docs/CheckTokenResponse.md +0 -25
- data/docs/EmailUpdateRequest.md +0 -19
- data/docs/PayeePayorRef2.md +0 -21
- data/docs/RegisterMFARequest.md +0 -17
- data/docs/RegisterMFAResponse.md +0 -19
- data/docs/ValidateMFARequest.md +0 -17
- data/docs/ValidateOTPRequest.md +0 -17
- data/spec/models/validate_mfa_request_spec.rb +0 -41
- data/spec/models/validate_otp_request_spec.rb +0 -41
@@ -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.19.40
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -34,6 +34,12 @@ module VeloPayments
|
|
34
34
|
}
|
35
35
|
end
|
36
36
|
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
37
43
|
# Initializes the object
|
38
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
39
45
|
def initialize(attributes = {})
|
@@ -190,7 +196,11 @@ module VeloPayments
|
|
190
196
|
hash = {}
|
191
197
|
self.class.attribute_map.each_pair do |attr, param|
|
192
198
|
value = self.send(attr)
|
193
|
-
|
199
|
+
if value.nil?
|
200
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
201
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
202
|
+
end
|
203
|
+
|
194
204
|
hash[param] = _to_hash(value)
|
195
205
|
end
|
196
206
|
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.19.40
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -34,6 +34,12 @@ module VeloPayments
|
|
34
34
|
}
|
35
35
|
end
|
36
36
|
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
37
43
|
# Initializes the object
|
38
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
39
45
|
def initialize(attributes = {})
|
@@ -190,7 +196,11 @@ module VeloPayments
|
|
190
196
|
hash = {}
|
191
197
|
self.class.attribute_map.each_pair do |attr, param|
|
192
198
|
value = self.send(attr)
|
193
|
-
|
199
|
+
if value.nil?
|
200
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
201
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
202
|
+
end
|
203
|
+
|
194
204
|
hash[param] = _to_hash(value)
|
195
205
|
end
|
196
206
|
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.19.40
|
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
|
|
@@ -80,6 +80,12 @@ module VeloPayments
|
|
80
80
|
}
|
81
81
|
end
|
82
82
|
|
83
|
+
# List of attributes with nullable: true
|
84
|
+
def self.openapi_nullable
|
85
|
+
Set.new([
|
86
|
+
])
|
87
|
+
end
|
88
|
+
|
83
89
|
# Initializes the object
|
84
90
|
# @param [Hash] attributes Model attributes in the form of hash
|
85
91
|
def initialize(attributes = {})
|
@@ -381,7 +387,11 @@ module VeloPayments
|
|
381
387
|
hash = {}
|
382
388
|
self.class.attribute_map.each_pair do |attr, param|
|
383
389
|
value = self.send(attr)
|
384
|
-
|
390
|
+
if value.nil?
|
391
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
392
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
393
|
+
end
|
394
|
+
|
385
395
|
hash[param] = _to_hash(value)
|
386
396
|
end
|
387
397
|
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.19.40
|
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
|
|
@@ -80,6 +80,12 @@ module VeloPayments
|
|
80
80
|
}
|
81
81
|
end
|
82
82
|
|
83
|
+
# List of attributes with nullable: true
|
84
|
+
def self.openapi_nullable
|
85
|
+
Set.new([
|
86
|
+
])
|
87
|
+
end
|
88
|
+
|
83
89
|
# Initializes the object
|
84
90
|
# @param [Hash] attributes Model attributes in the form of hash
|
85
91
|
def initialize(attributes = {})
|
@@ -381,7 +387,11 @@ module VeloPayments
|
|
381
387
|
hash = {}
|
382
388
|
self.class.attribute_map.each_pair do |attr, param|
|
383
389
|
value = self.send(attr)
|
384
|
-
|
390
|
+
if value.nil?
|
391
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
392
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
393
|
+
end
|
394
|
+
|
385
395
|
hash[param] = _to_hash(value)
|
386
396
|
end
|
387
397
|
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.19.40
|
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
|
|
@@ -60,6 +60,12 @@ module VeloPayments
|
|
60
60
|
}
|
61
61
|
end
|
62
62
|
|
63
|
+
# List of attributes with nullable: true
|
64
|
+
def self.openapi_nullable
|
65
|
+
Set.new([
|
66
|
+
])
|
67
|
+
end
|
68
|
+
|
63
69
|
# Initializes the object
|
64
70
|
# @param [Hash] attributes Model attributes in the form of hash
|
65
71
|
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.19.40
|
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
|
|
@@ -50,6 +50,12 @@ module VeloPayments
|
|
50
50
|
}
|
51
51
|
end
|
52
52
|
|
53
|
+
# List of attributes with nullable: true
|
54
|
+
def self.openapi_nullable
|
55
|
+
Set.new([
|
56
|
+
])
|
57
|
+
end
|
58
|
+
|
53
59
|
# Initializes the object
|
54
60
|
# @param [Hash] attributes Model attributes in the form of hash
|
55
61
|
def initialize(attributes = {})
|
@@ -92,6 +98,10 @@ module VeloPayments
|
|
92
98
|
# @return Array for valid properties with the reasons
|
93
99
|
def list_invalid_properties
|
94
100
|
invalid_properties = Array.new
|
101
|
+
if !@payout_memo.nil? && @payout_memo.to_s.length > 40
|
102
|
+
invalid_properties.push('invalid value for "payout_memo", the character length must be smaller than or equal to 40.')
|
103
|
+
end
|
104
|
+
|
95
105
|
if @payments.nil?
|
96
106
|
invalid_properties.push('invalid value for "payments", payments cannot be nil.')
|
97
107
|
end
|
@@ -102,10 +112,21 @@ module VeloPayments
|
|
102
112
|
# Check to see if the all the properties in the model are valid
|
103
113
|
# @return true if the model is valid
|
104
114
|
def valid?
|
115
|
+
return false if !@payout_memo.nil? && @payout_memo.to_s.length > 40
|
105
116
|
return false if @payments.nil?
|
106
117
|
true
|
107
118
|
end
|
108
119
|
|
120
|
+
# Custom attribute writer method with validation
|
121
|
+
# @param [Object] payout_memo Value to be assigned
|
122
|
+
def payout_memo=(payout_memo)
|
123
|
+
if !payout_memo.nil? && payout_memo.to_s.length > 40
|
124
|
+
fail ArgumentError, 'invalid value for "payout_memo", the character length must be smaller than or equal to 40.'
|
125
|
+
end
|
126
|
+
|
127
|
+
@payout_memo = payout_memo
|
128
|
+
end
|
129
|
+
|
109
130
|
# Checks equality by comparing each attribute.
|
110
131
|
# @param [Object] Object to be compared
|
111
132
|
def ==(o)
|
@@ -216,7 +237,11 @@ module VeloPayments
|
|
216
237
|
hash = {}
|
217
238
|
self.class.attribute_map.each_pair do |attr, param|
|
218
239
|
value = self.send(attr)
|
219
|
-
|
240
|
+
if value.nil?
|
241
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
242
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
243
|
+
end
|
244
|
+
|
220
245
|
hash[param] = _to_hash(value)
|
221
246
|
end
|
222
247
|
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.19.40
|
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 = {})
|
@@ -202,7 +208,11 @@ module VeloPayments
|
|
202
208
|
hash = {}
|
203
209
|
self.class.attribute_map.each_pair do |attr, param|
|
204
210
|
value = self.send(attr)
|
205
|
-
|
211
|
+
if value.nil?
|
212
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
213
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
214
|
+
end
|
215
|
+
|
206
216
|
hash[param] = _to_hash(value)
|
207
217
|
end
|
208
218
|
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.19.40
|
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
|
|
@@ -68,6 +68,12 @@ module VeloPayments
|
|
68
68
|
}
|
69
69
|
end
|
70
70
|
|
71
|
+
# List of attributes with nullable: true
|
72
|
+
def self.openapi_nullable
|
73
|
+
Set.new([
|
74
|
+
])
|
75
|
+
end
|
76
|
+
|
71
77
|
# Initializes the object
|
72
78
|
# @param [Hash] attributes Model attributes in the form of hash
|
73
79
|
def initialize(attributes = {})
|
@@ -110,7 +116,7 @@ module VeloPayments
|
|
110
116
|
# Check to see if the all the properties in the model are valid
|
111
117
|
# @return true if the model is valid
|
112
118
|
def valid?
|
113
|
-
location_type_validator = EnumAttributeValidator.new('String', ["requestBody", "queryParam", "header", "pathParam"])
|
119
|
+
location_type_validator = EnumAttributeValidator.new('String', ["requestBody", "queryParam", "requestParam", "header", "pathParam"])
|
114
120
|
return false unless location_type_validator.valid?(@location_type)
|
115
121
|
true
|
116
122
|
end
|
@@ -118,7 +124,7 @@ module VeloPayments
|
|
118
124
|
# Custom attribute writer method checking allowed values (enum).
|
119
125
|
# @param [Object] location_type Object to be assigned
|
120
126
|
def location_type=(location_type)
|
121
|
-
validator = EnumAttributeValidator.new('String', ["requestBody", "queryParam", "header", "pathParam"])
|
127
|
+
validator = EnumAttributeValidator.new('String', ["requestBody", "queryParam", "requestParam", "header", "pathParam"])
|
122
128
|
unless validator.valid?(location_type)
|
123
129
|
fail ArgumentError, "invalid value for \"location_type\", must be one of #{validator.allowable_values}."
|
124
130
|
end
|
@@ -234,7 +240,11 @@ module VeloPayments
|
|
234
240
|
hash = {}
|
235
241
|
self.class.attribute_map.each_pair do |attr, param|
|
236
242
|
value = self.send(attr)
|
237
|
-
|
243
|
+
if value.nil?
|
244
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
245
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
246
|
+
end
|
247
|
+
|
238
248
|
hash[param] = _to_hash(value)
|
239
249
|
end
|
240
250
|
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.19.40
|
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,14 @@ 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
|
+
:'errors',
|
44
|
+
:'correlation_id'
|
45
|
+
])
|
46
|
+
end
|
47
|
+
|
40
48
|
# Initializes the object
|
41
49
|
# @param [Hash] attributes Model attributes in the form of hash
|
42
50
|
def initialize(attributes = {})
|
@@ -183,7 +191,11 @@ module VeloPayments
|
|
183
191
|
hash = {}
|
184
192
|
self.class.attribute_map.each_pair do |attr, param|
|
185
193
|
value = self.send(attr)
|
186
|
-
|
194
|
+
if value.nil?
|
195
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
196
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
197
|
+
end
|
198
|
+
|
187
199
|
hash[param] = _to_hash(value)
|
188
200
|
end
|
189
201
|
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.19.40
|
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
|
|
@@ -29,11 +29,17 @@ module VeloPayments
|
|
29
29
|
# Attribute type mapping.
|
30
30
|
def self.openapi_types
|
31
31
|
{
|
32
|
-
:'failed_submission' => :'
|
32
|
+
:'failed_submission' => :'Payee2',
|
33
33
|
:'failure_message' => :'String'
|
34
34
|
}
|
35
35
|
end
|
36
36
|
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
37
43
|
# Initializes the object
|
38
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
39
45
|
def initialize(attributes = {})
|
@@ -178,7 +184,11 @@ module VeloPayments
|
|
178
184
|
hash = {}
|
179
185
|
self.class.attribute_map.each_pair do |attr, param|
|
180
186
|
value = self.send(attr)
|
181
|
-
|
187
|
+
if value.nil?
|
188
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
189
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
190
|
+
end
|
191
|
+
|
182
192
|
hash[param] = _to_hash(value)
|
183
193
|
end
|
184
194
|
hash
|
@@ -3,66 +3,64 @@
|
|
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.19.40
|
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
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module VeloPayments
|
16
|
-
class
|
17
|
-
attr_accessor :
|
16
|
+
class FailedSubmission2
|
17
|
+
attr_accessor :failed_submission
|
18
18
|
|
19
|
-
attr_accessor :
|
20
|
-
|
21
|
-
attr_accessor :invitation_status
|
19
|
+
attr_accessor :failure_message
|
22
20
|
|
23
21
|
# Attribute mapping from ruby-style variable name to JSON key.
|
24
22
|
def self.attribute_map
|
25
23
|
{
|
26
|
-
:'
|
27
|
-
:'
|
28
|
-
:'invitation_status' => :'invitationStatus'
|
24
|
+
:'failed_submission' => :'failedSubmission',
|
25
|
+
:'failure_message' => :'failureMessage'
|
29
26
|
}
|
30
27
|
end
|
31
28
|
|
32
29
|
# Attribute type mapping.
|
33
30
|
def self.openapi_types
|
34
31
|
{
|
35
|
-
:'
|
36
|
-
:'
|
37
|
-
:'invitation_status' => :'String'
|
32
|
+
:'failed_submission' => :'Payee2',
|
33
|
+
:'failure_message' => :'String'
|
38
34
|
}
|
39
35
|
end
|
40
36
|
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
41
43
|
# Initializes the object
|
42
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
43
45
|
def initialize(attributes = {})
|
44
46
|
if (!attributes.is_a?(Hash))
|
45
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
47
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::FailedSubmission2` initialize method"
|
46
48
|
end
|
47
49
|
|
48
50
|
# check to see if the attribute exists and convert string to symbol for hash key
|
49
51
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
50
52
|
if (!self.class.attribute_map.key?(k.to_sym))
|
51
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
53
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::FailedSubmission2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
52
54
|
end
|
53
55
|
h[k.to_sym] = v
|
54
56
|
}
|
55
57
|
|
56
|
-
if attributes.key?(:'
|
57
|
-
self.
|
58
|
+
if attributes.key?(:'failed_submission')
|
59
|
+
self.failed_submission = attributes[:'failed_submission']
|
58
60
|
end
|
59
61
|
|
60
|
-
if attributes.key?(:'
|
61
|
-
self.
|
62
|
-
end
|
63
|
-
|
64
|
-
if attributes.key?(:'invitation_status')
|
65
|
-
self.invitation_status = attributes[:'invitation_status']
|
62
|
+
if attributes.key?(:'failure_message')
|
63
|
+
self.failure_message = attributes[:'failure_message']
|
66
64
|
end
|
67
65
|
end
|
68
66
|
|
@@ -84,9 +82,8 @@ module VeloPayments
|
|
84
82
|
def ==(o)
|
85
83
|
return true if self.equal?(o)
|
86
84
|
self.class == o.class &&
|
87
|
-
|
88
|
-
|
89
|
-
invitation_status == o.invitation_status
|
85
|
+
failed_submission == o.failed_submission &&
|
86
|
+
failure_message == o.failure_message
|
90
87
|
end
|
91
88
|
|
92
89
|
# @see the `==` method
|
@@ -98,7 +95,7 @@ module VeloPayments
|
|
98
95
|
# Calculates hash code according to all attributes.
|
99
96
|
# @return [Integer] Hash code
|
100
97
|
def hash
|
101
|
-
[
|
98
|
+
[failed_submission, failure_message].hash
|
102
99
|
end
|
103
100
|
|
104
101
|
# Builds the object from hash
|
@@ -187,7 +184,11 @@ module VeloPayments
|
|
187
184
|
hash = {}
|
188
185
|
self.class.attribute_map.each_pair do |attr, param|
|
189
186
|
value = self.send(attr)
|
190
|
-
|
187
|
+
if value.nil?
|
188
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
189
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
190
|
+
end
|
191
|
+
|
191
192
|
hash[param] = _to_hash(value)
|
192
193
|
end
|
193
194
|
hash
|