velopayments 2.20.119 → 2.23.78.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 +5 -5
- data/Makefile +5 -2
- data/README.md +116 -45
- data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +2 -2
- data/docs/AutoTopUpConfig2.md +23 -0
- data/docs/Challenge2.md +19 -0
- data/docs/CountriesApi.md +25 -25
- data/docs/CreateFundingAccountRequestV2.md +29 -0
- data/docs/CreatePayee2.md +3 -3
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +1 -1
- data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +3 -3
- data/docs/CreateWebhookRequest.md +23 -0
- data/docs/CurrenciesApi.md +6 -6
- data/docs/FundingAccountResponse.md +15 -7
- data/docs/FundingAccountResponse2.md +35 -0
- data/docs/{CurrencyType.md → FundingAccountType.md} +2 -3
- data/docs/FundingAudit.md +5 -5
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingManagerApi.md +329 -32
- data/docs/FundingManagerPrivateApi.md +7 -7
- data/docs/FundingPayorStatusAuditResponse.md +2 -2
- data/docs/FundingRequestV3.md +19 -0
- data/docs/FxSummaryV3.md +1 -1
- data/docs/FxSummaryV4.md +1 -1
- data/docs/GetFundingsResponse.md +5 -1
- data/docs/GetFundingsResponseLinks.md +19 -0
- data/docs/GetPayeeListResponse.md +49 -0
- data/docs/GetPayeeListResponseCompany.md +19 -0
- data/docs/GetPayeeListResponseIndividual.md +17 -0
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
- data/docs/InlineResponse404.md +19 -0
- data/docs/InlineResponse404Errors.md +23 -0
- data/docs/InlineResponse412.md +19 -0
- data/docs/InlineResponse412Errors.md +23 -0
- data/docs/{UserResponse2Roles.md → InvitationStatus2.md} +2 -3
- data/docs/ListFundingAccountsResponse2.md +21 -0
- data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
- data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
- data/docs/ListPaymentsResponseV4.md +1 -1
- data/docs/ListSourceAccountResponseV2.md +1 -1
- data/docs/ListSourceAccountResponseV2Links.md +19 -0
- data/docs/ListSourceAccountResponseV3.md +21 -0
- data/docs/ListSourceAccountResponseV3Links.md +19 -0
- data/docs/LoginApi.md +6 -2
- data/docs/MarketingOptIn.md +1 -1
- data/docs/Name.md +23 -0
- data/docs/Notifications2.md +17 -0
- data/docs/PagedPayeeResponse2.md +1 -1
- data/docs/PagedPaymentsResponseV3.md +21 -0
- data/docs/Payee.md +2 -2
- data/docs/Payee2.md +2 -2
- data/docs/{PayeeResponseV3.md → PayeeDetailResponse.md} +9 -7
- data/docs/PayeeDetailResponse2.md +73 -0
- data/docs/PayeeInvitationApi.md +227 -2
- data/docs/PayeePayorRef2.md +25 -0
- data/docs/PayeePayorRefV2.md +1 -1
- data/docs/PayeePayorRefV3.md +3 -3
- data/docs/PayeeResponse.md +2 -2
- data/docs/PayeeResponseV2.md +3 -3
- data/docs/PayeeType2.md +16 -0
- data/docs/PayeeUserSelfUpdateRequest.md +27 -0
- data/docs/PayeesApi.md +421 -8
- data/docs/PaymentAuditServiceApi.md +267 -35
- data/docs/PaymentDeltaResponseV4.md +21 -0
- data/docs/PaymentDeltaV4.md +31 -0
- data/docs/PaymentEventResponseV3.md +1 -1
- data/docs/PaymentEventResponseV4.md +1 -1
- data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +5 -3
- data/docs/PaymentResponseV3.md +1 -1
- data/docs/PaymentResponseV4.md +7 -1
- data/docs/PaymentV3.md +37 -0
- data/docs/PayorV1.md +3 -1
- data/docs/PayorV2.md +5 -1
- data/docs/PayorsApi.md +14 -14
- data/docs/PayoutCompanyV3.md +17 -0
- data/docs/PayoutIndividualV3.md +17 -0
- data/docs/PayoutNameV3.md +19 -0
- data/docs/PayoutPayeeV3.md +21 -0
- data/docs/PayoutServiceApi.md +393 -0
- data/docs/PayoutSummaryAuditV4.md +4 -2
- data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
- data/docs/PingResponse.md +19 -0
- data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +4 -4
- data/docs/QuoteResponseV3.md +17 -0
- data/docs/{Region.md → RegionV2.md} +2 -2
- data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +2 -2
- data/docs/SourceAccountResponse.md +3 -1
- data/docs/SourceAccountResponseV2.md +4 -2
- data/docs/SourceAccountResponseV3.md +47 -0
- data/docs/SourceAccountType.md +16 -0
- data/docs/{SourceAccount.md → SourceAccountV3.md} +2 -2
- data/docs/SupportedCountriesResponseV2.md +17 -0
- data/docs/{SupportedCountry2.md → SupportedCountryV2.md} +3 -3
- data/docs/SupportedCurrencyResponseV2.md +17 -0
- data/docs/{SupportedCurrency.md → SupportedCurrencyV2.md} +2 -2
- data/docs/TransferRequest2.md +21 -0
- data/docs/TransmissionType.md +16 -0
- data/docs/TransmissionTypes.md +21 -0
- data/docs/TransmissionTypes2.md +21 -0
- data/docs/UpdatePayeeDetailsRequest.md +29 -0
- data/docs/UpdatePayeeDetailsRequest2.md +29 -0
- data/docs/UpdateWebhookRequest.md +21 -0
- data/docs/UserResponse.md +1 -1
- data/docs/UsersApi.md +62 -6
- data/docs/WatchlistStatus2.md +16 -0
- data/docs/WebhookResponse.md +25 -0
- data/docs/WebhooksApi.md +280 -0
- data/docs/WebhooksResponse.md +21 -0
- data/docs/WithdrawPaymentRequest.md +17 -0
- data/lib/velopayments.rb +68 -32
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +516 -74
- data/lib/velopayments/api/funding_manager_private_api.rb +14 -13
- data/lib/velopayments/api/login_api.rb +21 -14
- data/lib/velopayments/api/payee_invitation_api.rb +312 -33
- data/lib/velopayments/api/payees_api.rb +582 -46
- data/lib/velopayments/api/payment_audit_service_api.rb +444 -78
- data/lib/velopayments/api/payors_api.rb +48 -40
- data/lib/velopayments/api/payors_private_api.rb +6 -5
- data/lib/velopayments/api/payout_service_api.rb +506 -0
- data/lib/velopayments/api/tokens_api.rb +6 -5
- data/lib/velopayments/api/users_api.rb +146 -54
- data/lib/velopayments/api/webhooks_api.rb +350 -0
- data/lib/velopayments/api_client.rb +47 -44
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +35 -8
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +13 -9
- data/lib/velopayments/models/access_token_response.rb +10 -6
- data/lib/velopayments/models/access_token_validation_request.rb +10 -6
- data/lib/velopayments/models/auth_response.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config.rb +10 -6
- data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
- data/lib/velopayments/models/challenge.rb +10 -6
- data/lib/velopayments/models/challenge2.rb +285 -0
- data/lib/velopayments/models/company.rb +15 -11
- data/lib/velopayments/models/company2.rb +15 -11
- data/lib/velopayments/models/company_response.rb +10 -6
- data/lib/velopayments/models/company_v1.rb +15 -11
- data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
- data/lib/velopayments/models/create_individual.rb +10 -6
- data/lib/velopayments/models/create_individual2.rb +10 -6
- data/lib/velopayments/models/create_individual2_name.rb +10 -6
- data/lib/velopayments/models/create_payee.rb +10 -6
- data/lib/velopayments/models/create_payee2.rb +13 -9
- data/lib/velopayments/models/create_payee_address.rb +10 -6
- data/lib/velopayments/models/create_payee_address2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_request2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response2.rb +10 -6
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +10 -6
- data/lib/velopayments/models/create_payees_request.rb +10 -6
- data/lib/velopayments/models/create_payees_request2.rb +10 -6
- data/lib/velopayments/models/create_payment_channel.rb +10 -6
- data/lib/velopayments/models/create_payment_channel2.rb +10 -6
- data/lib/velopayments/models/create_payor_link_request.rb +10 -6
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +14 -10
- data/lib/velopayments/models/create_webhook_request.rb +315 -0
- data/lib/velopayments/models/error.rb +10 -6
- data/lib/velopayments/models/error_response.rb +10 -6
- data/lib/velopayments/models/failed_submission.rb +10 -6
- data/lib/velopayments/models/failed_submission2.rb +10 -6
- data/lib/velopayments/models/funding_account_response.rb +105 -10
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +106 -95
- data/lib/velopayments/models/funding_account_type.rb +37 -0
- data/lib/velopayments/models/funding_audit.rb +23 -17
- data/lib/velopayments/models/funding_event.rb +11 -7
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +47 -7
- data/lib/velopayments/models/funding_request_v1.rb +10 -6
- data/lib/velopayments/models/funding_request_v2.rb +10 -6
- data/lib/velopayments/models/funding_request_v3.rb +259 -0
- data/lib/velopayments/models/fx_summary_v3.rb +11 -7
- data/lib/velopayments/models/fx_summary_v4.rb +11 -7
- data/lib/velopayments/models/get_fundings_response.rb +37 -24
- data/lib/velopayments/models/{paged_response.rb → get_fundings_response_links.rb} +26 -24
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +85 -113
- data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +14 -10
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -9
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +10 -6
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +25 -11
- data/lib/velopayments/models/get_payout_statistics.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +10 -6
- data/lib/velopayments/models/get_payouts_response_v4.rb +10 -6
- data/lib/velopayments/models/individual.rb +10 -6
- data/lib/velopayments/models/individual2.rb +10 -6
- data/lib/velopayments/models/individual_response.rb +10 -6
- data/lib/velopayments/models/individual_v1.rb +10 -6
- data/lib/velopayments/models/individual_v1_name.rb +10 -6
- data/lib/velopayments/models/inline_response400.rb +10 -6
- data/lib/velopayments/models/inline_response400_errors.rb +10 -6
- data/lib/velopayments/models/inline_response401.rb +10 -6
- data/lib/velopayments/models/inline_response401_errors.rb +10 -6
- data/lib/velopayments/models/inline_response403.rb +10 -6
- data/lib/velopayments/models/inline_response403_errors.rb +10 -6
- data/lib/velopayments/models/inline_response404.rb +225 -0
- data/lib/velopayments/models/inline_response404_errors.rb +240 -0
- data/lib/velopayments/models/inline_response409.rb +10 -6
- data/lib/velopayments/models/inline_response409_errors.rb +10 -6
- data/lib/velopayments/models/inline_response412.rb +225 -0
- data/lib/velopayments/models/inline_response412_errors.rb +240 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invitation_status_response.rb +10 -6
- data/lib/velopayments/models/invite_payee_request.rb +10 -6
- data/lib/velopayments/models/invite_payee_request2.rb +10 -6
- data/lib/velopayments/models/invite_user_request.rb +19 -15
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/language.rb +3 -2
- data/lib/velopayments/models/language2.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response.rb +10 -6
- data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +14 -10
- data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +13 -9
- data/lib/velopayments/models/list_payments_response_v4.rb +11 -7
- data/lib/velopayments/models/list_source_account_response.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_links.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_page.rb +10 -6
- data/lib/velopayments/models/list_source_account_response_v2.rb +11 -7
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
- data/lib/velopayments/models/location_type.rb +3 -2
- data/lib/velopayments/models/marketing_opt_in.rb +11 -7
- data/lib/velopayments/models/mfa_details.rb +10 -6
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +333 -0
- data/lib/velopayments/models/notifications.rb +10 -6
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → notifications2.rb} +20 -18
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/ofac_status2.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/page_for_response.rb +10 -6
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response.rb +10 -6
- data/lib/velopayments/models/paged_payee_response2.rb +11 -7
- data/lib/velopayments/models/paged_payee_response2_summary.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_page.rb +10 -6
- data/lib/velopayments/models/paged_payee_response_summary.rb +10 -6
- data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
- data/lib/velopayments/models/paged_user_response.rb +10 -6
- data/lib/velopayments/models/paged_user_response_links.rb +10 -6
- data/lib/velopayments/models/paged_user_response_page.rb +10 -6
- data/lib/velopayments/models/password_request.rb +10 -6
- data/lib/velopayments/models/payee.rb +12 -8
- data/lib/velopayments/models/payee2.rb +12 -8
- data/lib/velopayments/models/payee_address.rb +10 -6
- data/lib/velopayments/models/payee_address2.rb +10 -6
- data/lib/velopayments/models/payee_delta.rb +10 -6
- data/lib/velopayments/models/payee_delta2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2.rb +10 -6
- data/lib/velopayments/models/payee_delta_response2_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_links.rb +10 -6
- data/lib/velopayments/models/payee_delta_response_page.rb +10 -6
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +30 -17
- data/lib/velopayments/models/payee_detail_response2.rb +475 -0
- data/lib/velopayments/models/payee_invitation_status.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response.rb +10 -6
- data/lib/velopayments/models/payee_invitation_status_response2.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel.rb +10 -6
- data/lib/velopayments/models/payee_payment_channel2.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref.rb +10 -6
- data/lib/velopayments/models/payee_payor_ref2.rb +248 -0
- data/lib/velopayments/models/payee_payor_ref_v2.rb +11 -7
- data/lib/velopayments/models/payee_payor_ref_v3.rb +12 -42
- data/lib/velopayments/models/payee_response.rb +12 -8
- data/lib/velopayments/models/payee_response_v2.rb +13 -9
- data/lib/velopayments/models/payee_type.rb +3 -2
- data/lib/velopayments/models/payee_type2.rb +37 -0
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +54 -194
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +10 -6
- data/lib/velopayments/models/payment_channel_rule.rb +10 -6
- data/lib/velopayments/models/payment_channel_rules_response.rb +10 -6
- data/lib/velopayments/models/payment_delta.rb +10 -6
- data/lib/velopayments/models/payment_delta_response.rb +10 -6
- data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
- data/lib/velopayments/models/payment_delta_v4.rb +289 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_event_response_v4.rb +11 -7
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +27 -13
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_response_v3.rb +11 -7
- data/lib/velopayments/models/payment_response_v4.rb +39 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +10 -6
- data/lib/velopayments/models/payment_v3.rb +363 -0
- data/lib/velopayments/models/payor_address.rb +10 -6
- data/lib/velopayments/models/payor_address_v2.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +10 -6
- data/lib/velopayments/models/payor_aml_transaction_v4.rb +10 -6
- data/lib/velopayments/models/payor_branding_response.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_request.rb +10 -6
- data/lib/velopayments/models/payor_create_api_key_response.rb +10 -6
- data/lib/velopayments/models/payor_create_application_request.rb +10 -6
- data/lib/velopayments/models/payor_email_opt_out_request.rb +10 -6
- data/lib/velopayments/models/payor_links_response.rb +10 -6
- data/lib/velopayments/models/payor_links_response_links.rb +10 -6
- data/lib/velopayments/models/payor_links_response_payors.rb +10 -6
- data/lib/velopayments/models/payor_logo_request.rb +10 -6
- data/lib/velopayments/models/payor_v1.rb +23 -10
- data/lib/velopayments/models/payor_v2.rb +33 -10
- data/lib/velopayments/models/payout_company_v3.rb +215 -0
- data/lib/velopayments/models/payout_individual_v3.rb +215 -0
- data/lib/velopayments/models/payout_name_v3.rb +229 -0
- data/lib/velopayments/models/payout_payee_v3.rb +234 -0
- data/lib/velopayments/models/payout_payor_v4.rb +10 -6
- data/lib/velopayments/models/payout_principal_v4.rb +10 -6
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/payout_status_v4.rb +3 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +10 -6
- data/lib/velopayments/models/payout_summary_audit_v4.rb +22 -9
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +32 -14
- data/lib/velopayments/models/payout_type_v4.rb +3 -2
- data/lib/velopayments/models/ping_response.rb +219 -0
- data/lib/velopayments/models/query_batch_response.rb +10 -6
- data/lib/velopayments/models/query_batch_response2.rb +10 -6
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +15 -11
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +14 -10
- data/lib/velopayments/models/{region.rb → region_v2.rb} +13 -9
- data/lib/velopayments/models/register_sms_request.rb +13 -9
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +13 -9
- data/lib/velopayments/models/resend_token_request.rb +10 -6
- data/lib/velopayments/models/reset_password_request.rb +10 -6
- data/lib/velopayments/models/role.rb +10 -6
- data/lib/velopayments/models/role_update_request.rb +10 -6
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +10 -6
- data/lib/velopayments/models/self_update_password_request.rb +10 -6
- data/lib/velopayments/models/set_notifications_request.rb +10 -6
- data/lib/velopayments/models/source_account_response.rb +24 -11
- data/lib/velopayments/models/source_account_response_v2.rb +26 -13
- data/lib/velopayments/models/source_account_response_v3.rb +437 -0
- data/lib/velopayments/models/source_account_summary_v3.rb +10 -6
- data/lib/velopayments/models/source_account_summary_v4.rb +10 -6
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +13 -9
- data/lib/velopayments/models/supported_countries_response.rb +10 -6
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +14 -10
- data/lib/velopayments/models/supported_country.rb +10 -6
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +14 -10
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +13 -9
- data/lib/velopayments/models/transfer_request.rb +10 -6
- data/lib/velopayments/models/transfer_request2.rb +301 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{list_payments_response_page.rb → transmission_types.rb} +50 -46
- data/lib/velopayments/models/transmission_types2.rb +246 -0
- data/lib/velopayments/models/unregister_mfa_request.rb +10 -6
- data/lib/velopayments/models/update_payee_details_request.rb +266 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
- data/lib/velopayments/models/update_remote_id_request.rb +10 -6
- data/lib/velopayments/models/update_webhook_request.rb +288 -0
- data/lib/velopayments/models/user_details_update_request.rb +19 -15
- data/lib/velopayments/models/user_info.rb +10 -6
- data/lib/velopayments/models/user_response.rb +20 -16
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +10 -6
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/watchlist_status2.rb +40 -0
- data/lib/velopayments/models/webhook_response.rb +246 -0
- data/lib/velopayments/models/webhooks_response.rb +233 -0
- data/lib/velopayments/models/{currency_type.rb → withdraw_payment_request.rb} +39 -34
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +93 -18
- data/spec/api/funding_manager_private_api_spec.rb +5 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +57 -4
- data/spec/api/payees_api_spec.rb +108 -4
- data/spec/api/payment_audit_service_api_spec.rb +72 -18
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +127 -0
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +17 -4
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
- 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_config2_spec.rb +59 -0
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company2_spec.rb +2 -2
- data/spec/models/company_response_spec.rb +2 -2
- data/spec/models/company_spec.rb +2 -2
- data/spec/models/company_v1_spec.rb +2 -2
- data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
- data/spec/models/create_individual2_name_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +2 -2
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +2 -2
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payor_link_request_spec.rb +2 -2
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
- data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/failed_submission2_spec.rb +2 -2
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_account_response2_spec.rb +95 -0
- data/spec/models/funding_account_response_spec.rb +26 -2
- data/spec/models/funding_account_type_spec.rb +35 -0
- data/spec/models/funding_audit_spec.rb +8 -8
- 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/funding_request_v3_spec.rb +47 -0
- 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_links_spec.rb +47 -0
- data/spec/models/get_fundings_response_spec.rb +14 -2
- data/spec/models/get_payee_list_response_company_spec.rb +47 -0
- data/spec/models/get_payee_list_response_individual_spec.rb +41 -0
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response_spec.rb} +21 -39
- 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 +8 -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 +2 -2
- data/spec/models/individual_response_spec.rb +2 -2
- data/spec/models/individual_spec.rb +2 -2
- data/spec/models/individual_v1_name_spec.rb +2 -2
- data/spec/models/individual_v1_spec.rb +2 -2
- data/spec/models/inline_response400_errors_spec.rb +2 -2
- data/spec/models/inline_response400_spec.rb +2 -2
- data/spec/models/inline_response401_errors_spec.rb +2 -2
- data/spec/models/inline_response401_spec.rb +2 -2
- data/spec/models/inline_response403_errors_spec.rb +2 -2
- data/spec/models/inline_response403_spec.rb +2 -2
- data/spec/models/inline_response404_errors_spec.rb +59 -0
- data/spec/models/inline_response404_spec.rb +47 -0
- data/spec/models/inline_response409_errors_spec.rb +2 -2
- data/spec/models/inline_response409_spec.rb +2 -2
- data/spec/models/inline_response412_errors_spec.rb +59 -0
- data/spec/models/inline_response412_spec.rb +47 -0
- data/spec/models/invitation_status2_spec.rb +35 -0
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request2_spec.rb +2 -2
- 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/language2_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/link_for_response_spec.rb +2 -2
- data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
- data/spec/models/list_funding_accounts_response_spec.rb +2 -2
- data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
- data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
- 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_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
- data/spec/models/list_source_account_response_v3_spec.rb +53 -0
- data/spec/models/location_type_spec.rb +2 -2
- 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/name_spec.rb +59 -0
- data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status2_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status2_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
- 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_payments_response_v3_spec.rb +53 -0
- 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 +2 -2
- data/spec/models/payee_address2_spec.rb +2 -2
- data/spec/models/payee_address_spec.rb +2 -2
- data/spec/models/payee_delta2_spec.rb +2 -2
- data/spec/models/payee_delta_response2_links_spec.rb +2 -2
- data/spec/models/payee_delta_response2_spec.rb +2 -2
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_detail_response2_spec.rb +209 -0
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -8
- data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
- data/spec/models/payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/payee_payment_channel2_spec.rb +2 -2
- data/spec/models/payee_payment_channel_spec.rb +2 -2
- data/spec/models/payee_payor_ref2_spec.rb +65 -0
- data/spec/models/payee_payor_ref_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
- data/spec/models/payee_payor_ref_v3_spec.rb +2 -6
- data/spec/models/payee_response_spec.rb +2 -2
- data/spec/models/payee_response_v2_spec.rb +2 -2
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type2_spec.rb +35 -0
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payee_user_self_update_request_spec.rb +71 -0
- 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_response_v4_spec.rb +53 -0
- data/spec/models/payment_delta_spec.rb +2 -2
- data/spec/models/payment_delta_v4_spec.rb +83 -0
- 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 → payment_instruction_v3_spec.rb} +14 -8
- 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 +20 -2
- data/spec/models/payment_v3_spec.rb +105 -0
- 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 +8 -2
- data/spec/models/payor_v2_spec.rb +14 -2
- data/spec/models/{get_fundings_response_all_of_spec.rb → payout_company_v3_spec.rb} +9 -9
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
- data/spec/models/payout_name_v3_spec.rb +47 -0
- data/spec/models/payout_payee_v3_spec.rb +53 -0
- 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 +8 -2
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
- data/spec/models/payout_type_v4_spec.rb +2 -2
- data/spec/models/ping_response_spec.rb +47 -0
- data/spec/models/query_batch_response2_spec.rb +2 -2
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
- data/spec/models/register_sms_request_spec.rb +2 -2
- data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
- 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/role_update_request_spec.rb +2 -2
- 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 +8 -2
- data/spec/models/source_account_response_v2_spec.rb +8 -2
- data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
- 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/source_account_type_spec.rb +35 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
- data/spec/models/transfer_request2_spec.rb +53 -0
- data/spec/models/transfer_request_spec.rb +2 -2
- data/spec/models/transmission_type_spec.rb +35 -0
- data/spec/models/transmission_types2_spec.rb +53 -0
- data/spec/models/transmission_types_spec.rb +53 -0
- data/spec/models/unregister_mfa_request_spec.rb +2 -2
- data/spec/models/update_payee_details_request2_spec.rb +77 -0
- data/spec/models/update_payee_details_request_spec.rb +77 -0
- data/spec/models/update_remote_id_request_spec.rb +2 -2
- data/spec/models/update_webhook_request_spec.rb +53 -0
- data/spec/models/user_details_update_request_spec.rb +2 -2
- data/spec/models/user_info_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_status2_spec.rb +35 -0
- data/spec/models/watchlist_status_spec.rb +2 -2
- data/spec/models/{paged_response_page_spec.rb → webhook_response_spec.rb} +13 -13
- data/spec/models/webhooks_response_spec.rb +53 -0
- data/spec/models/withdraw_payment_request_spec.rb +41 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +61 -11
- data/specs/api/payees_api_spec.rb +101 -14
- data/specs/api/payment_audit_service_api_spec.rb +231 -30
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/specs/api/payout_service_api_spec.rb +127 -0
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/velopayments.gemspec +3 -4
- metadata +444 -326
- data/Gemfile.lock +0 -70
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/spec/api/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/payout_history_api_spec.rb +0 -95
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/payout_history_api_spec.rb +0 -95
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
- data/velopayments-2.20.118.gem +0 -0
@@ -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.22.122
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,32 @@ require 'json'
|
|
19
19
|
describe 'PayeeInvitationApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
+
if ENV['APITOKEN'] == ""
|
23
|
+
VeloPayments.configure do |config|
|
24
|
+
config.username = ENV['KEY']
|
25
|
+
config.password = ENV['SECRET']
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = VeloPayments::LoginApi.new
|
29
|
+
opts = {
|
30
|
+
grant_type: 'client_credentials'
|
31
|
+
}
|
32
|
+
|
33
|
+
begin
|
34
|
+
res = api_instance.velo_auth(opts)
|
35
|
+
|
36
|
+
ENV['APITOKEN'] = res.access_token
|
37
|
+
rescue VeloPayments::ApiError => e
|
38
|
+
puts "Exception when calling LoginApi->velo_auth: #{e}"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
uri = URI.parse(ENV['APIURL'])
|
43
|
+
VeloPayments.configure do |config|
|
44
|
+
config.access_token = ENV['APITOKEN']
|
45
|
+
config.host = uri.host
|
46
|
+
end
|
47
|
+
|
22
48
|
@api_instance = VeloPayments::PayeeInvitationApi.new
|
23
49
|
end
|
24
50
|
|
@@ -40,7 +66,11 @@ describe 'PayeeInvitationApi' do
|
|
40
66
|
# @return [InvitationStatusResponse]
|
41
67
|
describe 'get_payees_invitation_status_v1 test' do
|
42
68
|
it 'should work' do
|
43
|
-
|
69
|
+
payor_id = ENV['PAYOR']
|
70
|
+
|
71
|
+
res = @api_instance.get_payees_invitation_status_v1(payor_id)
|
72
|
+
expect(res.payee_invitation_statuses.length()).to be >= 1
|
73
|
+
expect(@api_instance).to respond_to(:get_payees_invitation_status_v1)
|
44
74
|
end
|
45
75
|
end
|
46
76
|
|
@@ -56,7 +86,17 @@ describe 'PayeeInvitationApi' do
|
|
56
86
|
# @return [PagedPayeeInvitationStatusResponse]
|
57
87
|
describe 'get_payees_invitation_status_v2 test' do
|
58
88
|
it 'should work' do
|
59
|
-
|
89
|
+
payor_id = ENV['PAYOR']
|
90
|
+
opts = {
|
91
|
+
payee_id: nil, # String | The UUID of the payee.
|
92
|
+
invitation_status: nil, # VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
|
93
|
+
page: 1, # Integer | Page number. Default is 1.
|
94
|
+
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
95
|
+
}
|
96
|
+
|
97
|
+
res = @api_instance.get_payees_invitation_status_v2(payor_id, opts)
|
98
|
+
expect(res.content.length()).to be >= 1
|
99
|
+
expect(@api_instance).to respond_to(:get_payees_invitation_status_v2)
|
60
100
|
end
|
61
101
|
end
|
62
102
|
|
@@ -72,7 +112,17 @@ describe 'PayeeInvitationApi' do
|
|
72
112
|
# @return [PagedPayeeInvitationStatusResponse2]
|
73
113
|
describe 'get_payees_invitation_status_v3 test' do
|
74
114
|
it 'should work' do
|
75
|
-
|
115
|
+
payor_id = ENV['PAYOR']
|
116
|
+
opts = {
|
117
|
+
payee_id: nil, # String | The UUID of the payee.
|
118
|
+
invitation_status: nil, # VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
|
119
|
+
page: 1, # Integer | Page number. Default is 1.
|
120
|
+
page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
|
121
|
+
}
|
122
|
+
|
123
|
+
res = @api_instance.get_payees_invitation_status_v3(payor_id, opts)
|
124
|
+
expect(res.content.length()).to be >= 1
|
125
|
+
expect(@api_instance).to respond_to(:get_payees_invitation_status_v3)
|
76
126
|
end
|
77
127
|
end
|
78
128
|
|
@@ -83,7 +133,7 @@ describe 'PayeeInvitationApi' do
|
|
83
133
|
# @param [Hash] opts the optional parameters
|
84
134
|
# @return [QueryBatchResponse]
|
85
135
|
describe 'query_batch_status_v2 test' do
|
86
|
-
|
136
|
+
skip "skipping test" do
|
87
137
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
88
138
|
end
|
89
139
|
end
|
@@ -95,7 +145,7 @@ describe 'PayeeInvitationApi' do
|
|
95
145
|
# @param [Hash] opts the optional parameters
|
96
146
|
# @return [QueryBatchResponse2]
|
97
147
|
describe 'query_batch_status_v3 test' do
|
98
|
-
|
148
|
+
skip "skipping test" do
|
99
149
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
100
150
|
end
|
101
151
|
end
|
@@ -108,7 +158,7 @@ describe 'PayeeInvitationApi' do
|
|
108
158
|
# @param [Hash] opts the optional parameters
|
109
159
|
# @return [nil]
|
110
160
|
describe 'resend_payee_invite_v1 test' do
|
111
|
-
|
161
|
+
skip "skipping test" do
|
112
162
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
113
163
|
end
|
114
164
|
end
|
@@ -121,7 +171,7 @@ describe 'PayeeInvitationApi' do
|
|
121
171
|
# @param [Hash] opts the optional parameters
|
122
172
|
# @return [nil]
|
123
173
|
describe 'resend_payee_invite_v3 test' do
|
124
|
-
|
174
|
+
skip "skipping test" do
|
125
175
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
126
176
|
end
|
127
177
|
end
|
@@ -133,7 +183,7 @@ describe 'PayeeInvitationApi' do
|
|
133
183
|
# @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
|
134
184
|
# @return [CreatePayeesCSVResponse]
|
135
185
|
describe 'v2_create_payee test' do
|
136
|
-
|
186
|
+
skip "skipping test" do
|
137
187
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
138
188
|
end
|
139
189
|
end
|
@@ -145,7 +195,7 @@ describe 'PayeeInvitationApi' do
|
|
145
195
|
# @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
|
146
196
|
# @return [CreatePayeesCSVResponse2]
|
147
197
|
describe 'v3_create_payee test' do
|
148
|
-
|
198
|
+
skip "skipping test" do
|
149
199
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
150
200
|
end
|
151
201
|
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.22.122
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,32 @@ require 'json'
|
|
19
19
|
describe 'PayeesApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
+
if ENV['APITOKEN'] == ""
|
23
|
+
VeloPayments.configure do |config|
|
24
|
+
config.username = ENV['KEY']
|
25
|
+
config.password = ENV['SECRET']
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = VeloPayments::LoginApi.new
|
29
|
+
opts = {
|
30
|
+
grant_type: 'client_credentials'
|
31
|
+
}
|
32
|
+
|
33
|
+
begin
|
34
|
+
res = api_instance.velo_auth(opts)
|
35
|
+
|
36
|
+
ENV['APITOKEN'] = res.access_token
|
37
|
+
rescue VeloPayments::ApiError => e
|
38
|
+
puts "Exception when calling LoginApi->velo_auth: #{e}"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
uri = URI.parse(ENV['APIURL'])
|
43
|
+
VeloPayments.configure do |config|
|
44
|
+
config.access_token = ENV['APITOKEN']
|
45
|
+
config.host = uri.host
|
46
|
+
end
|
47
|
+
|
22
48
|
@api_instance = VeloPayments::PayeesApi.new
|
23
49
|
end
|
24
50
|
|
@@ -39,7 +65,7 @@ describe 'PayeesApi' do
|
|
39
65
|
# @param [Hash] opts the optional parameters
|
40
66
|
# @return [nil]
|
41
67
|
describe 'delete_payee_by_id_v1 test' do
|
42
|
-
|
68
|
+
skip "skipping test" do
|
43
69
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
70
|
end
|
45
71
|
end
|
@@ -51,7 +77,7 @@ describe 'PayeesApi' do
|
|
51
77
|
# @param [Hash] opts the optional parameters
|
52
78
|
# @return [nil]
|
53
79
|
describe 'delete_payee_by_id_v3 test' do
|
54
|
-
|
80
|
+
skip "skipping test" do
|
55
81
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
82
|
end
|
57
83
|
end
|
@@ -64,7 +90,7 @@ describe 'PayeesApi' do
|
|
64
90
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
65
91
|
# @return [Payee]
|
66
92
|
describe 'get_payee_by_id_v1 test' do
|
67
|
-
|
93
|
+
skip "skipping test" do
|
68
94
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
69
95
|
end
|
70
96
|
end
|
@@ -77,7 +103,7 @@ describe 'PayeesApi' do
|
|
77
103
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
78
104
|
# @return [PayeeResponseV2]
|
79
105
|
describe 'get_payee_by_id_v2 test' do
|
80
|
-
|
106
|
+
skip "skipping test" do
|
81
107
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
82
108
|
end
|
83
109
|
end
|
@@ -88,9 +114,9 @@ describe 'PayeesApi' do
|
|
88
114
|
# @param payee_id The UUID of the payee.
|
89
115
|
# @param [Hash] opts the optional parameters
|
90
116
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
91
|
-
# @return [
|
117
|
+
# @return [PayeeDetailResponse]
|
92
118
|
describe 'get_payee_by_id_v3 test' do
|
93
|
-
|
119
|
+
skip "skipping test" do
|
94
120
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
95
121
|
end
|
96
122
|
end
|
@@ -106,7 +132,15 @@ describe 'PayeesApi' do
|
|
106
132
|
# @return [PayeeDeltaResponse]
|
107
133
|
describe 'list_payee_changes test' do
|
108
134
|
it 'should work' do
|
109
|
-
|
135
|
+
payor_id = ENV['PAYOR']
|
136
|
+
updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
137
|
+
opts = {
|
138
|
+
page: 1, # Integer | Page number. Default is 1.
|
139
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
140
|
+
}
|
141
|
+
res = @api_instance.list_payee_changes(payor_id, updated_since, opts)
|
142
|
+
expect(res.content.length()).to be >= 1
|
143
|
+
expect(@api_instance).to respond_to(:list_payee_changes)
|
110
144
|
end
|
111
145
|
end
|
112
146
|
|
@@ -121,7 +155,15 @@ describe 'PayeesApi' do
|
|
121
155
|
# @return [PayeeDeltaResponse2]
|
122
156
|
describe 'list_payee_changes_v3 test' do
|
123
157
|
it 'should work' do
|
124
|
-
|
158
|
+
payor_id = ENV['PAYOR']
|
159
|
+
updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
160
|
+
opts = {
|
161
|
+
page: 1, # Integer | Page number. Default is 1.
|
162
|
+
page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
|
163
|
+
}
|
164
|
+
res = @api_instance.list_payee_changes_v3(payor_id, updated_since, opts)
|
165
|
+
expect(res.content.length()).to be >= 1
|
166
|
+
expect(@api_instance).to respond_to(:list_payee_changes_v3)
|
125
167
|
end
|
126
168
|
end
|
127
169
|
|
@@ -143,7 +185,22 @@ describe 'PayeesApi' do
|
|
143
185
|
# @return [PagedPayeeResponse]
|
144
186
|
describe 'list_payees_v1 test' do
|
145
187
|
it 'should work' do
|
146
|
-
|
188
|
+
payor_id = ENV['PAYOR']
|
189
|
+
opts = {
|
190
|
+
ofac_status: nil, # VeloPayments::OfacStatus.new, # OfacStatus | The ofacStatus of the payees.
|
191
|
+
onboarded_status: nil, # VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
192
|
+
email: nil, # String | Email address
|
193
|
+
display_name: nil, # String | The display name of the payees.
|
194
|
+
remote_id: 'remoteId123', # String | The remote id of the payees.
|
195
|
+
payee_type: nil, # VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
196
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
197
|
+
page: 1, # Integer | Page number. Default is 1.
|
198
|
+
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
199
|
+
sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
|
200
|
+
}
|
201
|
+
res = @api_instance.list_payees_v1(payor_id, opts)
|
202
|
+
expect(res.content.length()).to be >= 0
|
203
|
+
expect(@api_instance).to respond_to(:list_payees_v1)
|
147
204
|
end
|
148
205
|
end
|
149
206
|
|
@@ -152,7 +209,8 @@ describe 'PayeesApi' do
|
|
152
209
|
# Get a paginated response listing the payees for a payor.
|
153
210
|
# @param payor_id The account owner Payor ID
|
154
211
|
# @param [Hash] opts the optional parameters
|
155
|
-
# @option opts [WatchlistStatus] :
|
212
|
+
# @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
|
213
|
+
# @option opts [Boolean] :disabled Payee disabled
|
156
214
|
# @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
|
157
215
|
# @option opts [String] :email Email address
|
158
216
|
# @option opts [String] :display_name The display name of the payees.
|
@@ -165,6 +223,35 @@ describe 'PayeesApi' do
|
|
165
223
|
# @return [PagedPayeeResponse2]
|
166
224
|
describe 'list_payees_v3 test' do
|
167
225
|
it 'should work' do
|
226
|
+
payor_id = ENV['PAYOR']
|
227
|
+
opts = {
|
228
|
+
watchlist_status: nil, # VeloPayments::WatchlistStatus.new, # WatchlistStatus | The watchlistStatus of the payees.
|
229
|
+
disabled: true, # Boolean | Payee disabled
|
230
|
+
onboarded_status: nil, # VeloPayments::OnboardedStatus.new, # OnboardedStatus | The onboarded status of the payees.
|
231
|
+
email: nil, # String | Email address
|
232
|
+
display_name: nil, # String | The display name of the payees.
|
233
|
+
remote_id: nil, # String | The remote id of the payees.
|
234
|
+
payee_type: nil, # VeloPayments::PayeeType.new, # PayeeType | The onboarded status of the payees.
|
235
|
+
payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
|
236
|
+
page: 1, # Integer | Page number. Default is 1.
|
237
|
+
page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
|
238
|
+
sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
|
239
|
+
}
|
240
|
+
res = @api_instance.list_payees_v1(payor_id, opts)
|
241
|
+
expect(res.content.length()).to be >= 0
|
242
|
+
expect(@api_instance).to respond_to(:list_payees_v1)
|
243
|
+
end
|
244
|
+
end
|
245
|
+
|
246
|
+
# unit tests for payee_details_update_v3
|
247
|
+
# Update Payee Details
|
248
|
+
# <p>Update payee details for the given Payee Id.<p>
|
249
|
+
# @param payee_id The UUID of the payee.
|
250
|
+
# @param update_payee_details_request Request to update payee details
|
251
|
+
# @param [Hash] opts the optional parameters
|
252
|
+
# @return [nil]
|
253
|
+
describe 'payee_details_update_v3 test' do
|
254
|
+
skip "skipping test" do
|
168
255
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
169
256
|
end
|
170
257
|
end
|
@@ -177,7 +264,7 @@ describe 'PayeesApi' do
|
|
177
264
|
# @param [Hash] opts the optional parameters
|
178
265
|
# @return [nil]
|
179
266
|
describe 'v1_payees_payee_id_remote_id_update_post test' do
|
180
|
-
|
267
|
+
skip "skipping test" do
|
181
268
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
182
269
|
end
|
183
270
|
end
|
@@ -190,7 +277,7 @@ describe 'PayeesApi' do
|
|
190
277
|
# @param [Hash] opts the optional parameters
|
191
278
|
# @return [nil]
|
192
279
|
describe 'v3_payees_payee_id_remote_id_update_post test' do
|
193
|
-
|
280
|
+
skip "skipping test" do
|
194
281
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
195
282
|
end
|
196
283
|
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.22.122
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,32 @@ require 'json'
|
|
19
19
|
describe 'PaymentAuditServiceApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
+
if ENV['APITOKEN'] == ""
|
23
|
+
VeloPayments.configure do |config|
|
24
|
+
config.username = ENV['KEY']
|
25
|
+
config.password = ENV['SECRET']
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = VeloPayments::LoginApi.new
|
29
|
+
opts = {
|
30
|
+
grant_type: 'client_credentials'
|
31
|
+
}
|
32
|
+
|
33
|
+
begin
|
34
|
+
res = api_instance.velo_auth(opts)
|
35
|
+
|
36
|
+
ENV['APITOKEN'] = res.access_token
|
37
|
+
rescue VeloPayments::ApiError => e
|
38
|
+
puts "Exception when calling LoginApi->velo_auth: #{e}"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
uri = URI.parse(ENV['APIURL'])
|
43
|
+
VeloPayments.configure do |config|
|
44
|
+
config.access_token = ENV['APITOKEN']
|
45
|
+
config.host = uri.host
|
46
|
+
end
|
47
|
+
|
22
48
|
@api_instance = VeloPayments::PaymentAuditServiceApi.new
|
23
49
|
end
|
24
50
|
|
@@ -41,7 +67,7 @@ describe 'PaymentAuditServiceApi' do
|
|
41
67
|
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
42
68
|
# @return [PayorAmlTransactionV3]
|
43
69
|
describe 'export_transactions_csvv3 test' do
|
44
|
-
|
70
|
+
skip "skipping test" do
|
45
71
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
46
72
|
end
|
47
73
|
end
|
@@ -50,29 +76,61 @@ describe 'PaymentAuditServiceApi' do
|
|
50
76
|
# Export Transactions
|
51
77
|
# Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
|
52
78
|
# @param [Hash] opts the optional parameters
|
53
|
-
# @option opts [String] :payor_id The Payor ID for whom you wish to run the report
|
79
|
+
# @option opts [String] :payor_id <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
|
54
80
|
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
|
55
|
-
# @option opts [Date] :
|
56
|
-
# @option opts [String] :include Mode to determine whether to include other Payor's data in the results
|
81
|
+
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
|
82
|
+
# @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
|
57
83
|
# @return [PayorAmlTransactionV4]
|
58
84
|
describe 'export_transactions_csvv4 test' do
|
59
|
-
|
85
|
+
skip "skipping test" do
|
60
86
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
61
87
|
end
|
62
88
|
end
|
63
89
|
|
64
90
|
# unit tests for get_fundings_v1
|
65
91
|
# Get Fundings for Payor
|
66
|
-
# Get a list of Fundings for a payor
|
92
|
+
# <p>Get a list of Fundings for a payor.</p> <p>Deprecated (use v4/paymentaudit/fundings)</p>
|
93
|
+
# @param payor_id The account owner Payor ID
|
67
94
|
# @param [Hash] opts the optional parameters
|
68
|
-
# @option opts [String] :payor_id The account owner Payor ID
|
69
95
|
# @option opts [Integer] :page Page number. Default is 1.
|
70
|
-
# @option opts [Integer] :page_size
|
96
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
71
97
|
# @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
72
98
|
# @return [GetFundingsResponse]
|
73
99
|
describe 'get_fundings_v1 test' do
|
74
100
|
it 'should work' do
|
75
|
-
|
101
|
+
payor_id = ENV['PAYOR']
|
102
|
+
opts = {
|
103
|
+
page: 1, # Integer | Page number. Default is 1.
|
104
|
+
page_size: 25, # Integer | The number of results to return in a page
|
105
|
+
sort: 'dateTime:desc' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
106
|
+
}
|
107
|
+
res = @api_instance.get_fundings_v1(payor_id, opts)
|
108
|
+
expect(res.content.length()).to be >= 1
|
109
|
+
expect(@api_instance).to respond_to(:get_fundings_v1)
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# unit tests for get_fundings_v4
|
114
|
+
# Get Fundings for Payor
|
115
|
+
# <p>Get a list of Fundings for a payor.</p>
|
116
|
+
# @param payor_id The account owner Payor ID
|
117
|
+
# @param [Hash] opts the optional parameters
|
118
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
119
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
120
|
+
# @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
121
|
+
# @return [GetFundingsResponse]
|
122
|
+
describe 'get_fundings_v4 test' do
|
123
|
+
skip "skipping test" do
|
124
|
+
# it 'should work' do
|
125
|
+
# payor_id = ENV['PAYOR']
|
126
|
+
# opts = {
|
127
|
+
# page: 1, # Integer | Page number. Default is 1.
|
128
|
+
# page_size: 25, # Integer | The number of results to return in a page
|
129
|
+
# sort: 'dateTime:desc' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
|
130
|
+
# }
|
131
|
+
# res = @api_instance.get_fundings_v4(payor_id, opts)
|
132
|
+
# expect(res.content.length()).to be >= 1
|
133
|
+
# expect(@api_instance).to respond_to(:get_fundings_v4)
|
76
134
|
end
|
77
135
|
end
|
78
136
|
|
@@ -84,7 +142,7 @@ describe 'PaymentAuditServiceApi' do
|
|
84
142
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
85
143
|
# @return [PaymentResponseV3]
|
86
144
|
describe 'get_payment_details test' do
|
87
|
-
|
145
|
+
skip "skipping test" do
|
88
146
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
89
147
|
end
|
90
148
|
end
|
@@ -97,7 +155,7 @@ describe 'PaymentAuditServiceApi' do
|
|
97
155
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
98
156
|
# @return [PaymentResponseV4]
|
99
157
|
describe 'get_payment_details_v4 test' do
|
100
|
-
|
158
|
+
skip "skipping test" do
|
101
159
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
102
160
|
end
|
103
161
|
end
|
@@ -116,12 +174,12 @@ describe 'PaymentAuditServiceApi' do
|
|
116
174
|
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
117
175
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
118
176
|
# @option opts [Integer] :page Page number. Default is 1.
|
119
|
-
# @option opts [Integer] :page_size
|
120
|
-
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
|
177
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
178
|
+
# @option opts [String] :sort <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p>
|
121
179
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
122
180
|
# @return [GetPaymentsForPayoutResponseV3]
|
123
181
|
describe 'get_payments_for_payout test' do
|
124
|
-
|
182
|
+
skip "skipping test" do
|
125
183
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
126
184
|
end
|
127
185
|
end
|
@@ -140,19 +198,53 @@ describe 'PaymentAuditServiceApi' do
|
|
140
198
|
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
141
199
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
142
200
|
# @option opts [Integer] :page Page number. Default is 1.
|
143
|
-
# @option opts [Integer] :page_size
|
201
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
144
202
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
|
145
203
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
146
204
|
# @return [GetPaymentsForPayoutResponseV4]
|
147
205
|
describe 'get_payments_for_payout_v4 test' do
|
148
|
-
|
206
|
+
skip "skipping test" do
|
149
207
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
150
208
|
end
|
151
209
|
end
|
152
210
|
|
211
|
+
# unit tests for get_payout_stats_v1
|
212
|
+
# Get Payout Statistics
|
213
|
+
# <p>Get payout statistics for a payor.</p> <p>Deprecated (Use /v4/paymentaudit/payoutStatistics)</p>
|
214
|
+
# @param [Hash] opts the optional parameters
|
215
|
+
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
216
|
+
# @return [GetPayoutStatistics]
|
217
|
+
describe 'get_payout_stats_v1 test' do
|
218
|
+
it 'should work' do
|
219
|
+
opts = {
|
220
|
+
payor_id: ENV['PAYOR']
|
221
|
+
}
|
222
|
+
res = @api_instance.get_payout_stats_v1(opts)
|
223
|
+
expect(res.this_month_payouts_count).to be >= 1
|
224
|
+
expect(@api_instance).to respond_to(:get_payout_stats_v1)
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
# unit tests for get_payout_stats_v4
|
229
|
+
# Get Payout Statistics
|
230
|
+
# <p>Get payout statistics for a payor.</p>
|
231
|
+
# @param [Hash] opts the optional parameters
|
232
|
+
# @option opts [String] :payor_id The account owner Payor ID. Required for external users.
|
233
|
+
# @return [GetPayoutStatistics]
|
234
|
+
describe 'get_payout_stats_v4 test' do
|
235
|
+
it 'should work' do
|
236
|
+
opts = {
|
237
|
+
payor_id: ENV['PAYOR']
|
238
|
+
}
|
239
|
+
res = @api_instance.get_payout_stats_v4(opts)
|
240
|
+
expect(res.this_month_payouts_count).to be >= 1
|
241
|
+
expect(@api_instance).to respond_to(:get_payout_stats_v4)
|
242
|
+
end
|
243
|
+
end
|
244
|
+
|
153
245
|
# unit tests for get_payouts_for_payor_v3
|
154
246
|
# Get Payouts for Payor
|
155
|
-
# Get List of payouts for payor
|
247
|
+
# <p>Get List of payouts for payor</p> <p>Deprecated Use v4</p>
|
156
248
|
# @param payor_id The account owner Payor ID
|
157
249
|
# @param [Hash] opts the optional parameters
|
158
250
|
# @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
|
@@ -160,12 +252,25 @@ describe 'PaymentAuditServiceApi' do
|
|
160
252
|
# @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
|
161
253
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
162
254
|
# @option opts [Integer] :page Page number. Default is 1.
|
163
|
-
# @option opts [Integer] :page_size
|
255
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
164
256
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.
|
165
257
|
# @return [GetPayoutsResponseV3]
|
166
258
|
describe 'get_payouts_for_payor_v3 test' do
|
167
259
|
it 'should work' do
|
168
|
-
#
|
260
|
+
payor_id = ENV['PAYOR'] # String | The account owner Payor ID
|
261
|
+
opts = {
|
262
|
+
payout_memo: nil, # String | Payout Memo filter - case insensitive sub-string match
|
263
|
+
status: nil, # String | Payout Status
|
264
|
+
submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
265
|
+
submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
266
|
+
page: 1, # Integer | Page number. Default is 1.
|
267
|
+
page_size: 25, # Integer | The number of results to return in a page
|
268
|
+
sort: 'submittedDateTime:desc' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.
|
269
|
+
}
|
270
|
+
|
271
|
+
res = @api_instance.get_payouts_for_payor_v3(payor_id, opts)
|
272
|
+
expect(res.content.length()).to be >= 1
|
273
|
+
expect(@api_instance).to respond_to(:get_payouts_for_payor_v3)
|
169
274
|
end
|
170
275
|
end
|
171
276
|
|
@@ -180,12 +285,26 @@ describe 'PaymentAuditServiceApi' do
|
|
180
285
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
181
286
|
# @option opts [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
|
182
287
|
# @option opts [Integer] :page Page number. Default is 1.
|
183
|
-
# @option opts [Integer] :page_size
|
288
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
184
289
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
|
185
290
|
# @return [GetPayoutsResponseV4]
|
186
291
|
describe 'get_payouts_for_payor_v4 test' do
|
187
292
|
it 'should work' do
|
188
|
-
|
293
|
+
opts = {
|
294
|
+
payor_id: ENV['PAYOR'], # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
|
295
|
+
payout_memo: nil, # # String | Payout Memo filter - case insensitive sub-string match
|
296
|
+
status: nil, # String | Payout Status
|
297
|
+
submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
298
|
+
submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
299
|
+
from_payor_name: nil, # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
|
300
|
+
page: 1, # Integer | Page number. Default is 1.
|
301
|
+
page_size: 25, # Integer | The number of results to return in a page
|
302
|
+
sort: 'submittedDateTime:desc' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
|
303
|
+
}
|
304
|
+
|
305
|
+
res = @api_instance.get_payouts_for_payor_v4(opts)
|
306
|
+
expect(res.content.length()).to be >= 1
|
307
|
+
expect(@api_instance).to respond_to(:get_payouts_for_payor_v4)
|
189
308
|
end
|
190
309
|
end
|
191
310
|
|
@@ -196,11 +315,45 @@ describe 'PaymentAuditServiceApi' do
|
|
196
315
|
# @param updated_since The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
197
316
|
# @param [Hash] opts the optional parameters
|
198
317
|
# @option opts [Integer] :page Page number. Default is 1.
|
199
|
-
# @option opts [Integer] :page_size
|
318
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
200
319
|
# @return [PaymentDeltaResponse]
|
201
320
|
describe 'list_payment_changes test' do
|
202
321
|
it 'should work' do
|
203
|
-
#
|
322
|
+
payor_id = ENV['PAYOR'] # String | The Payor ID to find associated Payments
|
323
|
+
updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
324
|
+
opts = {
|
325
|
+
page: 1, # Integer | Page number. Default is 1.
|
326
|
+
page_size: 100 # Integer | The number of results to return in a page
|
327
|
+
}
|
328
|
+
|
329
|
+
res = @api_instance.list_payment_changes(payor_id, updated_since, opts)
|
330
|
+
expect(res.content.length()).to be >= 1
|
331
|
+
expect(@api_instance).to respond_to(:list_payment_changes)
|
332
|
+
end
|
333
|
+
end
|
334
|
+
|
335
|
+
# unit tests for list_payment_changes_v4
|
336
|
+
# List Payment Changes
|
337
|
+
# Get a paginated response listing payment changes.
|
338
|
+
# @param payor_id The Payor ID to find associated Payments
|
339
|
+
# @param updated_since The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
340
|
+
# @param [Hash] opts the optional parameters
|
341
|
+
# @option opts [Integer] :page Page number. Default is 1.
|
342
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
343
|
+
# @return [PaymentDeltaResponseV4]
|
344
|
+
describe 'list_payment_changes_v4 test' do
|
345
|
+
skip "skipping broken test" do
|
346
|
+
# it 'should work' do
|
347
|
+
# payor_id = ENV['PAYOR'] # String | The Payor ID to find associated Payments
|
348
|
+
# updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
|
349
|
+
# opts = {
|
350
|
+
# page: 1, # Integer | Page number. Default is 1.
|
351
|
+
# page_size: 100 # Integer | The number of results to return in a page
|
352
|
+
# }
|
353
|
+
|
354
|
+
# res = @api_instance.list_payment_changes_v4(payor_id, updated_since, opts)
|
355
|
+
# expect(res.content.length()).to be >= 1
|
356
|
+
# expect(@api_instance).to respond_to(:list_payment_changes_v4)
|
204
357
|
end
|
205
358
|
end
|
206
359
|
|
@@ -224,13 +377,37 @@ describe 'PaymentAuditServiceApi' do
|
|
224
377
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
225
378
|
# @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
|
226
379
|
# @option opts [Integer] :page Page number. Default is 1.
|
227
|
-
# @option opts [Integer] :page_size
|
380
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
228
381
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
|
229
382
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
230
|
-
# @return [
|
383
|
+
# @return [ListPaymentsResponseV3]
|
231
384
|
describe 'list_payments_audit test' do
|
232
385
|
it 'should work' do
|
233
|
-
|
386
|
+
opts = {
|
387
|
+
payee_id: nil, # String | The UUID of the payee.
|
388
|
+
payor_id: ENV['PAYOR'], # String | The account owner Payor Id. Required for external users.
|
389
|
+
payor_name: nil, # String | The payor’s name. This filters via a case insensitive substring match.
|
390
|
+
remote_id: nil, # String | The remote id of the payees.
|
391
|
+
status: nil, # String | Payment Status
|
392
|
+
source_account_name: nil, # String | The source account name filter. This filters via a case insensitive substring match.
|
393
|
+
source_amount_from: nil, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
394
|
+
source_amount_to: nil, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
395
|
+
source_currency: nil, # String | The source currency filter. Filters based on an exact match on the currency.
|
396
|
+
payment_amount_from: nil, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
397
|
+
payment_amount_to: nil, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
398
|
+
payment_currency: nil, # String | The payment currency filter. Filters based on an exact match on the currency.
|
399
|
+
submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
400
|
+
submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
401
|
+
payment_memo: nil, # String | The payment memo filter. This filters via a case insensitive substring match.
|
402
|
+
page: 1, # Integer | Page number. Default is 1.
|
403
|
+
page_size: 25, # Integer | The number of results to return in a page
|
404
|
+
sort: 'submittedDateTime:desc', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
|
405
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
406
|
+
}
|
407
|
+
|
408
|
+
res = @api_instance.list_payments_audit(opts)
|
409
|
+
expect(res.content.length()).to be >= 1
|
410
|
+
expect(@api_instance).to respond_to(:list_payments_audit)
|
234
411
|
end
|
235
412
|
end
|
236
413
|
|
@@ -254,13 +431,37 @@ describe 'PaymentAuditServiceApi' do
|
|
254
431
|
# @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
|
255
432
|
# @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
|
256
433
|
# @option opts [Integer] :page Page number. Default is 1.
|
257
|
-
# @option opts [Integer] :page_size
|
434
|
+
# @option opts [Integer] :page_size The number of results to return in a page
|
258
435
|
# @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
|
259
436
|
# @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
260
437
|
# @return [ListPaymentsResponseV4]
|
261
438
|
describe 'list_payments_audit_v4 test' do
|
262
439
|
it 'should work' do
|
263
|
-
|
440
|
+
opts = {
|
441
|
+
payee_id: nil, # String | The UUID of the payee.
|
442
|
+
payor_id: ENV['PAYOR'], # String | The account owner Payor Id. Required for external users.
|
443
|
+
payor_name: nil, # String | The payor’s name. This filters via a case insensitive substring match.
|
444
|
+
remote_id: nil, # String | The remote id of the payees.
|
445
|
+
status: nil, # String | Payment Status
|
446
|
+
source_account_name: nil, # String | The source account name filter. This filters via a case insensitive substring match.
|
447
|
+
source_amount_from: nil, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
|
448
|
+
source_amount_to: nil, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
|
449
|
+
source_currency: nil, # String | The source currency filter. Filters based on an exact match on the currency.
|
450
|
+
payment_amount_from: nil, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
|
451
|
+
payment_amount_to: nil, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
|
452
|
+
payment_currency: nil, # String | The payment currency filter. Filters based on an exact match on the currency.
|
453
|
+
submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
|
454
|
+
submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
|
455
|
+
payment_memo: nil, # String | The payment memo filter. This filters via a case insensitive substring match.
|
456
|
+
page: 1, # Integer | Page number. Default is 1.
|
457
|
+
page_size: 25, # Integer | The number of results to return in a page
|
458
|
+
sort: 'submittedDateTime:desc', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
|
459
|
+
sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
|
460
|
+
}
|
461
|
+
|
462
|
+
res = @api_instance.list_payments_audit_v4(opts)
|
463
|
+
expect(res.content.length()).to be >= 1
|
464
|
+
expect(@api_instance).to respond_to(:list_payments_audit_v4)
|
264
465
|
end
|
265
466
|
end
|
266
467
|
|