velopayments 2.11.73 → 2.14.90.pre.1
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/Gemfile.lock +1 -1
- data/Makefile +7 -1
- data/README.md +82 -26
- data/docs/Address.md +5 -5
- data/docs/AuthApi.md +65 -0
- data/docs/AuthResponse.md +25 -0
- data/docs/AutoTopUpConfig.md +21 -0
- data/docs/Company.md +3 -1
- data/docs/CreateIndividual.md +21 -0
- data/docs/CreatePayee.md +3 -25
- data/docs/CreatePayeeAddress.md +31 -0
- data/docs/CreatePayeesCSVRequest.md +17 -15
- data/docs/CreatePayoutRequest.md +1 -1
- data/docs/FundingManagerApi.md +180 -10
- data/docs/{FundingRequest.md → FundingRequestV1.md} +2 -2
- data/docs/{FundingRequest2.md → FundingRequestV2.md} +2 -2
- data/docs/FxSummaryV3.md +35 -0
- data/docs/{FxSummary.md → FxSummaryV4.md} +7 -7
- data/docs/GetFundingsResponseAllOf.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +23 -0
- data/docs/GetPaymentsForPayoutResponseV3Page.md +25 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +33 -0
- data/docs/GetPaymentsForPayoutResponseV4.md +23 -0
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +33 -0
- data/docs/GetPayoutsResponseV3.md +23 -0
- data/docs/GetPayoutsResponseV3Links.md +19 -0
- data/docs/GetPayoutsResponseV3Page.md +25 -0
- data/docs/GetPayoutsResponseV3Summary.md +25 -0
- data/docs/GetPayoutsResponseV4.md +23 -0
- data/docs/Individual.md +2 -2
- data/docs/{PaymentAuditCurrency.md → InvitationStatus.md} +2 -2
- data/docs/ListPaymentsResponse.md +4 -4
- data/docs/ListPaymentsResponsePage.md +25 -0
- data/docs/ListPaymentsResponseSummary.md +25 -0
- data/docs/ListSourceAccountResponse.md +2 -2
- data/docs/ListSourceAccountResponseLinks.md +19 -0
- data/docs/ListSourceAccountResponsePage.md +25 -0
- data/docs/ListSourceAccountResponseV2.md +21 -0
- data/docs/ListSourceAccountResponseV2Page.md +25 -0
- data/docs/Notifications.md +17 -0
- data/docs/PagedPayeeInvitationStatusResponse.md +21 -0
- data/docs/Payee.md +1 -3
- data/docs/PayeeDelta.md +29 -0
- data/docs/PayeeDeltaResponse.md +21 -0
- data/docs/PayeeDeltaResponseLinks.md +19 -0
- data/docs/PayeeDeltaResponsePage.md +25 -0
- data/docs/PayeeInvitationApi.md +68 -5
- data/docs/PayeeInvitationStatus.md +1 -1
- data/docs/PayeeInvitationStatusResponse.md +21 -0
- data/docs/PayeeResponse.md +3 -3
- data/docs/{GetPaymentsForPayoutResponseLinks.md → PayeeResponseLinks.md} +2 -2
- data/docs/{GetPaymentsForPayoutResponsePage.md → PayeeResponsePage.md} +2 -2
- data/docs/{GetPaymentsForPayoutResponseSummary.md → PayeeResponseSummary.md} +2 -2
- data/docs/PayeesApi.md +61 -0
- data/docs/PaymentAuditCurrencyV3.md +16 -0
- data/docs/PaymentAuditCurrencyV4.md +16 -0
- data/docs/PaymentAuditServiceApi.md +302 -6
- data/docs/PaymentEventResponseV3.md +39 -0
- data/docs/{PaymentEventResponse.md → PaymentEventResponseV4.md} +8 -8
- data/docs/PaymentInstruction.md +6 -6
- data/docs/PaymentResponseV3.md +81 -0
- data/docs/{PaymentResponse.md → PaymentResponseV4.md} +5 -5
- data/docs/PayorApplicationsApi.md +1 -1
- data/docs/PayorBrandingResponse.md +5 -5
- data/docs/PayorCreateApiKeyRequest.md +3 -3
- data/docs/PayorCreateApiKeyResponse.md +2 -2
- data/docs/PayorCreateApplicationRequest.md +2 -2
- data/docs/PayorEmailOptOutRequest.md +1 -1
- data/docs/PayorFundingBankDetailsUpdate.md +3 -3
- data/docs/PayorLinksResponse.md +19 -0
- data/docs/PayorLinksResponseLinks.md +23 -0
- data/docs/PayorLinksResponsePayors.md +23 -0
- data/docs/PayorRef.md +2 -2
- data/docs/{Payor.md → PayorV1.md} +15 -15
- data/docs/PayorV2.md +49 -0
- data/docs/PayorsApi.md +116 -6
- data/docs/PayoutHistoryApi.md +81 -2
- data/docs/{PayoutStatus.md → PayoutStatusV3.md} +2 -2
- data/docs/PayoutStatusV4.md +16 -0
- data/docs/PayoutSummaryAuditV3.md +41 -0
- data/docs/{PayoutSummaryAudit.md → PayoutSummaryAuditV4.md} +9 -7
- data/docs/PayoutSummaryResponse.md +4 -4
- data/docs/QuoteFxSummary.md +10 -10
- data/docs/RejectedPayment.md +10 -8
- data/docs/SetNotificationsRequest.md +17 -0
- data/docs/SourceAccount.md +3 -3
- data/docs/SourceAccountResponse.md +11 -9
- data/docs/SourceAccountResponseV2.md +45 -0
- data/docs/SourceAccountSummaryV3.md +21 -0
- data/docs/SourceAccountSummaryV4.md +21 -0
- data/docs/SubmitPayoutApi.md +2 -2
- data/docs/SupportedCountry.md +2 -2
- data/lib/velopayments.rb +58 -18
- data/lib/velopayments/api/auth_api.rb +88 -0
- data/lib/velopayments/api/countries_api.rb +35 -17
- data/lib/velopayments/api/currencies_api.rb +19 -10
- data/lib/velopayments/api/funding_manager_api.rb +323 -69
- data/lib/velopayments/api/get_payout_api.rb +20 -11
- data/lib/velopayments/api/instruct_payout_api.rb +21 -11
- data/lib/velopayments/api/payee_invitation_api.rb +150 -40
- data/lib/velopayments/api/payees_api.rb +130 -26
- data/lib/velopayments/api/payment_audit_service_api.rb +481 -55
- data/lib/velopayments/api/payor_applications_api.rb +40 -21
- data/lib/velopayments/api/payors_api.rb +209 -43
- data/lib/velopayments/api/payout_history_api.rb +141 -21
- data/lib/velopayments/api/quote_payout_api.rb +20 -11
- data/lib/velopayments/api/submit_payout_api.rb +22 -12
- data/lib/velopayments/api/withdraw_payout_api.rb +21 -11
- data/lib/velopayments/api_client.rb +3 -4
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +7 -6
- data/lib/velopayments/models/address.rb +2 -2
- data/lib/velopayments/models/auth_response.rb +242 -0
- data/lib/velopayments/models/auto_top_up_config.rb +222 -0
- data/lib/velopayments/models/challenge.rb +2 -2
- data/lib/velopayments/models/company.rb +39 -6
- data/lib/velopayments/models/create_individual.rb +249 -0
- data/lib/velopayments/models/create_payee.rb +7 -109
- data/lib/velopayments/models/create_payee_address.rb +478 -0
- data/lib/velopayments/models/create_payees_csv_request.rb +268 -183
- data/lib/velopayments/models/create_payees_csv_response.rb +2 -2
- data/lib/velopayments/models/create_payees_request.rb +2 -2
- data/lib/velopayments/models/create_payment_channel.rb +9 -15
- data/lib/velopayments/models/create_payout_request.rb +2 -2
- data/lib/velopayments/models/failed_submission.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +2 -2
- data/lib/velopayments/models/funding_event.rb +2 -2
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/{funding_request.rb → funding_request_v1.rb} +5 -5
- data/lib/velopayments/models/{funding_request2.rb → funding_request_v2.rb} +5 -5
- data/lib/velopayments/models/{fx_summary.rb → fx_summary_v3.rb} +7 -7
- data/lib/velopayments/models/fx_summary_v4.rb +363 -0
- data/lib/velopayments/models/get_fundings_response.rb +3 -2
- data/lib/velopayments/models/get_fundings_response_all_of.rb +196 -0
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +228 -0
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +232 -0
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +311 -0
- data/lib/velopayments/models/{get_payments_for_payout_response.rb → get_payments_for_payout_response_v4.rb} +9 -9
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +311 -0
- data/lib/velopayments/models/get_payout_statistics.rb +2 -2
- data/lib/velopayments/models/{get_payouts_response.rb → get_payouts_response_v3.rb} +9 -9
- data/lib/velopayments/models/{get_payments_for_payout_response_links.rb → get_payouts_response_v3_links.rb} +5 -5
- data/lib/velopayments/models/{get_payments_for_payout_response_page.rb → get_payouts_response_v3_page.rb} +5 -5
- data/lib/velopayments/models/{get_payments_for_payout_response_summary.rb → get_payouts_response_v3_summary.rb} +5 -5
- data/lib/velopayments/models/get_payouts_response_v4.rb +228 -0
- data/lib/velopayments/models/individual.rb +6 -4
- data/lib/velopayments/models/individual_name.rb +2 -2
- data/lib/velopayments/models/invitation_status.rb +37 -0
- data/lib/velopayments/models/invitation_status_response.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +2 -2
- data/lib/velopayments/models/language.rb +2 -2
- data/lib/velopayments/models/list_payments_response.rb +6 -6
- data/lib/velopayments/models/list_payments_response_page.rb +232 -0
- data/lib/velopayments/models/list_payments_response_summary.rb +232 -0
- data/lib/velopayments/models/list_source_account_response.rb +4 -4
- data/lib/velopayments/models/{social.rb → list_source_account_response_links.rb} +18 -27
- data/lib/velopayments/models/list_source_account_response_page.rb +232 -0
- data/lib/velopayments/models/list_source_account_response_v2.rb +219 -0
- data/lib/velopayments/models/list_source_account_response_v2_page.rb +232 -0
- data/lib/velopayments/models/marketing_opt_in.rb +2 -2
- data/lib/velopayments/models/notifications.rb +196 -0
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +219 -0
- data/lib/velopayments/models/paged_response.rb +2 -2
- data/lib/velopayments/models/paged_response_page.rb +2 -2
- data/lib/velopayments/models/payee.rb +6 -15
- data/lib/velopayments/models/payee_delta.rb +288 -0
- data/lib/velopayments/models/payee_delta_response.rb +219 -0
- data/lib/velopayments/models/payee_delta_response_links.rb +205 -0
- data/lib/velopayments/models/payee_delta_response_page.rb +232 -0
- data/lib/velopayments/models/payee_invitation_status.rb +2 -2
- data/lib/velopayments/models/payee_invitation_status_response.rb +224 -0
- data/lib/velopayments/models/payee_response.rb +5 -5
- data/lib/velopayments/models/payee_response_links.rb +205 -0
- data/lib/velopayments/models/payee_response_page.rb +232 -0
- data/lib/velopayments/models/payee_response_summary.rb +232 -0
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/{payment_audit_currency.rb → payment_audit_currency_v3.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v4.rb +37 -0
- data/lib/velopayments/models/payment_channel.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +2 -2
- data/lib/velopayments/models/payment_channel_rule.rb +2 -2
- data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
- data/lib/velopayments/models/{payment_event_response.rb → payment_event_response_v3.rb} +9 -9
- data/lib/velopayments/models/payment_event_response_v4.rb +351 -0
- data/lib/velopayments/models/payment_instruction.rb +2 -2
- data/lib/velopayments/models/{payment_response.rb → payment_response_v3.rb} +8 -8
- data/lib/velopayments/models/payment_response_v4.rb +587 -0
- data/lib/velopayments/models/payor_branding_response.rb +2 -2
- data/lib/velopayments/models/payor_create_api_key_request.rb +2 -2
- data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
- data/lib/velopayments/models/payor_create_application_request.rb +2 -2
- data/lib/velopayments/models/payor_email_opt_out_request.rb +7 -2
- data/lib/velopayments/models/payor_funding_bank_details_update.rb +2 -2
- data/lib/velopayments/models/payor_links_response.rb +210 -0
- data/lib/velopayments/models/payor_links_response_links.rb +277 -0
- data/lib/velopayments/models/payor_links_response_payors.rb +267 -0
- data/lib/velopayments/models/payor_logo_request.rb +2 -2
- data/lib/velopayments/models/payor_ref.rb +2 -2
- data/lib/velopayments/models/{payor.rb → payor_v1.rb} +6 -6
- data/lib/velopayments/models/payor_v2.rb +405 -0
- data/lib/velopayments/models/{payout_status.rb → payout_status_v3.rb} +5 -5
- data/lib/velopayments/models/payout_status_v4.rb +43 -0
- data/lib/velopayments/models/{payout_summary_audit.rb → payout_summary_audit_v3.rb} +18 -9
- data/lib/velopayments/models/payout_summary_audit_v4.rb +323 -0
- data/lib/velopayments/models/payout_summary_response.rb +2 -2
- data/lib/velopayments/models/query_batch_response.rb +2 -2
- data/lib/velopayments/models/quote_fx_summary.rb +4 -4
- data/lib/velopayments/models/quote_response.rb +2 -2
- data/lib/velopayments/models/rejected_payment.rb +37 -34
- data/lib/velopayments/models/set_notifications_request.rb +230 -0
- data/lib/velopayments/models/source_account.rb +2 -2
- data/lib/velopayments/models/source_account_response.rb +16 -7
- data/lib/velopayments/models/source_account_response_v2.rb +403 -0
- data/lib/velopayments/models/{source_account_summary.rb → source_account_summary_v3.rb} +7 -7
- data/lib/velopayments/models/source_account_summary_v4.rb +224 -0
- data/lib/velopayments/models/supported_countries_response.rb +2 -2
- data/lib/velopayments/models/supported_country.rb +36 -2
- data/lib/velopayments/models/supported_currency.rb +2 -2
- data/lib/velopayments/models/supported_currency_response.rb +2 -2
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/auth_api_spec.rb +48 -0
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +45 -4
- data/spec/api/get_payout_api_spec.rb +2 -2
- data/spec/api/instruct_payout_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +20 -4
- data/spec/api/payees_api_spec.rb +17 -2
- data/spec/api/payment_audit_service_api_spec.rb +91 -5
- data/spec/api/payor_applications_api_spec.rb +3 -3
- data/spec/api/payors_api_spec.rb +31 -6
- data/spec/api/payout_history_api_spec.rb +27 -3
- data/spec/api/quote_payout_api_spec.rb +2 -2
- data/spec/api/submit_payout_api_spec.rb +3 -3
- data/spec/api/withdraw_payout_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/address_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +65 -0
- data/spec/models/{social_spec.rb → auto_top_up_config_spec.rb} +11 -11
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company_spec.rb +8 -2
- data/spec/models/create_individual_spec.rb +53 -0
- data/spec/models/create_payee_address_spec.rb +83 -0
- data/spec/models/create_payee_spec.rb +2 -68
- data/spec/models/create_payees_csv_request_spec.rb +26 -16
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +6 -2
- data/spec/models/create_payout_request_spec.rb +2 -2
- data/spec/models/failed_submission_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_request2_spec.rb → funding_request_v1_spec.rb} +8 -8
- data/spec/models/{funding_request_spec.rb → funding_request_v2_spec.rb} +8 -8
- data/spec/models/{fx_summary_spec.rb → fx_summary_v3_spec.rb} +8 -8
- data/spec/models/fx_summary_v4_spec.rb +103 -0
- data/spec/models/get_fundings_response_all_of_spec.rb +41 -0
- data/spec/models/get_fundings_response_spec.rb +2 -2
- data/spec/models/{get_payments_for_payout_response_page_spec.rb → get_payments_for_payout_response_v3_page_spec.rb} +8 -8
- data/spec/models/{get_payments_for_payout_response_spec.rb → get_payments_for_payout_response_v3_spec.rb} +8 -8
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +93 -0
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +59 -0
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +93 -0
- data/spec/models/get_payout_statistics_spec.rb +2 -2
- data/spec/models/get_payouts_response_v3_links_spec.rb +47 -0
- data/spec/models/get_payouts_response_v3_page_spec.rb +65 -0
- data/spec/models/{get_payouts_response_spec.rb → get_payouts_response_v3_spec.rb} +8 -8
- data/spec/models/{get_payments_for_payout_response_summary_spec.rb → get_payouts_response_v3_summary_spec.rb} +8 -8
- data/spec/models/get_payouts_response_v4_spec.rb +59 -0
- data/spec/models/individual_name_spec.rb +2 -2
- data/spec/models/individual_spec.rb +2 -2
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +35 -0
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/list_payments_response_page_spec.rb +65 -0
- data/spec/models/list_payments_response_spec.rb +2 -2
- data/spec/models/list_payments_response_summary_spec.rb +65 -0
- data/spec/models/{get_payments_for_payout_response_links_spec.rb → list_source_account_response_links_spec.rb} +8 -8
- data/spec/models/list_source_account_response_page_spec.rb +65 -0
- data/spec/models/list_source_account_response_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_page_spec.rb +65 -0
- data/spec/models/list_source_account_response_v2_spec.rb +53 -0
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/notifications_spec.rb +41 -0
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_spec.rb +53 -0
- data/spec/models/paged_response_page_spec.rb +2 -2
- data/spec/models/paged_response_spec.rb +2 -2
- data/spec/models/payee_delta_response_links_spec.rb +47 -0
- data/spec/models/payee_delta_response_page_spec.rb +65 -0
- data/spec/models/payee_delta_response_spec.rb +53 -0
- data/spec/models/payee_delta_spec.rb +77 -0
- data/spec/models/payee_invitation_status_response_spec.rb +53 -0
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_response_links_spec.rb +47 -0
- data/spec/models/payee_response_page_spec.rb +65 -0
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_summary_spec.rb +65 -0
- data/spec/models/payee_spec.rb +2 -8
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/{payment_audit_currency_spec.rb → payment_audit_currency_v3_spec.rb} +8 -8
- data/spec/models/payment_audit_currency_v4_spec.rb +35 -0
- 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_channel_spec.rb +2 -2
- data/spec/models/{payment_event_response_spec.rb → payment_event_response_v3_spec.rb} +8 -8
- data/spec/models/payment_event_response_v4_spec.rb +111 -0
- data/spec/models/payment_instruction_spec.rb +2 -2
- data/spec/models/{payment_response_spec.rb → payment_response_v3_spec.rb} +8 -8
- data/spec/models/payment_response_v4_spec.rb +241 -0
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_funding_bank_details_update_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +63 -0
- data/spec/models/payor_links_response_payors_spec.rb +63 -0
- data/spec/models/payor_links_response_spec.rb +47 -0
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_ref_spec.rb +2 -2
- data/spec/models/{payor_spec.rb → payor_v1_spec.rb} +8 -8
- data/spec/models/payor_v2_spec.rb +145 -0
- data/spec/models/{payout_status_spec.rb → payout_status_v3_spec.rb} +8 -8
- data/spec/models/payout_status_v4_spec.rb +35 -0
- data/spec/models/{payout_summary_audit_spec.rb → payout_summary_audit_v3_spec.rb} +14 -8
- data/spec/models/payout_summary_audit_v4_spec.rb +113 -0
- data/spec/models/payout_summary_response_spec.rb +2 -2
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/quote_fx_summary_spec.rb +2 -2
- data/spec/models/quote_response_spec.rb +2 -2
- data/spec/models/rejected_payment_spec.rb +8 -6
- data/spec/models/set_notifications_request_spec.rb +41 -0
- data/spec/models/source_account_response_spec.rb +8 -2
- data/spec/models/source_account_response_v2_spec.rb +129 -0
- data/spec/models/source_account_spec.rb +2 -2
- data/spec/models/{source_account_summary_spec.rb → source_account_summary_v3_spec.rb} +8 -8
- data/spec/models/source_account_summary_v4_spec.rb +53 -0
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/supported_country_spec.rb +10 -2
- data/spec/models/supported_currency_response_spec.rb +2 -2
- data/spec/models/supported_currency_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/velopayments-2.11.73.gem +0 -0
- data/velopayments-2.14.90.gem +0 -0
- data/velopayments.gemspec +2 -2
- metadata +230 -68
- data/docs/GetPaymentsForPayoutResponse.md +0 -23
- data/docs/GetPayoutsResponse.md +0 -23
- data/docs/Social.md +0 -21
- data/docs/SourceAccountSummary.md +0 -21
@@ -3,14 +3,14 @@
|
|
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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.14.92
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require '
|
13
|
+
require 'cgi'
|
14
14
|
|
15
15
|
module VeloPayments
|
16
16
|
class FundingManagerApi
|
@@ -22,21 +22,21 @@ module VeloPayments
|
|
22
22
|
# Create Funding Request
|
23
23
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
24
24
|
# @param source_account_id [String] Source account id
|
25
|
-
# @param
|
25
|
+
# @param funding_request_v1 [FundingRequestV1] Body to included ammount to be funded
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [nil]
|
28
|
-
def create_ach_funding_request(source_account_id,
|
29
|
-
create_ach_funding_request_with_http_info(source_account_id,
|
28
|
+
def create_ach_funding_request(source_account_id, funding_request_v1, opts = {})
|
29
|
+
create_ach_funding_request_with_http_info(source_account_id, funding_request_v1, opts)
|
30
30
|
nil
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create Funding Request
|
34
34
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
35
35
|
# @param source_account_id [String] Source account id
|
36
|
-
# @param
|
36
|
+
# @param funding_request_v1 [FundingRequestV1] Body to included ammount to be funded
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
|
-
def create_ach_funding_request_with_http_info(source_account_id,
|
39
|
+
def create_ach_funding_request_with_http_info(source_account_id, funding_request_v1, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.create_ach_funding_request ...'
|
42
42
|
end
|
@@ -44,35 +44,43 @@ module VeloPayments
|
|
44
44
|
if @api_client.config.client_side_validation && source_account_id.nil?
|
45
45
|
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.create_ach_funding_request"
|
46
46
|
end
|
47
|
-
# verify the required parameter '
|
48
|
-
if @api_client.config.client_side_validation &&
|
49
|
-
fail ArgumentError, "Missing the required parameter '
|
47
|
+
# verify the required parameter 'funding_request_v1' is set
|
48
|
+
if @api_client.config.client_side_validation && funding_request_v1.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'funding_request_v1' when calling FundingManagerApi.create_ach_funding_request"
|
50
50
|
end
|
51
51
|
# resource path
|
52
|
-
local_var_path = '/v1/sourceAccounts/{sourceAccountId}/achFundingRequest'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
|
52
|
+
local_var_path = '/v1/sourceAccounts/{sourceAccountId}/achFundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
|
53
53
|
|
54
54
|
# query parameters
|
55
|
-
query_params = {}
|
55
|
+
query_params = opts[:query_params] || {}
|
56
56
|
|
57
57
|
# header parameters
|
58
|
-
header_params = {}
|
59
|
-
# HTTP header 'Accept' (if needed)
|
60
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
|
+
header_params = opts[:header_params] || {}
|
61
59
|
# HTTP header 'Content-Type'
|
62
60
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
63
61
|
|
64
62
|
# form parameters
|
65
|
-
form_params = {}
|
63
|
+
form_params = opts[:form_params] || {}
|
66
64
|
|
67
65
|
# http body (model)
|
68
|
-
post_body = @api_client.object_to_http_body(
|
69
|
-
|
70
|
-
|
66
|
+
post_body = opts[:body] || @api_client.object_to_http_body(funding_request_v1)
|
67
|
+
|
68
|
+
# return_type
|
69
|
+
return_type = opts[:return_type]
|
70
|
+
|
71
|
+
# auth_names
|
72
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
73
|
+
|
74
|
+
new_options = opts.merge(
|
71
75
|
:header_params => header_params,
|
72
76
|
:query_params => query_params,
|
73
77
|
:form_params => form_params,
|
74
78
|
:body => post_body,
|
75
|
-
:auth_names => auth_names
|
79
|
+
:auth_names => auth_names,
|
80
|
+
:return_type => return_type
|
81
|
+
)
|
82
|
+
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
84
|
if @api_client.config.debugging
|
77
85
|
@api_client.config.logger.debug "API called: FundingManagerApi#create_ach_funding_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
86
|
end
|
@@ -82,21 +90,21 @@ module VeloPayments
|
|
82
90
|
# Create Funding Request
|
83
91
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
84
92
|
# @param source_account_id [String] Source account id
|
85
|
-
# @param
|
93
|
+
# @param funding_request_v2 [FundingRequestV2] Body to included ammount to be funded
|
86
94
|
# @param [Hash] opts the optional parameters
|
87
95
|
# @return [nil]
|
88
|
-
def create_funding_request(source_account_id,
|
89
|
-
create_funding_request_with_http_info(source_account_id,
|
96
|
+
def create_funding_request(source_account_id, funding_request_v2, opts = {})
|
97
|
+
create_funding_request_with_http_info(source_account_id, funding_request_v2, opts)
|
90
98
|
nil
|
91
99
|
end
|
92
100
|
|
93
101
|
# Create Funding Request
|
94
102
|
# Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
|
95
103
|
# @param source_account_id [String] Source account id
|
96
|
-
# @param
|
104
|
+
# @param funding_request_v2 [FundingRequestV2] Body to included ammount to be funded
|
97
105
|
# @param [Hash] opts the optional parameters
|
98
106
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
99
|
-
def create_funding_request_with_http_info(source_account_id,
|
107
|
+
def create_funding_request_with_http_info(source_account_id, funding_request_v2, opts = {})
|
100
108
|
if @api_client.config.debugging
|
101
109
|
@api_client.config.logger.debug 'Calling API: FundingManagerApi.create_funding_request ...'
|
102
110
|
end
|
@@ -104,35 +112,43 @@ module VeloPayments
|
|
104
112
|
if @api_client.config.client_side_validation && source_account_id.nil?
|
105
113
|
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.create_funding_request"
|
106
114
|
end
|
107
|
-
# verify the required parameter '
|
108
|
-
if @api_client.config.client_side_validation &&
|
109
|
-
fail ArgumentError, "Missing the required parameter '
|
115
|
+
# verify the required parameter 'funding_request_v2' is set
|
116
|
+
if @api_client.config.client_side_validation && funding_request_v2.nil?
|
117
|
+
fail ArgumentError, "Missing the required parameter 'funding_request_v2' when calling FundingManagerApi.create_funding_request"
|
110
118
|
end
|
111
119
|
# resource path
|
112
|
-
local_var_path = '/v2/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
|
120
|
+
local_var_path = '/v2/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
|
113
121
|
|
114
122
|
# query parameters
|
115
|
-
query_params = {}
|
123
|
+
query_params = opts[:query_params] || {}
|
116
124
|
|
117
125
|
# header parameters
|
118
|
-
header_params = {}
|
119
|
-
# HTTP header 'Accept' (if needed)
|
120
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
126
|
+
header_params = opts[:header_params] || {}
|
121
127
|
# HTTP header 'Content-Type'
|
122
128
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
123
129
|
|
124
130
|
# form parameters
|
125
|
-
form_params = {}
|
131
|
+
form_params = opts[:form_params] || {}
|
126
132
|
|
127
133
|
# http body (model)
|
128
|
-
post_body = @api_client.object_to_http_body(
|
129
|
-
|
130
|
-
|
134
|
+
post_body = opts[:body] || @api_client.object_to_http_body(funding_request_v2)
|
135
|
+
|
136
|
+
# return_type
|
137
|
+
return_type = opts[:return_type]
|
138
|
+
|
139
|
+
# auth_names
|
140
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
141
|
+
|
142
|
+
new_options = opts.merge(
|
131
143
|
:header_params => header_params,
|
132
144
|
:query_params => query_params,
|
133
145
|
:form_params => form_params,
|
134
146
|
:body => post_body,
|
135
|
-
:auth_names => auth_names
|
147
|
+
:auth_names => auth_names,
|
148
|
+
:return_type => return_type
|
149
|
+
)
|
150
|
+
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
136
152
|
if @api_client.config.debugging
|
137
153
|
@api_client.config.logger.debug "API called: FundingManagerApi#create_funding_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
138
154
|
end
|
@@ -168,30 +184,39 @@ module VeloPayments
|
|
168
184
|
local_var_path = '/v1/paymentaudit/fundings'
|
169
185
|
|
170
186
|
# query parameters
|
171
|
-
query_params = {}
|
187
|
+
query_params = opts[:query_params] || {}
|
172
188
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
173
189
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
174
190
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
175
191
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
176
192
|
|
177
193
|
# header parameters
|
178
|
-
header_params = {}
|
194
|
+
header_params = opts[:header_params] || {}
|
179
195
|
# HTTP header 'Accept' (if needed)
|
180
196
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
181
197
|
|
182
198
|
# form parameters
|
183
|
-
form_params = {}
|
199
|
+
form_params = opts[:form_params] || {}
|
184
200
|
|
185
201
|
# http body (model)
|
186
|
-
post_body =
|
187
|
-
|
188
|
-
|
202
|
+
post_body = opts[:body]
|
203
|
+
|
204
|
+
# return_type
|
205
|
+
return_type = opts[:return_type] || 'GetFundingsResponse'
|
206
|
+
|
207
|
+
# auth_names
|
208
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
209
|
+
|
210
|
+
new_options = opts.merge(
|
189
211
|
:header_params => header_params,
|
190
212
|
:query_params => query_params,
|
191
213
|
:form_params => form_params,
|
192
214
|
:body => post_body,
|
193
215
|
:auth_names => auth_names,
|
194
|
-
:return_type =>
|
216
|
+
:return_type => return_type
|
217
|
+
)
|
218
|
+
|
219
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
195
220
|
if @api_client.config.debugging
|
196
221
|
@api_client.config.logger.debug "API called: FundingManagerApi#get_fundings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
222
|
end
|
@@ -222,35 +247,106 @@ module VeloPayments
|
|
222
247
|
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.get_source_account"
|
223
248
|
end
|
224
249
|
# resource path
|
225
|
-
local_var_path = '/v1/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
|
250
|
+
local_var_path = '/v1/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
|
226
251
|
|
227
252
|
# query parameters
|
228
|
-
query_params = {}
|
253
|
+
query_params = opts[:query_params] || {}
|
229
254
|
|
230
255
|
# header parameters
|
231
|
-
header_params = {}
|
256
|
+
header_params = opts[:header_params] || {}
|
232
257
|
# HTTP header 'Accept' (if needed)
|
233
258
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
234
259
|
|
235
260
|
# form parameters
|
236
|
-
form_params = {}
|
261
|
+
form_params = opts[:form_params] || {}
|
237
262
|
|
238
263
|
# http body (model)
|
239
|
-
post_body =
|
240
|
-
|
241
|
-
|
264
|
+
post_body = opts[:body]
|
265
|
+
|
266
|
+
# return_type
|
267
|
+
return_type = opts[:return_type] || 'SourceAccountResponse'
|
268
|
+
|
269
|
+
# auth_names
|
270
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
271
|
+
|
272
|
+
new_options = opts.merge(
|
242
273
|
:header_params => header_params,
|
243
274
|
:query_params => query_params,
|
244
275
|
:form_params => form_params,
|
245
276
|
:body => post_body,
|
246
277
|
:auth_names => auth_names,
|
247
|
-
:return_type =>
|
278
|
+
:return_type => return_type
|
279
|
+
)
|
280
|
+
|
281
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
248
282
|
if @api_client.config.debugging
|
249
283
|
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
250
284
|
end
|
251
285
|
return data, status_code, headers
|
252
286
|
end
|
253
287
|
|
288
|
+
# Get details about given source account.
|
289
|
+
# Get details about given source account.
|
290
|
+
# @param source_account_id [String] Source account id
|
291
|
+
# @param [Hash] opts the optional parameters
|
292
|
+
# @return [SourceAccountResponseV2]
|
293
|
+
def get_source_account_v2(source_account_id, opts = {})
|
294
|
+
data, _status_code, _headers = get_source_account_v2_with_http_info(source_account_id, opts)
|
295
|
+
data
|
296
|
+
end
|
297
|
+
|
298
|
+
# Get details about given source account.
|
299
|
+
# Get details about given source account.
|
300
|
+
# @param source_account_id [String] Source account id
|
301
|
+
# @param [Hash] opts the optional parameters
|
302
|
+
# @return [Array<(SourceAccountResponseV2, Integer, Hash)>] SourceAccountResponseV2 data, response status code and response headers
|
303
|
+
def get_source_account_v2_with_http_info(source_account_id, opts = {})
|
304
|
+
if @api_client.config.debugging
|
305
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_account_v2 ...'
|
306
|
+
end
|
307
|
+
# verify the required parameter 'source_account_id' is set
|
308
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
309
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.get_source_account_v2"
|
310
|
+
end
|
311
|
+
# resource path
|
312
|
+
local_var_path = '/v2/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
|
313
|
+
|
314
|
+
# query parameters
|
315
|
+
query_params = opts[:query_params] || {}
|
316
|
+
|
317
|
+
# header parameters
|
318
|
+
header_params = opts[:header_params] || {}
|
319
|
+
# HTTP header 'Accept' (if needed)
|
320
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
321
|
+
|
322
|
+
# form parameters
|
323
|
+
form_params = opts[:form_params] || {}
|
324
|
+
|
325
|
+
# http body (model)
|
326
|
+
post_body = opts[:body]
|
327
|
+
|
328
|
+
# return_type
|
329
|
+
return_type = opts[:return_type] || 'SourceAccountResponseV2'
|
330
|
+
|
331
|
+
# auth_names
|
332
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
333
|
+
|
334
|
+
new_options = opts.merge(
|
335
|
+
:header_params => header_params,
|
336
|
+
:query_params => query_params,
|
337
|
+
:form_params => form_params,
|
338
|
+
:body => post_body,
|
339
|
+
:auth_names => auth_names,
|
340
|
+
:return_type => return_type
|
341
|
+
)
|
342
|
+
|
343
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
344
|
+
if @api_client.config.debugging
|
345
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_account_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
346
|
+
end
|
347
|
+
return data, status_code, headers
|
348
|
+
end
|
349
|
+
|
254
350
|
# Get list of source accounts
|
255
351
|
# List source accounts.
|
256
352
|
# @param [Hash] opts the optional parameters
|
@@ -282,7 +378,7 @@ module VeloPayments
|
|
282
378
|
local_var_path = '/v1/sourceAccounts'
|
283
379
|
|
284
380
|
# query parameters
|
285
|
-
query_params = {}
|
381
|
+
query_params = opts[:query_params] || {}
|
286
382
|
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
|
287
383
|
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
288
384
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
@@ -290,29 +386,177 @@ module VeloPayments
|
|
290
386
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
291
387
|
|
292
388
|
# header parameters
|
293
|
-
header_params = {}
|
389
|
+
header_params = opts[:header_params] || {}
|
294
390
|
# HTTP header 'Accept' (if needed)
|
295
391
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
296
392
|
|
297
393
|
# form parameters
|
298
|
-
form_params = {}
|
394
|
+
form_params = opts[:form_params] || {}
|
299
395
|
|
300
396
|
# http body (model)
|
301
|
-
post_body =
|
302
|
-
|
303
|
-
|
397
|
+
post_body = opts[:body]
|
398
|
+
|
399
|
+
# return_type
|
400
|
+
return_type = opts[:return_type] || 'ListSourceAccountResponse'
|
401
|
+
|
402
|
+
# auth_names
|
403
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
404
|
+
|
405
|
+
new_options = opts.merge(
|
304
406
|
:header_params => header_params,
|
305
407
|
:query_params => query_params,
|
306
408
|
:form_params => form_params,
|
307
409
|
:body => post_body,
|
308
410
|
:auth_names => auth_names,
|
309
|
-
:return_type =>
|
411
|
+
:return_type => return_type
|
412
|
+
)
|
413
|
+
|
414
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
310
415
|
if @api_client.config.debugging
|
311
416
|
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
312
417
|
end
|
313
418
|
return data, status_code, headers
|
314
419
|
end
|
315
420
|
|
421
|
+
# Get list of source accounts
|
422
|
+
# List source accounts.
|
423
|
+
# @param [Hash] opts the optional parameters
|
424
|
+
# @option opts [String] :physical_account_name Physical Account Name
|
425
|
+
# @option opts [String] :payor_id The account owner Payor ID
|
426
|
+
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
427
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
|
428
|
+
# @option opts [String] :sort Sort String
|
429
|
+
# @return [ListSourceAccountResponseV2]
|
430
|
+
def get_source_accounts_v2(opts = {})
|
431
|
+
data, _status_code, _headers = get_source_accounts_v2_with_http_info(opts)
|
432
|
+
data
|
433
|
+
end
|
434
|
+
|
435
|
+
# Get list of source accounts
|
436
|
+
# List source accounts.
|
437
|
+
# @param [Hash] opts the optional parameters
|
438
|
+
# @option opts [String] :physical_account_name Physical Account Name
|
439
|
+
# @option opts [String] :payor_id The account owner Payor ID
|
440
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
441
|
+
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
|
442
|
+
# @option opts [String] :sort Sort String
|
443
|
+
# @return [Array<(ListSourceAccountResponseV2, Integer, Hash)>] ListSourceAccountResponseV2 data, response status code and response headers
|
444
|
+
def get_source_accounts_v2_with_http_info(opts = {})
|
445
|
+
if @api_client.config.debugging
|
446
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts_v2 ...'
|
447
|
+
end
|
448
|
+
# resource path
|
449
|
+
local_var_path = '/v2/sourceAccounts'
|
450
|
+
|
451
|
+
# query parameters
|
452
|
+
query_params = opts[:query_params] || {}
|
453
|
+
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
|
454
|
+
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
|
455
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
456
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
457
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
458
|
+
|
459
|
+
# header parameters
|
460
|
+
header_params = opts[:header_params] || {}
|
461
|
+
# HTTP header 'Accept' (if needed)
|
462
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
463
|
+
|
464
|
+
# form parameters
|
465
|
+
form_params = opts[:form_params] || {}
|
466
|
+
|
467
|
+
# http body (model)
|
468
|
+
post_body = opts[:body]
|
469
|
+
|
470
|
+
# return_type
|
471
|
+
return_type = opts[:return_type] || 'ListSourceAccountResponseV2'
|
472
|
+
|
473
|
+
# auth_names
|
474
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
475
|
+
|
476
|
+
new_options = opts.merge(
|
477
|
+
:header_params => header_params,
|
478
|
+
:query_params => query_params,
|
479
|
+
:form_params => form_params,
|
480
|
+
:body => post_body,
|
481
|
+
:auth_names => auth_names,
|
482
|
+
:return_type => return_type
|
483
|
+
)
|
484
|
+
|
485
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
486
|
+
if @api_client.config.debugging
|
487
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#get_source_accounts_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
488
|
+
end
|
489
|
+
return data, status_code, headers
|
490
|
+
end
|
491
|
+
|
492
|
+
# Set notifications
|
493
|
+
# Set notifications for a given source account
|
494
|
+
# @param source_account_id [String] Source account id
|
495
|
+
# @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
|
496
|
+
# @param [Hash] opts the optional parameters
|
497
|
+
# @return [nil]
|
498
|
+
def set_notifications_request(source_account_id, set_notifications_request, opts = {})
|
499
|
+
set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts)
|
500
|
+
nil
|
501
|
+
end
|
502
|
+
|
503
|
+
# Set notifications
|
504
|
+
# Set notifications for a given source account
|
505
|
+
# @param source_account_id [String] Source account id
|
506
|
+
# @param set_notifications_request [SetNotificationsRequest] Body to included minimum balance to set
|
507
|
+
# @param [Hash] opts the optional parameters
|
508
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
509
|
+
def set_notifications_request_with_http_info(source_account_id, set_notifications_request, opts = {})
|
510
|
+
if @api_client.config.debugging
|
511
|
+
@api_client.config.logger.debug 'Calling API: FundingManagerApi.set_notifications_request ...'
|
512
|
+
end
|
513
|
+
# verify the required parameter 'source_account_id' is set
|
514
|
+
if @api_client.config.client_side_validation && source_account_id.nil?
|
515
|
+
fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.set_notifications_request"
|
516
|
+
end
|
517
|
+
# verify the required parameter 'set_notifications_request' is set
|
518
|
+
if @api_client.config.client_side_validation && set_notifications_request.nil?
|
519
|
+
fail ArgumentError, "Missing the required parameter 'set_notifications_request' when calling FundingManagerApi.set_notifications_request"
|
520
|
+
end
|
521
|
+
# resource path
|
522
|
+
local_var_path = '/v1/sourceAccounts/{sourceAccountId}/notifications'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_id.to_s).gsub('%2F', '/'))
|
523
|
+
|
524
|
+
# query parameters
|
525
|
+
query_params = opts[:query_params] || {}
|
526
|
+
|
527
|
+
# header parameters
|
528
|
+
header_params = opts[:header_params] || {}
|
529
|
+
# HTTP header 'Content-Type'
|
530
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
531
|
+
|
532
|
+
# form parameters
|
533
|
+
form_params = opts[:form_params] || {}
|
534
|
+
|
535
|
+
# http body (model)
|
536
|
+
post_body = opts[:body] || @api_client.object_to_http_body(set_notifications_request)
|
537
|
+
|
538
|
+
# return_type
|
539
|
+
return_type = opts[:return_type]
|
540
|
+
|
541
|
+
# auth_names
|
542
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
543
|
+
|
544
|
+
new_options = opts.merge(
|
545
|
+
:header_params => header_params,
|
546
|
+
:query_params => query_params,
|
547
|
+
:form_params => form_params,
|
548
|
+
:body => post_body,
|
549
|
+
:auth_names => auth_names,
|
550
|
+
:return_type => return_type
|
551
|
+
)
|
552
|
+
|
553
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
554
|
+
if @api_client.config.debugging
|
555
|
+
@api_client.config.logger.debug "API called: FundingManagerApi#set_notifications_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
556
|
+
end
|
557
|
+
return data, status_code, headers
|
558
|
+
end
|
559
|
+
|
316
560
|
# Set Funding Bank Details
|
317
561
|
# This API allows you to set or update the funding details for the given Payor ID.
|
318
562
|
# @param payor_id [String] The account owner Payor ID
|
@@ -343,28 +587,38 @@ module VeloPayments
|
|
343
587
|
fail ArgumentError, "Missing the required parameter 'payor_funding_bank_details_update' when calling FundingManagerApi.set_payor_funding_bank_details"
|
344
588
|
end
|
345
589
|
# resource path
|
346
|
-
local_var_path = '/v1/payors/{payorId}/payorFundingBankDetailsUpdate'.sub('{' + 'payorId' + '}', payor_id.to_s)
|
590
|
+
local_var_path = '/v1/payors/{payorId}/payorFundingBankDetailsUpdate'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
|
347
591
|
|
348
592
|
# query parameters
|
349
|
-
query_params = {}
|
593
|
+
query_params = opts[:query_params] || {}
|
350
594
|
|
351
595
|
# header parameters
|
352
|
-
header_params = {}
|
596
|
+
header_params = opts[:header_params] || {}
|
353
597
|
# HTTP header 'Content-Type'
|
354
598
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
355
599
|
|
356
600
|
# form parameters
|
357
|
-
form_params = {}
|
601
|
+
form_params = opts[:form_params] || {}
|
358
602
|
|
359
603
|
# http body (model)
|
360
|
-
post_body = @api_client.object_to_http_body(payor_funding_bank_details_update)
|
361
|
-
|
362
|
-
|
604
|
+
post_body = opts[:body] || @api_client.object_to_http_body(payor_funding_bank_details_update)
|
605
|
+
|
606
|
+
# return_type
|
607
|
+
return_type = opts[:return_type]
|
608
|
+
|
609
|
+
# auth_names
|
610
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
611
|
+
|
612
|
+
new_options = opts.merge(
|
363
613
|
:header_params => header_params,
|
364
614
|
:query_params => query_params,
|
365
615
|
:form_params => form_params,
|
366
616
|
:body => post_body,
|
367
|
-
:auth_names => auth_names
|
617
|
+
:auth_names => auth_names,
|
618
|
+
:return_type => return_type
|
619
|
+
)
|
620
|
+
|
621
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
368
622
|
if @api_client.config.debugging
|
369
623
|
@api_client.config.logger.debug "API called: FundingManagerApi#set_payor_funding_bank_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
370
624
|
end
|