velopayments 2.14.90.pre.1 → 2.17.8.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/Makefile +41 -9
- data/README.md +61 -23
- data/docs/AuthApi.md +8 -9
- data/docs/AuthResponse.md +3 -1
- data/docs/CompanyResponse.md +19 -0
- data/docs/{Company.md → CompanyV1.md} +2 -2
- data/docs/CreateIndividual.md +1 -1
- data/docs/CreateIndividual2.md +21 -0
- data/docs/CreatePayee.md +3 -3
- data/docs/CreatePayee2.md +37 -0
- data/docs/CreatePayeeAddress.md +1 -1
- data/docs/CreatePayeeAddress2.md +31 -0
- data/docs/CreatePayeesCSVRequest.md +1 -1
- data/docs/CreatePayeesCSVRequest2.md +73 -0
- data/docs/CreatePayeesCSVResponse2.md +19 -0
- data/docs/CreatePayeesRequest2.md +19 -0
- data/docs/CreatePaymentChannel2.md +29 -0
- data/docs/CreatePayoutRequest.md +6 -2
- data/docs/Error.md +23 -0
- data/docs/ErrorResponse.md +19 -0
- data/docs/FundingAudit.md +3 -1
- data/docs/FundingDelta.md +23 -0
- data/docs/FundingDeltaResponse.md +21 -0
- data/docs/FundingDeltaResponseLinks.md +19 -0
- data/docs/FundingEvent.md +3 -1
- data/docs/FundingManagerApi.md +33 -26
- data/docs/GetFundingsResponse.md +1 -1
- data/docs/GetFundingsResponseAllOf.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +16 -0
- data/docs/GetPayoutsResponseV4.md +3 -3
- data/docs/IndividualResponse.md +17 -0
- data/docs/{Individual.md → IndividualV1.md} +5 -5
- data/docs/{IndividualName.md → IndividualV1Name.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponse.md +2 -2
- data/docs/PagedPayeeResponse.md +23 -0
- data/docs/PagedPayeeResponse2.md +23 -0
- data/docs/PagedPayeeResponse2Summary.md +25 -0
- data/docs/{PayeeResponseLinks.md → PagedPayeeResponseLinks.md} +2 -2
- data/docs/{PayeeResponsePage.md → PagedPayeeResponsePage.md} +2 -2
- data/docs/{PayeeResponseSummary.md → PagedPayeeResponseSummary.md} +2 -2
- data/docs/Payee.md +9 -9
- data/docs/{Address.md → PayeeAddress.md} +2 -2
- data/docs/PayeeDelta.md +1 -1
- data/docs/PayeeInvitationApi.md +109 -3
- data/docs/{PaymentChannel.md → PayeePaymentChannel.md} +2 -2
- data/docs/{PayorRef.md → PayeePayorRef.md} +2 -2
- data/docs/PayeePayorRef2.md +21 -0
- data/docs/PayeeResponse.md +40 -8
- data/docs/PayeeResponse2.md +55 -0
- data/docs/PayeesApi.md +133 -4
- data/docs/PaymentAuditServiceApi.md +70 -7
- data/docs/PaymentDelta.md +31 -0
- data/docs/PaymentDeltaResponse.md +21 -0
- data/docs/PaymentResponseV4.md +4 -2
- data/docs/PaymentResponseV4Payout.md +19 -0
- data/docs/PaymentStatus.md +16 -0
- data/docs/PayorAddress.md +31 -0
- data/docs/PayorAddressV2.md +31 -0
- data/docs/PayorV1.md +9 -7
- data/docs/PayorV2.md +9 -7
- data/docs/PayorsApi.md +8 -6
- data/docs/PayoutPayorV4.md +25 -0
- data/docs/PayoutPrincipalV4.md +19 -0
- data/docs/PayoutSummaryAuditV4.md +5 -3
- data/docs/PayoutTypeV4.md +16 -0
- data/docs/QuoteFxSummary.md +2 -2
- data/docs/UpdateRemoteIdRequest.md +19 -0
- data/docs/WatchlistStatus.md +16 -0
- data/lib/velopayments.rb +41 -12
- data/lib/velopayments/api/auth_api.rb +9 -16
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +63 -55
- data/lib/velopayments/api/get_payout_api.rb +3 -3
- data/lib/velopayments/api/instruct_payout_api.rb +3 -3
- data/lib/velopayments/api/payee_invitation_api.rb +134 -8
- data/lib/velopayments/api/payees_api.rb +177 -9
- data/lib/velopayments/api/payment_audit_service_api.rb +95 -12
- data/lib/velopayments/api/payor_applications_api.rb +4 -4
- data/lib/velopayments/api/payors_api.rb +18 -19
- data/lib/velopayments/api/payout_history_api.rb +4 -4
- data/lib/velopayments/api/quote_payout_api.rb +3 -3
- data/lib/velopayments/api/submit_payout_api.rb +2 -2
- data/lib/velopayments/api/withdraw_payout_api.rb +3 -3
- data/lib/velopayments/api_client.rb +30 -30
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -2
- data/lib/velopayments/models/auth_response.rb +28 -7
- data/lib/velopayments/models/auto_top_up_config.rb +15 -3
- data/lib/velopayments/models/challenge.rb +13 -3
- data/lib/velopayments/models/company_response.rb +273 -0
- data/lib/velopayments/models/{company.rb → company_v1.rb} +18 -6
- data/lib/velopayments/models/create_individual.rb +14 -4
- data/lib/velopayments/models/create_individual2.rb +259 -0
- data/lib/velopayments/models/create_payee.rb +17 -5
- data/lib/velopayments/models/{payor_funding_bank_details_update.rb → create_payee2.rb} +153 -93
- data/lib/velopayments/models/create_payee_address.rb +19 -3
- data/lib/velopayments/models/create_payee_address2.rb +510 -0
- data/lib/velopayments/models/create_payees_csv_request.rb +14 -3
- data/lib/velopayments/models/create_payees_csv_request2.rb +1142 -0
- data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
- data/lib/velopayments/models/create_payees_csv_response2.rb +217 -0
- data/lib/velopayments/models/create_payees_request.rb +13 -3
- data/lib/velopayments/models/create_payees_request2.rb +227 -0
- data/lib/velopayments/models/create_payment_channel.rb +13 -3
- data/lib/velopayments/models/create_payment_channel2.rb +418 -0
- data/lib/velopayments/models/create_payout_request.rb +36 -9
- data/lib/velopayments/models/error.rb +271 -0
- data/lib/velopayments/models/error_response.rb +222 -0
- data/lib/velopayments/models/failed_submission.rb +13 -3
- data/lib/velopayments/models/funding_audit.rb +38 -7
- data/lib/velopayments/models/funding_delta.rb +298 -0
- data/lib/velopayments/models/funding_delta_response.rb +229 -0
- data/lib/velopayments/models/funding_delta_response_links.rb +215 -0
- data/lib/velopayments/models/funding_event.rb +26 -7
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_request_v1.rb +13 -3
- data/lib/velopayments/models/funding_request_v2.rb +13 -3
- data/lib/velopayments/models/fx_summary_v3.rb +13 -3
- data/lib/velopayments/models/fx_summary_v4.rb +13 -3
- data/lib/velopayments/models/get_fundings_response.rb +17 -5
- data/lib/velopayments/models/get_fundings_response_all_of.rb +17 -5
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +15 -5
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +87 -4
- data/lib/velopayments/models/get_payout_statistics.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v3_summary.rb +13 -3
- data/lib/velopayments/models/get_payouts_response_v4.rb +16 -6
- data/lib/velopayments/models/individual_response.rb +211 -0
- data/lib/velopayments/models/{individual.rb → individual_v1.rb} +17 -7
- data/lib/velopayments/models/{individual_name.rb → individual_v1_name.rb} +16 -6
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status_response.rb +13 -3
- data/lib/velopayments/models/invite_payee_request.rb +13 -3
- data/lib/velopayments/models/language.rb +2 -2
- data/lib/velopayments/models/list_payments_response.rb +13 -3
- data/lib/velopayments/models/list_payments_response_page.rb +13 -3
- data/lib/velopayments/models/list_payments_response_summary.rb +13 -3
- data/lib/velopayments/models/list_source_account_response.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
- data/lib/velopayments/models/list_source_account_response_v2_page.rb +13 -3
- data/lib/velopayments/models/marketing_opt_in.rb +13 -3
- data/lib/velopayments/models/notifications.rb +13 -3
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +15 -5
- data/lib/velopayments/models/paged_payee_response.rb +238 -0
- data/lib/velopayments/models/paged_payee_response2.rb +238 -0
- data/lib/velopayments/models/paged_payee_response2_summary.rb +242 -0
- data/lib/velopayments/models/{payee_response_links.rb → paged_payee_response_links.rb} +16 -6
- data/lib/velopayments/models/{payee_response_page.rb → paged_payee_response_page.rb} +16 -6
- data/lib/velopayments/models/{payee_response_summary.rb → paged_payee_response_summary.rb} +16 -6
- data/lib/velopayments/models/paged_response.rb +13 -3
- data/lib/velopayments/models/paged_response_page.rb +13 -3
- data/lib/velopayments/models/payee.rb +24 -8
- data/lib/velopayments/models/{address.rb → payee_address.rb} +21 -6
- data/lib/velopayments/models/payee_delta.rb +14 -3
- data/lib/velopayments/models/payee_delta_response.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
- data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status.rb +13 -3
- data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
- data/lib/velopayments/models/{payment_channel.rb → payee_payment_channel.rb} +16 -6
- data/lib/velopayments/models/{payor_ref.rb → payee_payor_ref.rb} +16 -6
- data/lib/velopayments/models/payee_payor_ref2.rb +224 -0
- data/lib/velopayments/models/payee_response.rb +192 -32
- data/lib/velopayments/models/payee_response2.rb +388 -0
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +13 -3
- data/lib/velopayments/models/payment_channel_rule.rb +13 -3
- data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
- data/lib/velopayments/models/payment_delta.rb +285 -0
- data/lib/velopayments/models/payment_delta_response.rb +229 -0
- data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
- data/lib/velopayments/models/payment_instruction.rb +13 -3
- data/lib/velopayments/models/payment_response_v3.rb +13 -3
- data/lib/velopayments/models/payment_response_v4.rb +27 -7
- data/lib/velopayments/models/payment_response_v4_payout.rb +215 -0
- data/lib/velopayments/models/payment_status.rb +42 -0
- data/lib/velopayments/models/payor_address.rb +493 -0
- data/lib/velopayments/models/payor_address_v2.rb +493 -0
- data/lib/velopayments/models/payor_branding_response.rb +16 -3
- data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
- data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
- data/lib/velopayments/models/payor_create_application_request.rb +14 -3
- data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
- data/lib/velopayments/models/payor_links_response.rb +13 -3
- data/lib/velopayments/models/payor_links_response_links.rb +13 -3
- data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
- data/lib/velopayments/models/payor_logo_request.rb +13 -3
- data/lib/velopayments/models/payor_v1.rb +27 -8
- data/lib/velopayments/models/payor_v2.rb +27 -8
- data/lib/velopayments/models/payout_payor_v4.rb +273 -0
- data/lib/velopayments/models/payout_principal_v4.rb +228 -0
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/payout_status_v4.rb +2 -2
- data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
- data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -8
- data/lib/velopayments/models/payout_summary_response.rb +13 -3
- data/lib/velopayments/models/payout_type_v4.rb +37 -0
- data/lib/velopayments/models/query_batch_response.rb +13 -3
- data/lib/velopayments/models/quote_fx_summary.rb +69 -3
- data/lib/velopayments/models/quote_response.rb +13 -3
- data/lib/velopayments/models/rejected_payment.rb +13 -3
- data/lib/velopayments/models/set_notifications_request.rb +13 -3
- data/lib/velopayments/models/source_account.rb +13 -3
- data/lib/velopayments/models/source_account_response.rb +15 -3
- data/lib/velopayments/models/source_account_response_v2.rb +15 -3
- data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
- data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
- data/lib/velopayments/models/supported_countries_response.rb +13 -3
- data/lib/velopayments/models/supported_country.rb +13 -3
- data/lib/velopayments/models/supported_currency.rb +13 -3
- data/lib/velopayments/models/supported_currency_response.rb +13 -3
- data/lib/velopayments/models/update_remote_id_request.rb +253 -0
- data/lib/velopayments/models/watchlist_status.rb +39 -0
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +2 -2
- data/spec/api/auth_api_spec.rb +3 -4
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +17 -15
- data/spec/api/get_payout_api_spec.rb +2 -2
- data/spec/api/instruct_payout_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +27 -3
- data/spec/api/payees_api_spec.rb +39 -4
- data/spec/api/payment_audit_service_api_spec.rb +21 -5
- data/spec/api/payor_applications_api_spec.rb +2 -2
- data/spec/api/payors_api_spec.rb +5 -4
- data/spec/api/payout_history_api_spec.rb +2 -2
- data/spec/api/quote_payout_api_spec.rb +2 -2
- data/spec/api/submit_payout_api_spec.rb +2 -2
- data/spec/api/withdraw_payout_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/auth_response_spec.rb +8 -2
- data/spec/models/auto_top_up_config_spec.rb +2 -2
- data/spec/models/challenge_spec.rb +2 -2
- data/spec/models/company_response_spec.rb +47 -0
- data/spec/models/{company_spec.rb → company_v1_spec.rb} +8 -8
- data/spec/models/{payor_funding_bank_details_update_spec.rb → create_individual2_spec.rb} +11 -11
- data/spec/models/create_individual_spec.rb +2 -2
- data/spec/models/create_payee2_spec.rb +101 -0
- data/spec/models/create_payee_address2_spec.rb +87 -0
- 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 +225 -0
- data/spec/models/create_payees_csv_request_spec.rb +2 -2
- data/spec/models/create_payees_csv_response2_spec.rb +47 -0
- data/spec/models/create_payees_csv_response_spec.rb +2 -2
- data/spec/models/create_payees_request2_spec.rb +47 -0
- data/spec/models/create_payees_request_spec.rb +2 -2
- data/spec/models/create_payment_channel2_spec.rb +85 -0
- data/spec/models/create_payment_channel_spec.rb +2 -2
- data/spec/models/create_payout_request_spec.rb +14 -2
- data/spec/models/error_response_spec.rb +47 -0
- data/spec/models/error_spec.rb +63 -0
- data/spec/models/failed_submission_spec.rb +2 -2
- data/spec/models/funding_audit_spec.rb +12 -2
- data/spec/models/funding_delta_response_links_spec.rb +47 -0
- data/spec/models/funding_delta_response_spec.rb +53 -0
- data/spec/models/funding_delta_spec.rb +59 -0
- data/spec/models/funding_event_spec.rb +8 -2
- data/spec/models/funding_event_type_spec.rb +2 -2
- data/spec/models/funding_request_v1_spec.rb +2 -2
- data/spec/models/funding_request_v2_spec.rb +2 -2
- data/spec/models/fx_summary_v3_spec.rb +2 -2
- data/spec/models/fx_summary_v4_spec.rb +2 -2
- data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
- data/spec/models/get_fundings_response_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +50 -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_v3_summary_spec.rb +2 -2
- data/spec/models/get_payouts_response_v4_spec.rb +2 -2
- data/spec/models/individual_response_spec.rb +41 -0
- data/spec/models/{individual_name_spec.rb → individual_v1_name_spec.rb} +8 -8
- data/spec/models/{individual_spec.rb → individual_v1_spec.rb} +8 -8
- data/spec/models/invitation_status_response_spec.rb +2 -2
- data/spec/models/invitation_status_spec.rb +2 -2
- data/spec/models/invite_payee_request_spec.rb +2 -2
- data/spec/models/language_spec.rb +2 -2
- data/spec/models/list_payments_response_page_spec.rb +2 -2
- data/spec/models/list_payments_response_spec.rb +2 -2
- data/spec/models/list_payments_response_summary_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_page_spec.rb +2 -2
- data/spec/models/list_source_account_response_v2_spec.rb +2 -2
- data/spec/models/marketing_opt_in_spec.rb +2 -2
- data/spec/models/notifications_spec.rb +2 -2
- data/spec/models/ofac_status_spec.rb +2 -2
- data/spec/models/onboarded_status_spec.rb +2 -2
- data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/paged_payee_response2_spec.rb +59 -0
- data/spec/models/paged_payee_response2_summary_spec.rb +65 -0
- data/spec/models/{payee_response_links_spec.rb → paged_payee_response_links_spec.rb} +8 -8
- data/spec/models/{payee_response_page_spec.rb → paged_payee_response_page_spec.rb} +8 -8
- data/spec/models/paged_payee_response_spec.rb +59 -0
- data/spec/models/{payee_response_summary_spec.rb → paged_payee_response_summary_spec.rb} +8 -8
- data/spec/models/paged_response_page_spec.rb +2 -2
- data/spec/models/paged_response_spec.rb +2 -2
- data/spec/models/{address_spec.rb → payee_address_spec.rb} +8 -8
- data/spec/models/payee_delta_response_links_spec.rb +2 -2
- data/spec/models/payee_delta_response_page_spec.rb +2 -2
- data/spec/models/payee_delta_response_spec.rb +2 -2
- data/spec/models/payee_delta_spec.rb +2 -2
- data/spec/models/payee_invitation_status_response_spec.rb +2 -2
- data/spec/models/payee_invitation_status_spec.rb +2 -2
- data/spec/models/{payment_channel_spec.rb → payee_payment_channel_spec.rb} +8 -8
- data/spec/models/payee_payor_ref2_spec.rb +53 -0
- data/spec/models/{payor_ref_spec.rb → payee_payor_ref_spec.rb} +8 -8
- data/spec/models/payee_response2_spec.rb +155 -0
- data/spec/models/payee_response_spec.rb +102 -6
- data/spec/models/payee_spec.rb +2 -2
- data/spec/models/payee_type_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
- data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
- data/spec/models/payment_channel_country_spec.rb +2 -2
- data/spec/models/payment_channel_rule_spec.rb +2 -2
- data/spec/models/payment_channel_rules_response_spec.rb +2 -2
- data/spec/models/payment_delta_response_spec.rb +53 -0
- data/spec/models/payment_delta_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 +2 -2
- data/spec/models/payment_response_v3_spec.rb +2 -2
- data/spec/models/payment_response_v4_payout_spec.rb +47 -0
- data/spec/models/payment_response_v4_spec.rb +8 -2
- data/spec/models/payment_status_spec.rb +35 -0
- data/spec/models/payor_address_spec.rb +83 -0
- data/spec/models/payor_address_v2_spec.rb +83 -0
- data/spec/models/payor_branding_response_spec.rb +2 -2
- data/spec/models/payor_create_api_key_request_spec.rb +2 -2
- data/spec/models/payor_create_api_key_response_spec.rb +2 -2
- data/spec/models/payor_create_application_request_spec.rb +2 -2
- data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
- data/spec/models/payor_links_response_links_spec.rb +2 -2
- data/spec/models/payor_links_response_payors_spec.rb +2 -2
- data/spec/models/payor_links_response_spec.rb +2 -2
- data/spec/models/payor_logo_request_spec.rb +2 -2
- data/spec/models/payor_v1_spec.rb +8 -2
- data/spec/models/payor_v2_spec.rb +8 -2
- data/spec/models/payout_payor_v4_spec.rb +65 -0
- data/spec/models/payout_principal_v4_spec.rb +47 -0
- 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 +2 -2
- data/spec/models/payout_type_v4_spec.rb +35 -0
- data/spec/models/query_batch_response_spec.rb +2 -2
- data/spec/models/quote_fx_summary_spec.rb +10 -2
- data/spec/models/quote_response_spec.rb +2 -2
- data/spec/models/rejected_payment_spec.rb +2 -2
- data/spec/models/set_notifications_request_spec.rb +2 -2
- data/spec/models/source_account_response_spec.rb +2 -2
- data/spec/models/source_account_response_v2_spec.rb +2 -2
- data/spec/models/source_account_spec.rb +2 -2
- data/spec/models/source_account_summary_v3_spec.rb +2 -2
- data/spec/models/source_account_summary_v4_spec.rb +2 -2
- data/spec/models/supported_countries_response_spec.rb +2 -2
- data/spec/models/supported_country_spec.rb +2 -2
- data/spec/models/supported_currency_response_spec.rb +2 -2
- data/spec/models/supported_currency_spec.rb +2 -2
- data/spec/models/update_remote_id_request_spec.rb +47 -0
- data/spec/models/watchlist_status_spec.rb +35 -0
- data/spec/spec_helper.rb +2 -2
- data/velopayments.gemspec +2 -8
- metadata +252 -259
- data/Gemfile.lock +0 -79
- data/docs/PayorFundingBankDetailsUpdate.md +0 -21
- data/velopayments-2.11.73.gem +0 -0
- data/velopayments-2.14.90.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.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -78,6 +78,12 @@ module VeloPayments
|
|
78
78
|
}
|
79
79
|
end
|
80
80
|
|
81
|
+
# List of attributes with nullable: true
|
82
|
+
def self.openapi_nullable
|
83
|
+
Set.new([
|
84
|
+
])
|
85
|
+
end
|
86
|
+
|
81
87
|
# Initializes the object
|
82
88
|
# @param [Hash] attributes Model attributes in the form of hash
|
83
89
|
def initialize(attributes = {})
|
@@ -296,7 +302,11 @@ module VeloPayments
|
|
296
302
|
hash = {}
|
297
303
|
self.class.attribute_map.each_pair do |attr, param|
|
298
304
|
value = self.send(attr)
|
299
|
-
|
305
|
+
if value.nil?
|
306
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
307
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
308
|
+
end
|
309
|
+
|
300
310
|
hash[param] = _to_hash(value)
|
301
311
|
end
|
302
312
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -16,6 +16,7 @@ module VeloPayments
|
|
16
16
|
class PayoutSummaryAuditV4
|
17
17
|
attr_accessor :payout_id
|
18
18
|
|
19
|
+
# Deprecated in v2.16. Will be populated with submitting payor ID until removed in a later release.
|
19
20
|
attr_accessor :payor_id
|
20
21
|
|
21
22
|
attr_accessor :status
|
@@ -40,6 +41,8 @@ module VeloPayments
|
|
40
41
|
|
41
42
|
attr_accessor :payout_memo
|
42
43
|
|
44
|
+
attr_accessor :payout_type
|
45
|
+
|
43
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
44
47
|
def self.attribute_map
|
45
48
|
{
|
@@ -55,7 +58,8 @@ module VeloPayments
|
|
55
58
|
:'total_returned_payments' => :'totalReturnedPayments',
|
56
59
|
:'source_account_summary' => :'sourceAccountSummary',
|
57
60
|
:'fx_summaries' => :'fxSummaries',
|
58
|
-
:'payout_memo' => :'payoutMemo'
|
61
|
+
:'payout_memo' => :'payoutMemo',
|
62
|
+
:'payout_type' => :'payoutType'
|
59
63
|
}
|
60
64
|
end
|
61
65
|
|
@@ -68,16 +72,23 @@ module VeloPayments
|
|
68
72
|
:'date_time' => :'DateTime',
|
69
73
|
:'submitted_date_time' => :'String',
|
70
74
|
:'instructed_date_time' => :'String',
|
71
|
-
:'withdrawn_date_time' => :'
|
75
|
+
:'withdrawn_date_time' => :'DateTime',
|
72
76
|
:'total_payments' => :'Integer',
|
73
77
|
:'total_incomplete_payments' => :'Integer',
|
74
78
|
:'total_returned_payments' => :'Integer',
|
75
79
|
:'source_account_summary' => :'Array<SourceAccountSummaryV4>',
|
76
80
|
:'fx_summaries' => :'Array<FxSummaryV4>',
|
77
|
-
:'payout_memo' => :'String'
|
81
|
+
:'payout_memo' => :'String',
|
82
|
+
:'payout_type' => :'PayoutTypeV4'
|
78
83
|
}
|
79
84
|
end
|
80
85
|
|
86
|
+
# List of attributes with nullable: true
|
87
|
+
def self.openapi_nullable
|
88
|
+
Set.new([
|
89
|
+
])
|
90
|
+
end
|
91
|
+
|
81
92
|
# Initializes the object
|
82
93
|
# @param [Hash] attributes Model attributes in the form of hash
|
83
94
|
def initialize(attributes = {})
|
@@ -148,6 +159,10 @@ module VeloPayments
|
|
148
159
|
if attributes.key?(:'payout_memo')
|
149
160
|
self.payout_memo = attributes[:'payout_memo']
|
150
161
|
end
|
162
|
+
|
163
|
+
if attributes.key?(:'payout_type')
|
164
|
+
self.payout_type = attributes[:'payout_type']
|
165
|
+
end
|
151
166
|
end
|
152
167
|
|
153
168
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -166,6 +181,10 @@ module VeloPayments
|
|
166
181
|
invalid_properties.push('invalid value for "submitted_date_time", submitted_date_time cannot be nil.')
|
167
182
|
end
|
168
183
|
|
184
|
+
if @payout_type.nil?
|
185
|
+
invalid_properties.push('invalid value for "payout_type", payout_type cannot be nil.')
|
186
|
+
end
|
187
|
+
|
169
188
|
invalid_properties
|
170
189
|
end
|
171
190
|
|
@@ -175,6 +194,7 @@ module VeloPayments
|
|
175
194
|
return false if @payout_id.nil?
|
176
195
|
return false if @status.nil?
|
177
196
|
return false if @submitted_date_time.nil?
|
197
|
+
return false if @payout_type.nil?
|
178
198
|
true
|
179
199
|
end
|
180
200
|
|
@@ -195,7 +215,8 @@ module VeloPayments
|
|
195
215
|
total_returned_payments == o.total_returned_payments &&
|
196
216
|
source_account_summary == o.source_account_summary &&
|
197
217
|
fx_summaries == o.fx_summaries &&
|
198
|
-
payout_memo == o.payout_memo
|
218
|
+
payout_memo == o.payout_memo &&
|
219
|
+
payout_type == o.payout_type
|
199
220
|
end
|
200
221
|
|
201
222
|
# @see the `==` method
|
@@ -207,7 +228,7 @@ module VeloPayments
|
|
207
228
|
# Calculates hash code according to all attributes.
|
208
229
|
# @return [Integer] Hash code
|
209
230
|
def hash
|
210
|
-
[payout_id, payor_id, status, date_time, submitted_date_time, instructed_date_time, withdrawn_date_time, total_payments, total_incomplete_payments, total_returned_payments, source_account_summary, fx_summaries, payout_memo].hash
|
231
|
+
[payout_id, payor_id, status, date_time, submitted_date_time, instructed_date_time, withdrawn_date_time, total_payments, total_incomplete_payments, total_returned_payments, source_account_summary, fx_summaries, payout_memo, payout_type].hash
|
211
232
|
end
|
212
233
|
|
213
234
|
# Builds the object from hash
|
@@ -296,7 +317,11 @@ module VeloPayments
|
|
296
317
|
hash = {}
|
297
318
|
self.class.attribute_map.each_pair do |attr, param|
|
298
319
|
value = self.send(attr)
|
299
|
-
|
320
|
+
if value.nil?
|
321
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
322
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
323
|
+
end
|
324
|
+
|
300
325
|
hash[param] = _to_hash(value)
|
301
326
|
end
|
302
327
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -58,6 +58,12 @@ module VeloPayments
|
|
58
58
|
}
|
59
59
|
end
|
60
60
|
|
61
|
+
# List of attributes with nullable: true
|
62
|
+
def self.openapi_nullable
|
63
|
+
Set.new([
|
64
|
+
])
|
65
|
+
end
|
66
|
+
|
61
67
|
# Initializes the object
|
62
68
|
# @param [Hash] attributes Model attributes in the form of hash
|
63
69
|
def initialize(attributes = {})
|
@@ -253,7 +259,11 @@ module VeloPayments
|
|
253
259
|
hash = {}
|
254
260
|
self.class.attribute_map.each_pair do |attr, param|
|
255
261
|
value = self.send(attr)
|
256
|
-
|
262
|
+
if value.nil?
|
263
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
264
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
265
|
+
end
|
266
|
+
|
257
267
|
hash[param] = _to_hash(value)
|
258
268
|
end
|
259
269
|
hash
|
@@ -0,0 +1,37 @@
|
|
1
|
+
=begin
|
2
|
+
#Velo Payments APIs
|
3
|
+
|
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
|
+
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module VeloPayments
|
16
|
+
class PayoutTypeV4
|
17
|
+
STANDARD = "STANDARD".freeze
|
18
|
+
AS = "AS".freeze
|
19
|
+
ON_BEHALF_OF = "ON_BEHALF_OF".freeze
|
20
|
+
|
21
|
+
# Builds the enum from string
|
22
|
+
# @param [String] The enum value in the form of the string
|
23
|
+
# @return [String] The enum value
|
24
|
+
def self.build_from_hash(value)
|
25
|
+
new.build_from_hash(value)
|
26
|
+
end
|
27
|
+
|
28
|
+
# Builds the enum from string
|
29
|
+
# @param [String] The enum value in the form of the string
|
30
|
+
# @return [String] The enum value
|
31
|
+
def build_from_hash(value)
|
32
|
+
constantValues = PayoutTypeV4.constants.select { |c| PayoutTypeV4::const_get(c) == value }
|
33
|
+
raise "Invalid ENUM value #{value} for class #PayoutTypeV4" if constantValues.empty?
|
34
|
+
value
|
35
|
+
end
|
36
|
+
end
|
37
|
+
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.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -65,6 +65,12 @@ module VeloPayments
|
|
65
65
|
}
|
66
66
|
end
|
67
67
|
|
68
|
+
# List of attributes with nullable: true
|
69
|
+
def self.openapi_nullable
|
70
|
+
Set.new([
|
71
|
+
])
|
72
|
+
end
|
73
|
+
|
68
74
|
# Initializes the object
|
69
75
|
# @param [Hash] attributes Model attributes in the form of hash
|
70
76
|
def initialize(attributes = {})
|
@@ -233,7 +239,11 @@ module VeloPayments
|
|
233
239
|
hash = {}
|
234
240
|
self.class.attribute_map.each_pair do |attr, param|
|
235
241
|
value = self.send(attr)
|
236
|
-
|
242
|
+
if value.nil?
|
243
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
244
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
245
|
+
end
|
246
|
+
|
237
247
|
hash[param] = _to_hash(value)
|
238
248
|
end
|
239
249
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -36,6 +36,28 @@ module VeloPayments
|
|
36
36
|
|
37
37
|
attr_accessor :status
|
38
38
|
|
39
|
+
class EnumAttributeValidator
|
40
|
+
attr_reader :datatype
|
41
|
+
attr_reader :allowable_values
|
42
|
+
|
43
|
+
def initialize(datatype, allowable_values)
|
44
|
+
@allowable_values = allowable_values.map do |value|
|
45
|
+
case datatype.to_s
|
46
|
+
when /Integer/i
|
47
|
+
value.to_i
|
48
|
+
when /Float/i
|
49
|
+
value.to_f
|
50
|
+
else
|
51
|
+
value
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
def valid?(value)
|
57
|
+
!value || allowable_values.include?(value)
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
39
61
|
# Attribute mapping from ruby-style variable name to JSON key.
|
40
62
|
def self.attribute_map
|
41
63
|
{
|
@@ -70,6 +92,12 @@ module VeloPayments
|
|
70
92
|
}
|
71
93
|
end
|
72
94
|
|
95
|
+
# List of attributes with nullable: true
|
96
|
+
def self.openapi_nullable
|
97
|
+
Set.new([
|
98
|
+
])
|
99
|
+
end
|
100
|
+
|
73
101
|
# Initializes the object
|
74
102
|
# @param [Hash] attributes Model attributes in the form of hash
|
75
103
|
def initialize(attributes = {})
|
@@ -178,6 +206,14 @@ module VeloPayments
|
|
178
206
|
invalid_properties.push('invalid value for "payment_currency", the character length must be great than or equal to 3.')
|
179
207
|
end
|
180
208
|
|
209
|
+
if @funding_status.nil?
|
210
|
+
invalid_properties.push('invalid value for "funding_status", funding_status cannot be nil.')
|
211
|
+
end
|
212
|
+
|
213
|
+
if @status.nil?
|
214
|
+
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
215
|
+
end
|
216
|
+
|
181
217
|
invalid_properties
|
182
218
|
end
|
183
219
|
|
@@ -195,6 +231,12 @@ module VeloPayments
|
|
195
231
|
return false if @payment_currency.nil?
|
196
232
|
return false if @payment_currency.to_s.length > 3
|
197
233
|
return false if @payment_currency.to_s.length < 3
|
234
|
+
return false if @funding_status.nil?
|
235
|
+
funding_status_validator = EnumAttributeValidator.new('String', ["UNFUNDED", "INSTRUCTED", "FUNDED"])
|
236
|
+
return false unless funding_status_validator.valid?(@funding_status)
|
237
|
+
return false if @status.nil?
|
238
|
+
status_validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED", "REJECTED"])
|
239
|
+
return false unless status_validator.valid?(@status)
|
198
240
|
true
|
199
241
|
end
|
200
242
|
|
@@ -234,6 +276,26 @@ module VeloPayments
|
|
234
276
|
@payment_currency = payment_currency
|
235
277
|
end
|
236
278
|
|
279
|
+
# Custom attribute writer method checking allowed values (enum).
|
280
|
+
# @param [Object] funding_status Object to be assigned
|
281
|
+
def funding_status=(funding_status)
|
282
|
+
validator = EnumAttributeValidator.new('String', ["UNFUNDED", "INSTRUCTED", "FUNDED"])
|
283
|
+
unless validator.valid?(funding_status)
|
284
|
+
fail ArgumentError, "invalid value for \"funding_status\", must be one of #{validator.allowable_values}."
|
285
|
+
end
|
286
|
+
@funding_status = funding_status
|
287
|
+
end
|
288
|
+
|
289
|
+
# Custom attribute writer method checking allowed values (enum).
|
290
|
+
# @param [Object] status Object to be assigned
|
291
|
+
def status=(status)
|
292
|
+
validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED", "REJECTED"])
|
293
|
+
unless validator.valid?(status)
|
294
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
|
295
|
+
end
|
296
|
+
@status = status
|
297
|
+
end
|
298
|
+
|
237
299
|
# Checks equality by comparing each attribute.
|
238
300
|
# @param [Object] Object to be compared
|
239
301
|
def ==(o)
|
@@ -350,7 +412,11 @@ module VeloPayments
|
|
350
412
|
hash = {}
|
351
413
|
self.class.attribute_map.each_pair do |attr, param|
|
352
414
|
value = self.send(attr)
|
353
|
-
|
415
|
+
if value.nil?
|
416
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
417
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
418
|
+
end
|
419
|
+
|
354
420
|
hash[param] = _to_hash(value)
|
355
421
|
end
|
356
422
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.17.8
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.2.3-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -30,6 +30,12 @@ module VeloPayments
|
|
30
30
|
}
|
31
31
|
end
|
32
32
|
|
33
|
+
# List of attributes with nullable: true
|
34
|
+
def self.openapi_nullable
|
35
|
+
Set.new([
|
36
|
+
])
|
37
|
+
end
|
38
|
+
|
33
39
|
# Initializes the object
|
34
40
|
# @param [Hash] attributes Model attributes in the form of hash
|
35
41
|
def initialize(attributes = {})
|
@@ -171,7 +177,11 @@ module VeloPayments
|
|
171
177
|
hash = {}
|
172
178
|
self.class.attribute_map.each_pair do |attr, param|
|
173
179
|
value = self.send(attr)
|
174
|
-
|
180
|
+
if value.nil?
|
181
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
182
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
183
|
+
end
|
184
|
+
|
175
185
|
hash[param] = _to_hash(value)
|
176
186
|
end
|
177
187
|
hash
|