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
|
|
@@ -57,7 +57,7 @@ module VeloPayments
|
|
57
57
|
return_type = opts[:return_type] || 'SupportedCountriesResponse2'
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:auth_names] || [
|
60
|
+
auth_names = opts[:auth_names] || []
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
63
|
:header_params => header_params,
|
@@ -76,7 +76,7 @@ module VeloPayments
|
|
76
76
|
end
|
77
77
|
|
78
78
|
# List Supported Countries
|
79
|
-
# List the supported countries.
|
79
|
+
# <p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
|
80
80
|
# @param [Hash] opts the optional parameters
|
81
81
|
# @return [SupportedCountriesResponse]
|
82
82
|
def list_supported_countries_v1(opts = {})
|
@@ -85,7 +85,7 @@ module VeloPayments
|
|
85
85
|
end
|
86
86
|
|
87
87
|
# List Supported Countries
|
88
|
-
# List the supported countries.
|
88
|
+
# <p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
90
|
# @return [Array<(SupportedCountriesResponse, Integer, Hash)>] SupportedCountriesResponse data, response status code and response headers
|
91
91
|
def list_supported_countries_v1_with_http_info(opts = {})
|
@@ -113,7 +113,7 @@ module VeloPayments
|
|
113
113
|
return_type = opts[:return_type] || 'SupportedCountriesResponse'
|
114
114
|
|
115
115
|
# auth_names
|
116
|
-
auth_names = opts[:auth_names] || [
|
116
|
+
auth_names = opts[:auth_names] || []
|
117
117
|
|
118
118
|
new_options = opts.merge(
|
119
119
|
:header_params => header_params,
|
@@ -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
|
|
@@ -57,7 +57,7 @@ module VeloPayments
|
|
57
57
|
return_type = opts[:return_type] || 'SupportedCurrencyResponse'
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:auth_names] || [
|
60
|
+
auth_names = opts[:auth_names] || []
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
63
|
:header_params => header_params,
|
@@ -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
|
|
@@ -497,7 +497,7 @@ module VeloPayments
|
|
497
497
|
# @option opts [String] :payor_id The account owner Payor ID
|
498
498
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
499
499
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
500
|
-
# @option opts [String] :sort
|
500
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef (default to 'fundingRef:asc')
|
501
501
|
# @return [ListSourceAccountResponse]
|
502
502
|
def get_source_accounts(opts = {})
|
503
503
|
data, _status_code, _headers = get_source_accounts_with_http_info(opts)
|
@@ -511,12 +511,17 @@ module VeloPayments
|
|
511
511
|
# @option opts [String] :payor_id The account owner Payor ID
|
512
512
|
# @option opts [Integer] :page Page number. Default is 1.
|
513
513
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
514
|
-
# @option opts [String] :sort
|
514
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef
|
515
515
|
# @return [Array<(ListSourceAccountResponse, Integer, Hash)>] ListSourceAccountResponse data, response status code and response headers
|
516
516
|
def get_source_accounts_with_http_info(opts = {})
|
517
517
|
if @api_client.config.debugging
|
518
518
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts ...'
|
519
519
|
end
|
520
|
+
pattern = Regexp.new(/[fundingRef]+[:desc|:asc]/)
|
521
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
522
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts, must conform to the pattern #{pattern}."
|
523
|
+
end
|
524
|
+
|
520
525
|
# resource path
|
521
526
|
local_var_path = '/v1/sourceAccounts'
|
522
527
|
|
@@ -565,10 +570,12 @@ module VeloPayments
|
|
565
570
|
# List source accounts.
|
566
571
|
# @param [Hash] opts the optional parameters
|
567
572
|
# @option opts [String] :physical_account_name Physical Account Name
|
573
|
+
# @option opts [String] :physical_account_id The physical account ID
|
568
574
|
# @option opts [String] :payor_id The account owner Payor ID
|
575
|
+
# @option opts [String] :funding_account_id The funding account ID
|
569
576
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
570
577
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
571
|
-
# @option opts [String] :sort
|
578
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance (default to 'fundingRef:asc')
|
572
579
|
# @return [ListSourceAccountResponseV2]
|
573
580
|
def get_source_accounts_v2(opts = {})
|
574
581
|
data, _status_code, _headers = get_source_accounts_v2_with_http_info(opts)
|
@@ -579,22 +586,31 @@ module VeloPayments
|
|
579
586
|
# List source accounts.
|
580
587
|
# @param [Hash] opts the optional parameters
|
581
588
|
# @option opts [String] :physical_account_name Physical Account Name
|
589
|
+
# @option opts [String] :physical_account_id The physical account ID
|
582
590
|
# @option opts [String] :payor_id The account owner Payor ID
|
591
|
+
# @option opts [String] :funding_account_id The funding account ID
|
583
592
|
# @option opts [Integer] :page Page number. Default is 1.
|
584
593
|
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
585
|
-
# @option opts [String] :sort
|
594
|
+
# @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
|
586
595
|
# @return [Array<(ListSourceAccountResponseV2, Integer, Hash)>] ListSourceAccountResponseV2 data, response status code and response headers
|
587
596
|
def get_source_accounts_v2_with_http_info(opts = {})
|
588
597
|
if @api_client.config.debugging
|
589
598
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts_v2 ...'
|
590
599
|
end
|
600
|
+
pattern = Regexp.new(/[fundingRef|name|balance]+[:desc|:asc]/)
|
601
|
+
if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
|
602
|
+
fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts_v2, must conform to the pattern #{pattern}."
|
603
|
+
end
|
604
|
+
|
591
605
|
# resource path
|
592
606
|
local_var_path = '/v2/sourceAccounts'
|
593
607
|
|
594
608
|
# query parameters
|
595
609
|
query_params = opts[:query_params] || {}
|
596
610
|
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
|
611
|
+
query_params[:'physicalAccountId'] = opts[:'physical_account_id'] if !opts[:'physical_account_id'].nil?
|
597
612
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
613
|
+
query_params[:'fundingAccountId'] = opts[:'funding_account_id'] if !opts[:'funding_account_id'].nil?
|
598
614
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
599
615
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
600
616
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -3,17 +3,17 @@
|
|
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 'cgi'
|
14
14
|
|
15
15
|
module VeloPayments
|
16
|
-
class
|
16
|
+
class FundingManagerPrivateApi
|
17
17
|
attr_accessor :api_client
|
18
18
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
@@ -36,7 +36,7 @@ module VeloPayments
|
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
37
|
def create_funding_account_with_http_info(opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API:
|
39
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerPrivateApi.create_funding_account ...'
|
40
40
|
end
|
41
41
|
# resource path
|
42
42
|
local_var_path = '/v1/fundingAccounts'
|
@@ -74,7 +74,7 @@ module VeloPayments
|
|
74
74
|
|
75
75
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
76
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called:
|
77
|
+
@api_client.config.logger.debug "API called: FundingManagerPrivateApi#create_funding_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
78
|
end
|
79
79
|
return data, status_code, headers
|
80
80
|
end
|
@@ -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
|
|
@@ -24,8 +24,8 @@ module VeloPayments
|
|
24
24
|
# @param payout_id [String] Id of the payout
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [PayoutSummaryResponse]
|
27
|
-
def
|
28
|
-
data, _status_code, _headers =
|
27
|
+
def v3_payouts_payout_id_get(payout_id, opts = {})
|
28
|
+
data, _status_code, _headers = v3_payouts_payout_id_get_with_http_info(payout_id, opts)
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
@@ -34,13 +34,13 @@ module VeloPayments
|
|
34
34
|
# @param payout_id [String] Id of the payout
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(PayoutSummaryResponse, Integer, Hash)>] PayoutSummaryResponse data, response status code and response headers
|
37
|
-
def
|
37
|
+
def v3_payouts_payout_id_get_with_http_info(payout_id, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: GetPayoutApi.
|
39
|
+
@api_client.config.logger.debug 'Calling API: GetPayoutApi.v3_payouts_payout_id_get ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'payout_id' is set
|
42
42
|
if @api_client.config.client_side_validation && payout_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.
|
43
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.v3_payouts_payout_id_get"
|
44
44
|
end
|
45
45
|
# resource path
|
46
46
|
local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -76,7 +76,7 @@ module VeloPayments
|
|
76
76
|
|
77
77
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
78
78
|
if @api_client.config.debugging
|
79
|
-
@api_client.config.logger.debug "API called: GetPayoutApi#
|
79
|
+
@api_client.config.logger.debug "API called: GetPayoutApi#v3_payouts_payout_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
80
|
end
|
81
81
|
return data, status_code, headers
|
82
82
|
end
|
@@ -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
|
|
@@ -24,8 +24,8 @@ module VeloPayments
|
|
24
24
|
# @param payout_id [String] Id of the payout
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
27
|
-
def
|
28
|
-
|
27
|
+
def v3_payouts_payout_id_post(payout_id, opts = {})
|
28
|
+
v3_payouts_payout_id_post_with_http_info(payout_id, opts)
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
@@ -34,13 +34,13 @@ module VeloPayments
|
|
34
34
|
# @param payout_id [String] Id of the payout
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
-
def
|
37
|
+
def v3_payouts_payout_id_post_with_http_info(payout_id, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: InstructPayoutApi.
|
39
|
+
@api_client.config.logger.debug 'Calling API: InstructPayoutApi.v3_payouts_payout_id_post ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'payout_id' is set
|
42
42
|
if @api_client.config.client_side_validation && payout_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payout_id' when calling InstructPayoutApi.
|
43
|
+
fail ArgumentError, "Missing the required parameter 'payout_id' when calling InstructPayoutApi.v3_payouts_payout_id_post"
|
44
44
|
end
|
45
45
|
# resource path
|
46
46
|
local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
|
@@ -50,6 +50,8 @@ module VeloPayments
|
|
50
50
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
53
55
|
|
54
56
|
# form parameters
|
55
57
|
form_params = opts[:form_params] || {}
|
@@ -74,7 +76,7 @@ module VeloPayments
|
|
74
76
|
|
75
77
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
78
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called: InstructPayoutApi#
|
79
|
+
@api_client.config.logger.debug "API called: InstructPayoutApi#v3_payouts_payout_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
80
|
end
|
79
81
|
return data, status_code, headers
|
80
82
|
end
|
@@ -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
|
|
@@ -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
|
|
@@ -20,27 +20,27 @@ module VeloPayments
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Payee Invitation Status
|
23
|
-
# Returns a list of payees associated with a payor, along with invitation status and grace period end date
|
23
|
+
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
24
24
|
# @param payor_id [String] The account owner Payor ID
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [InvitationStatusResponse]
|
27
|
-
def
|
28
|
-
data, _status_code, _headers =
|
27
|
+
def get_payees_invitation_status_v1(payor_id, opts = {})
|
28
|
+
data, _status_code, _headers = get_payees_invitation_status_v1_with_http_info(payor_id, opts)
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
32
|
# Get Payee Invitation Status
|
33
|
-
# Returns a list of payees associated with a payor, along with invitation status and grace period end date
|
33
|
+
# <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
34
34
|
# @param payor_id [String] The account owner Payor ID
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(InvitationStatusResponse, Integer, Hash)>] InvitationStatusResponse data, response status code and response headers
|
37
|
-
def
|
37
|
+
def get_payees_invitation_status_v1_with_http_info(payor_id, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
39
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v1 ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'payor_id' is set
|
42
42
|
if @api_client.config.client_side_validation && payor_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.
|
43
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v1"
|
44
44
|
end
|
45
45
|
# resource path
|
46
46
|
local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
@@ -76,13 +76,13 @@ module VeloPayments
|
|
76
76
|
|
77
77
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
78
78
|
if @api_client.config.debugging
|
79
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
79
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
80
|
end
|
81
81
|
return data, status_code, headers
|
82
82
|
end
|
83
83
|
|
84
84
|
# Get Payee Invitation Status
|
85
|
-
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date
|
85
|
+
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
86
86
|
# @param payor_id [String] The account owner Payor ID
|
87
87
|
# @param [Hash] opts the optional parameters
|
88
88
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -96,7 +96,7 @@ module VeloPayments
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# Get Payee Invitation Status
|
99
|
-
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date
|
99
|
+
# <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
|
100
100
|
# @param payor_id [String] The account owner Payor ID
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @option opts [String] :payee_id The UUID of the payee.
|
@@ -155,56 +155,60 @@ module VeloPayments
|
|
155
155
|
return data, status_code, headers
|
156
156
|
end
|
157
157
|
|
158
|
-
#
|
159
|
-
#
|
160
|
-
# @param
|
161
|
-
# @param invite_payee_request [InvitePayeeRequest]
|
158
|
+
# Get Payee Invitation Status
|
159
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
160
|
+
# @param payor_id [String] The account owner Payor ID
|
162
161
|
# @param [Hash] opts the optional parameters
|
163
|
-
# @
|
164
|
-
|
165
|
-
|
162
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
163
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
164
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
165
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
166
|
+
# @return [PagedPayeeInvitationStatusResponse2]
|
167
|
+
def get_payees_invitation_status_v3(payor_id, opts = {})
|
168
|
+
data, _status_code, _headers = get_payees_invitation_status_v3_with_http_info(payor_id, opts)
|
166
169
|
data
|
167
170
|
end
|
168
171
|
|
169
|
-
#
|
170
|
-
#
|
171
|
-
# @param
|
172
|
-
# @param invite_payee_request [InvitePayeeRequest]
|
172
|
+
# Get Payee Invitation Status
|
173
|
+
# Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
|
174
|
+
# @param payor_id [String] The account owner Payor ID
|
173
175
|
# @param [Hash] opts the optional parameters
|
174
|
-
# @
|
175
|
-
|
176
|
+
# @option opts [String] :payee_id The UUID of the payee.
|
177
|
+
# @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
|
178
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
179
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
180
|
+
# @return [Array<(PagedPayeeInvitationStatusResponse2, Integer, Hash)>] PagedPayeeInvitationStatusResponse2 data, response status code and response headers
|
181
|
+
def get_payees_invitation_status_v3_with_http_info(payor_id, opts = {})
|
176
182
|
if @api_client.config.debugging
|
177
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
178
|
-
end
|
179
|
-
# verify the required parameter 'payee_id' is set
|
180
|
-
if @api_client.config.client_side_validation && payee_id.nil?
|
181
|
-
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite"
|
183
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v3 ...'
|
182
184
|
end
|
183
|
-
# verify the required parameter '
|
184
|
-
if @api_client.config.client_side_validation &&
|
185
|
-
fail ArgumentError, "Missing the required parameter '
|
185
|
+
# verify the required parameter 'payor_id' is set
|
186
|
+
if @api_client.config.client_side_validation && payor_id.nil?
|
187
|
+
fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v3"
|
186
188
|
end
|
187
189
|
# resource path
|
188
|
-
local_var_path = '/
|
190
|
+
local_var_path = '/v3/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
|
189
191
|
|
190
192
|
# query parameters
|
191
193
|
query_params = opts[:query_params] || {}
|
194
|
+
query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
|
195
|
+
query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
|
196
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
197
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
192
198
|
|
193
199
|
# header parameters
|
194
200
|
header_params = opts[:header_params] || {}
|
195
201
|
# HTTP header 'Accept' (if needed)
|
196
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
197
|
-
# HTTP header 'Content-Type'
|
198
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
199
203
|
|
200
204
|
# form parameters
|
201
205
|
form_params = opts[:form_params] || {}
|
202
206
|
|
203
207
|
# http body (model)
|
204
|
-
post_body = opts[:body]
|
208
|
+
post_body = opts[:body]
|
205
209
|
|
206
210
|
# return_type
|
207
|
-
return_type = opts[:return_type] || '
|
211
|
+
return_type = opts[:return_type] || 'PagedPayeeInvitationStatusResponse2'
|
208
212
|
|
209
213
|
# auth_names
|
210
214
|
auth_names = opts[:auth_names] || ['OAuth2']
|
@@ -218,38 +222,38 @@ module VeloPayments
|
|
218
222
|
:return_type => return_type
|
219
223
|
)
|
220
224
|
|
221
|
-
data, status_code, headers = @api_client.call_api(:
|
225
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
222
226
|
if @api_client.config.debugging
|
223
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
227
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
224
228
|
end
|
225
229
|
return data, status_code, headers
|
226
230
|
end
|
227
231
|
|
228
|
-
#
|
229
|
-
#
|
230
|
-
# @param
|
232
|
+
# Query Batch Status
|
233
|
+
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
|
234
|
+
# @param batch_id [String] Batch Id
|
231
235
|
# @param [Hash] opts the optional parameters
|
232
|
-
# @return [
|
233
|
-
def
|
234
|
-
data, _status_code, _headers =
|
236
|
+
# @return [QueryBatchResponse]
|
237
|
+
def query_batch_status_v2(batch_id, opts = {})
|
238
|
+
data, _status_code, _headers = query_batch_status_v2_with_http_info(batch_id, opts)
|
235
239
|
data
|
236
240
|
end
|
237
241
|
|
238
|
-
#
|
239
|
-
#
|
240
|
-
# @param
|
242
|
+
# Query Batch Status
|
243
|
+
# <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
|
244
|
+
# @param batch_id [String] Batch Id
|
241
245
|
# @param [Hash] opts the optional parameters
|
242
|
-
# @return [Array<(
|
243
|
-
def
|
246
|
+
# @return [Array<(QueryBatchResponse, Integer, Hash)>] QueryBatchResponse data, response status code and response headers
|
247
|
+
def query_batch_status_v2_with_http_info(batch_id, opts = {})
|
244
248
|
if @api_client.config.debugging
|
245
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
249
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v2 ...'
|
246
250
|
end
|
247
|
-
# verify the required parameter '
|
248
|
-
if @api_client.config.client_side_validation &&
|
249
|
-
fail ArgumentError, "Missing the required parameter '
|
251
|
+
# verify the required parameter 'batch_id' is set
|
252
|
+
if @api_client.config.client_side_validation && batch_id.nil?
|
253
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v2"
|
250
254
|
end
|
251
255
|
# resource path
|
252
|
-
local_var_path = '/v2/payees'
|
256
|
+
local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
253
257
|
|
254
258
|
# query parameters
|
255
259
|
query_params = opts[:query_params] || {}
|
@@ -258,17 +262,15 @@ module VeloPayments
|
|
258
262
|
header_params = opts[:header_params] || {}
|
259
263
|
# HTTP header 'Accept' (if needed)
|
260
264
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
261
|
-
# HTTP header 'Content-Type'
|
262
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
263
265
|
|
264
266
|
# form parameters
|
265
267
|
form_params = opts[:form_params] || {}
|
266
268
|
|
267
269
|
# http body (model)
|
268
|
-
post_body = opts[:body]
|
270
|
+
post_body = opts[:body]
|
269
271
|
|
270
272
|
# return_type
|
271
|
-
return_type = opts[:return_type] || '
|
273
|
+
return_type = opts[:return_type] || 'QueryBatchResponse'
|
272
274
|
|
273
275
|
# auth_names
|
274
276
|
auth_names = opts[:auth_names] || ['OAuth2']
|
@@ -282,9 +284,9 @@ module VeloPayments
|
|
282
284
|
:return_type => return_type
|
283
285
|
)
|
284
286
|
|
285
|
-
data, status_code, headers = @api_client.call_api(:
|
287
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
286
288
|
if @api_client.config.debugging
|
287
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
289
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
288
290
|
end
|
289
291
|
return data, status_code, headers
|
290
292
|
end
|
@@ -293,9 +295,9 @@ module VeloPayments
|
|
293
295
|
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
294
296
|
# @param batch_id [String] Batch Id
|
295
297
|
# @param [Hash] opts the optional parameters
|
296
|
-
# @return [
|
297
|
-
def
|
298
|
-
data, _status_code, _headers =
|
298
|
+
# @return [QueryBatchResponse2]
|
299
|
+
def query_batch_status_v3(batch_id, opts = {})
|
300
|
+
data, _status_code, _headers = query_batch_status_v3_with_http_info(batch_id, opts)
|
299
301
|
data
|
300
302
|
end
|
301
303
|
|
@@ -303,17 +305,17 @@ module VeloPayments
|
|
303
305
|
# Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
|
304
306
|
# @param batch_id [String] Batch Id
|
305
307
|
# @param [Hash] opts the optional parameters
|
306
|
-
# @return [Array<(
|
307
|
-
def
|
308
|
+
# @return [Array<(QueryBatchResponse2, Integer, Hash)>] QueryBatchResponse2 data, response status code and response headers
|
309
|
+
def query_batch_status_v3_with_http_info(batch_id, opts = {})
|
308
310
|
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
311
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v3 ...'
|
310
312
|
end
|
311
313
|
# verify the required parameter 'batch_id' is set
|
312
314
|
if @api_client.config.client_side_validation && batch_id.nil?
|
313
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.
|
315
|
+
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v3"
|
314
316
|
end
|
315
317
|
# resource path
|
316
|
-
local_var_path = '/
|
318
|
+
local_var_path = '/v3/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
|
317
319
|
|
318
320
|
# query parameters
|
319
321
|
query_params = opts[:query_params] || {}
|
@@ -330,7 +332,7 @@ module VeloPayments
|
|
330
332
|
post_body = opts[:body]
|
331
333
|
|
332
334
|
# return_type
|
333
|
-
return_type = opts[:return_type] || '
|
335
|
+
return_type = opts[:return_type] || 'QueryBatchResponse2'
|
334
336
|
|
335
337
|
# auth_names
|
336
338
|
auth_names = opts[:auth_names] || ['OAuth2']
|
@@ -346,36 +348,172 @@ module VeloPayments
|
|
346
348
|
|
347
349
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
348
350
|
if @api_client.config.debugging
|
349
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
351
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#query_batch_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
352
|
+
end
|
353
|
+
return data, status_code, headers
|
354
|
+
end
|
355
|
+
|
356
|
+
# Resend Payee Invite
|
357
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
|
358
|
+
# @param payee_id [String] The UUID of the payee.
|
359
|
+
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @return [nil]
|
362
|
+
def resend_payee_invite_v1(payee_id, invite_payee_request, opts = {})
|
363
|
+
resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts)
|
364
|
+
nil
|
365
|
+
end
|
366
|
+
|
367
|
+
# Resend Payee Invite
|
368
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
|
369
|
+
# @param payee_id [String] The UUID of the payee.
|
370
|
+
# @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request
|
371
|
+
# @param [Hash] opts the optional parameters
|
372
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
373
|
+
def resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts = {})
|
374
|
+
if @api_client.config.debugging
|
375
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v1 ...'
|
376
|
+
end
|
377
|
+
# verify the required parameter 'payee_id' is set
|
378
|
+
if @api_client.config.client_side_validation && payee_id.nil?
|
379
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v1"
|
380
|
+
end
|
381
|
+
# verify the required parameter 'invite_payee_request' is set
|
382
|
+
if @api_client.config.client_side_validation && invite_payee_request.nil?
|
383
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite_v1"
|
384
|
+
end
|
385
|
+
# resource path
|
386
|
+
local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
387
|
+
|
388
|
+
# query parameters
|
389
|
+
query_params = opts[:query_params] || {}
|
390
|
+
|
391
|
+
# header parameters
|
392
|
+
header_params = opts[:header_params] || {}
|
393
|
+
# HTTP header 'Accept' (if needed)
|
394
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
395
|
+
# HTTP header 'Content-Type'
|
396
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
397
|
+
|
398
|
+
# form parameters
|
399
|
+
form_params = opts[:form_params] || {}
|
400
|
+
|
401
|
+
# http body (model)
|
402
|
+
post_body = opts[:body] || @api_client.object_to_http_body(invite_payee_request)
|
403
|
+
|
404
|
+
# return_type
|
405
|
+
return_type = opts[:return_type]
|
406
|
+
|
407
|
+
# auth_names
|
408
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
409
|
+
|
410
|
+
new_options = opts.merge(
|
411
|
+
:header_params => header_params,
|
412
|
+
:query_params => query_params,
|
413
|
+
:form_params => form_params,
|
414
|
+
:body => post_body,
|
415
|
+
:auth_names => auth_names,
|
416
|
+
:return_type => return_type
|
417
|
+
)
|
418
|
+
|
419
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
420
|
+
if @api_client.config.debugging
|
421
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
350
422
|
end
|
351
423
|
return data, status_code, headers
|
352
424
|
end
|
353
425
|
|
354
|
-
#
|
426
|
+
# Resend Payee Invite
|
427
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
428
|
+
# @param payee_id [String] The UUID of the payee.
|
429
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
430
|
+
# @param [Hash] opts the optional parameters
|
431
|
+
# @return [nil]
|
432
|
+
def resend_payee_invite_v3(payee_id, invite_payee_request2, opts = {})
|
433
|
+
resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts)
|
434
|
+
nil
|
435
|
+
end
|
436
|
+
|
437
|
+
# Resend Payee Invite
|
438
|
+
# <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
|
439
|
+
# @param payee_id [String] The UUID of the payee.
|
440
|
+
# @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request
|
441
|
+
# @param [Hash] opts the optional parameters
|
442
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
443
|
+
def resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts = {})
|
444
|
+
if @api_client.config.debugging
|
445
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v3 ...'
|
446
|
+
end
|
447
|
+
# verify the required parameter 'payee_id' is set
|
448
|
+
if @api_client.config.client_side_validation && payee_id.nil?
|
449
|
+
fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
450
|
+
end
|
451
|
+
# verify the required parameter 'invite_payee_request2' is set
|
452
|
+
if @api_client.config.client_side_validation && invite_payee_request2.nil?
|
453
|
+
fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.resend_payee_invite_v3"
|
454
|
+
end
|
455
|
+
# resource path
|
456
|
+
local_var_path = '/v3/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
|
457
|
+
|
458
|
+
# query parameters
|
459
|
+
query_params = opts[:query_params] || {}
|
460
|
+
|
461
|
+
# header parameters
|
462
|
+
header_params = opts[:header_params] || {}
|
463
|
+
# HTTP header 'Accept' (if needed)
|
464
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
465
|
+
# HTTP header 'Content-Type'
|
466
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
467
|
+
|
468
|
+
# form parameters
|
469
|
+
form_params = opts[:form_params] || {}
|
470
|
+
|
471
|
+
# http body (model)
|
472
|
+
post_body = opts[:body] || @api_client.object_to_http_body(invite_payee_request2)
|
473
|
+
|
474
|
+
# return_type
|
475
|
+
return_type = opts[:return_type]
|
476
|
+
|
477
|
+
# auth_names
|
478
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
479
|
+
|
480
|
+
new_options = opts.merge(
|
481
|
+
:header_params => header_params,
|
482
|
+
:query_params => query_params,
|
483
|
+
:form_params => form_params,
|
484
|
+
:body => post_body,
|
485
|
+
:auth_names => auth_names,
|
486
|
+
:return_type => return_type
|
487
|
+
)
|
488
|
+
|
489
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
490
|
+
if @api_client.config.debugging
|
491
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
492
|
+
end
|
493
|
+
return data, status_code, headers
|
494
|
+
end
|
495
|
+
|
496
|
+
# Initiate Payee Creation
|
355
497
|
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
|
356
|
-
# @param create_payees_request2 [CreatePayeesRequest2] Post payees to create.
|
357
498
|
# @param [Hash] opts the optional parameters
|
358
|
-
# @
|
359
|
-
|
360
|
-
|
499
|
+
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
500
|
+
# @return [CreatePayeesCSVResponse]
|
501
|
+
def v2_create_payee(opts = {})
|
502
|
+
data, _status_code, _headers = v2_create_payee_with_http_info(opts)
|
361
503
|
data
|
362
504
|
end
|
363
505
|
|
364
|
-
#
|
506
|
+
# Initiate Payee Creation
|
365
507
|
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
|
366
|
-
# @param create_payees_request2 [CreatePayeesRequest2] Post payees to create.
|
367
508
|
# @param [Hash] opts the optional parameters
|
368
|
-
# @
|
369
|
-
|
509
|
+
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
510
|
+
# @return [Array<(CreatePayeesCSVResponse, Integer, Hash)>] CreatePayeesCSVResponse data, response status code and response headers
|
511
|
+
def v2_create_payee_with_http_info(opts = {})
|
370
512
|
if @api_client.config.debugging
|
371
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
372
|
-
end
|
373
|
-
# verify the required parameter 'create_payees_request2' is set
|
374
|
-
if @api_client.config.client_side_validation && create_payees_request2.nil?
|
375
|
-
fail ArgumentError, "Missing the required parameter 'create_payees_request2' when calling PayeeInvitationApi.v3_create_payee"
|
513
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v2_create_payee ...'
|
376
514
|
end
|
377
515
|
# resource path
|
378
|
-
local_var_path = '/
|
516
|
+
local_var_path = '/v2/payees'
|
379
517
|
|
380
518
|
# query parameters
|
381
519
|
query_params = opts[:query_params] || {}
|
@@ -391,10 +529,10 @@ module VeloPayments
|
|
391
529
|
form_params = opts[:form_params] || {}
|
392
530
|
|
393
531
|
# http body (model)
|
394
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
532
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'create_payees_request'])
|
395
533
|
|
396
534
|
# return_type
|
397
|
-
return_type = opts[:return_type] || '
|
535
|
+
return_type = opts[:return_type] || 'CreatePayeesCSVResponse'
|
398
536
|
|
399
537
|
# auth_names
|
400
538
|
auth_names = opts[:auth_names] || ['OAuth2']
|
@@ -410,36 +548,32 @@ module VeloPayments
|
|
410
548
|
|
411
549
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
412
550
|
if @api_client.config.debugging
|
413
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
551
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v2_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
414
552
|
end
|
415
553
|
return data, status_code, headers
|
416
554
|
end
|
417
555
|
|
418
|
-
#
|
419
|
-
#
|
420
|
-
# @param batch_id [String] Batch Id
|
556
|
+
# Initiate Payee Creation
|
557
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
|
421
558
|
# @param [Hash] opts the optional parameters
|
422
|
-
# @
|
423
|
-
|
424
|
-
|
559
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
560
|
+
# @return [CreatePayeesCSVResponse2]
|
561
|
+
def v3_create_payee(opts = {})
|
562
|
+
data, _status_code, _headers = v3_create_payee_with_http_info(opts)
|
425
563
|
data
|
426
564
|
end
|
427
565
|
|
428
|
-
#
|
429
|
-
#
|
430
|
-
# @param batch_id [String] Batch Id
|
566
|
+
# Initiate Payee Creation
|
567
|
+
# Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
|
431
568
|
# @param [Hash] opts the optional parameters
|
432
|
-
# @
|
433
|
-
|
569
|
+
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
570
|
+
# @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers
|
571
|
+
def v3_create_payee_with_http_info(opts = {})
|
434
572
|
if @api_client.config.debugging
|
435
|
-
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.
|
436
|
-
end
|
437
|
-
# verify the required parameter 'batch_id' is set
|
438
|
-
if @api_client.config.client_side_validation && batch_id.nil?
|
439
|
-
fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.v3_query_batch_status"
|
573
|
+
@api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_create_payee ...'
|
440
574
|
end
|
441
575
|
# resource path
|
442
|
-
local_var_path = '/v3/payees
|
576
|
+
local_var_path = '/v3/payees'
|
443
577
|
|
444
578
|
# query parameters
|
445
579
|
query_params = opts[:query_params] || {}
|
@@ -448,15 +582,17 @@ module VeloPayments
|
|
448
582
|
header_params = opts[:header_params] || {}
|
449
583
|
# HTTP header 'Accept' (if needed)
|
450
584
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
585
|
+
# HTTP header 'Content-Type'
|
586
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
451
587
|
|
452
588
|
# form parameters
|
453
589
|
form_params = opts[:form_params] || {}
|
454
590
|
|
455
591
|
# http body (model)
|
456
|
-
post_body = opts[:body]
|
592
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'create_payees_request2'])
|
457
593
|
|
458
594
|
# return_type
|
459
|
-
return_type = opts[:return_type] || '
|
595
|
+
return_type = opts[:return_type] || 'CreatePayeesCSVResponse2'
|
460
596
|
|
461
597
|
# auth_names
|
462
598
|
auth_names = opts[:auth_names] || ['OAuth2']
|
@@ -470,9 +606,9 @@ module VeloPayments
|
|
470
606
|
:return_type => return_type
|
471
607
|
)
|
472
608
|
|
473
|
-
data, status_code, headers = @api_client.call_api(:
|
609
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
474
610
|
if @api_client.config.debugging
|
475
|
-
@api_client.config.logger.debug "API called: PayeeInvitationApi#
|
611
|
+
@api_client.config.logger.debug "API called: PayeeInvitationApi#v3_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
476
612
|
end
|
477
613
|
return data, status_code, headers
|
478
614
|
end
|