velopayments 2.29.128.beta1 → 2.35.58
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/Gemfile.lock +72 -0
- data/Makefile +21 -37
- data/README.md +122 -144
- data/docs/AcceptedPaymentV3.md +16 -14
- data/docs/AuthResponse.md +1 -1
- data/docs/{AutoTopUpConfig.md → AutoTopUpConfigV2.md} +2 -2
- data/docs/{AutoTopUpConfig2.md → AutoTopUpConfigV3.md} +2 -2
- data/docs/{Challenge.md → ChallengeV3.md} +2 -2
- data/docs/{Challenge2.md → ChallengeV4.md} +2 -2
- data/docs/{Company2.md → CompanyV3.md} +2 -2
- data/docs/{Company.md → CompanyV4.md} +2 -2
- data/docs/CreateFundingAccountRequestV2.md +4 -4
- data/docs/{CreateIndividual.md → CreateIndividualV3.md} +3 -3
- data/docs/{CreateIndividualName.md → CreateIndividualV3Name.md} +2 -2
- data/docs/{CreateIndividual2.md → CreateIndividualV4.md} +3 -3
- data/docs/{CreatePayeeAddress.md → CreatePayeeAddressV3.md} +2 -2
- data/docs/{PayeeAddress2.md → CreatePayeeAddressV4.md} +3 -3
- data/docs/{CreatePayee.md → CreatePayeeV3.md} +8 -8
- data/docs/CreatePayeeV4.md +34 -0
- data/docs/{CreatePayeesCSVRequest.md → CreatePayeesCSVRequestV3.md} +6 -6
- data/docs/{CreatePayeesCSVRequest2.md → CreatePayeesCSVRequestV4.md} +6 -6
- data/docs/{CreatePayeesCSVResponse.md → CreatePayeesCSVResponseV3.md} +3 -3
- data/docs/{CreatePayeesCSVResponseRejectedCsvRows.md → CreatePayeesCSVResponseV3RejectedCsvRows.md} +2 -2
- data/docs/{CreatePayeesCSVResponse2.md → CreatePayeesCSVResponseV4.md} +3 -3
- data/docs/{CreatePayeesRequest2.md → CreatePayeesRequestV3.md} +3 -3
- data/docs/{CreatePayeesRequest.md → CreatePayeesRequestV4.md} +3 -3
- data/docs/{CreatePaymentChannel.md → CreatePaymentChannelV3.md} +6 -6
- data/docs/{CreatePaymentChannel2.md → CreatePaymentChannelV4.md} +6 -6
- data/docs/{FailedPayee.md → FailedPayeeV3.md} +8 -8
- data/docs/{FailedPayee2.md → FailedPayeeV4.md} +9 -9
- data/docs/{FailedSubmission.md → FailedSubmissionV3.md} +3 -3
- data/docs/{FailedSubmission2.md → FailedSubmissionV4.md} +3 -3
- data/docs/{FundingAccountResponse2.md → FundingAccountResponseV2.md} +4 -4
- data/docs/FundingApi.md +459 -0
- data/docs/FundingAudit.md +3 -3
- data/docs/FundingEvent.md +1 -1
- data/docs/FundingResponse.md +44 -0
- data/docs/FxSummary.md +6 -6
- data/docs/FxSummaryV3.md +4 -4
- data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md} +2 -2
- data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md} +2 -2
- data/docs/GetPayeeListResponseIndividualV3.md +18 -0
- data/docs/GetPayeeListResponseIndividualV4.md +18 -0
- data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md} +8 -8
- data/docs/{GetPayeeListResponse2.md → GetPayeeListResponseV4.md} +9 -9
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +1 -1
- data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +2 -2
- data/docs/GetPayoutsResponse.md +2 -2
- data/docs/{Individual.md → IndividualV3.md} +3 -3
- data/docs/{IndividualName.md → IndividualV3Name.md} +2 -2
- data/docs/{Individual2.md → IndividualV4.md} +3 -3
- data/docs/{InstructPayoutRequest.md → InstructPayoutRequestV3.md} +2 -2
- data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
- data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
- data/docs/ListFundingAccountsResponseV2.md +22 -0
- data/docs/{ListSourceAccountResponseLinks.md → ListFundingAccountsResponseV2Links.md} +2 -2
- data/docs/{ListSourceAccountResponsePage.md → ListFundingAccountsResponseV2Page.md} +2 -2
- data/docs/LoginApi.md +1 -1
- data/docs/{Name.md → NameV3.md} +2 -2
- data/docs/{Name2.md → NameV4.md} +2 -2
- data/docs/Notification.md +2 -2
- data/docs/NotificationSource.md +94 -0
- data/docs/{Notifications.md → NotificationsV2.md} +2 -2
- data/docs/{Notifications2.md → NotificationsV3.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponseV3.md +22 -0
- data/docs/{PagedPayeeInvitationStatusResponsePage.md → PagedPayeeInvitationStatusResponseV3Page.md} +2 -2
- data/docs/PagedPayeeInvitationStatusResponseV4.md +22 -0
- data/docs/PagedPayeeResponseV3.md +24 -0
- data/docs/{PagedPayeeResponseLinks.md → PagedPayeeResponseV3Links.md} +2 -2
- data/docs/{PagedPayeeResponsePage.md → PagedPayeeResponseV3Page.md} +2 -2
- data/docs/{PagedPayeeResponseSummary.md → PagedPayeeResponseV3Summary.md} +2 -2
- data/docs/PagedPayeeResponseV4.md +24 -0
- data/docs/PagedPaymentsResponseV3.md +2 -2
- data/docs/{PayableIssue.md → PayableIssueV3.md} +2 -2
- data/docs/{PayableIssue2.md → PayableIssueV4.md} +2 -2
- data/docs/{CreatePayeeAddress2.md → PayeeAddressV3.md} +3 -3
- data/docs/{PayeeAddress.md → PayeeAddressV4.md} +2 -2
- data/docs/PayeeDeltaResponseV3.md +22 -0
- data/docs/{PayeeDeltaResponseLinks.md → PayeeDeltaResponseV3Links.md} +2 -2
- data/docs/{PayeeDeltaResponsePage.md → PayeeDeltaResponseV3Page.md} +2 -2
- data/docs/PayeeDeltaResponseV4.md +22 -0
- data/docs/{PayeeDeltaResponse2Links.md → PayeeDeltaResponseV4Links.md} +2 -2
- data/docs/{PayeeDelta.md → PayeeDeltaV3.md} +3 -3
- data/docs/{PayeeDelta2.md → PayeeDeltaV4.md} +4 -4
- data/docs/{PayeeDetailResponse2.md → PayeeDetailResponseV3.md} +11 -11
- data/docs/{PayeeDetailResponse.md → PayeeDetailResponseV4.md} +10 -10
- data/docs/PayeeInvitationApi.md +111 -111
- data/docs/{PayeeInvitationStatusResponse.md → PayeeInvitationStatusResponseV3.md} +3 -3
- data/docs/{PayeeInvitationStatusResponse2.md → PayeeInvitationStatusResponseV4.md} +3 -3
- data/docs/PayeePayorRefV3.md +2 -2
- data/docs/{PayeePayorRef.md → PayeePayorRefV4.md} +4 -4
- data/docs/{OfacStatus.md → PayeeTypeEnum.md} +2 -2
- data/docs/PayeesApi.md +62 -62
- data/docs/PaymentAuditServiceApi.md +12 -4
- data/docs/PaymentChannelRule.md +3 -1
- data/docs/PaymentDeltaResponse.md +2 -2
- data/docs/PaymentDeltaResponseV1.md +2 -2
- data/docs/PaymentEventResponse.md +12 -6
- data/docs/PaymentEventResponseV3.md +3 -3
- data/docs/PaymentInstructionV3.md +3 -3
- data/docs/PaymentResponseV3.md +6 -4
- data/docs/PaymentResponseV4.md +13 -7
- data/docs/PaymentV3.md +23 -21
- data/docs/PayorBrandingResponse.md +3 -3
- data/docs/PayorCreateApiKeyRequest.md +2 -2
- data/docs/PayorHierarchyApi.md +83 -0
- data/docs/PayorLinksResponseLinks.md +1 -1
- data/docs/PayorLinksResponsePayors.md +1 -1
- data/docs/PayorV1.md +2 -2
- data/docs/PayorV2.md +9 -5
- data/docs/PayorsApi.md +41 -117
- data/docs/PayoutSchedule.md +2 -2
- data/docs/{PayoutSchedule2.md → PayoutScheduleV3.md} +4 -4
- data/docs/PayoutSummaryAudit.md +2 -2
- data/docs/PayoutSummaryAuditV3.md +1 -1
- data/docs/PayoutSummaryResponseV3.md +10 -10
- data/docs/{PayoutServiceApi.md → PayoutsApi.md} +42 -42
- data/docs/PostInstructFxInfo.md +24 -0
- data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md} +4 -4
- data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md} +4 -4
- data/docs/QuoteFxSummaryV3.md +15 -15
- data/docs/RejectedPaymentV3.md +16 -16
- data/docs/{SchedulePayoutRequest.md → SchedulePayoutRequestV3.md} +2 -2
- data/docs/SetNotificationsRequest2.md +18 -0
- data/docs/SourceAccountResponseV2.md +2 -2
- data/docs/SourceAccountResponseV3.md +4 -4
- data/docs/SourceAccountSummary.md +2 -2
- data/docs/SourceAccountSummaryV3.md +1 -1
- data/docs/SourceAccountV3.md +5 -5
- data/docs/SourceAccountsApi.md +603 -0
- data/docs/{TransferRequest.md → TransferRequestV2.md} +2 -2
- data/docs/{TransferRequest2.md → TransferRequestV3.md} +3 -3
- data/docs/{UpdatePayeeDetailsRequest.md → UpdatePayeeDetailsRequestV3.md} +7 -7
- data/docs/{UpdatePayeeDetailsRequest2.md → UpdatePayeeDetailsRequestV4.md} +7 -7
- data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
- data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
- data/docs/WebhooksResponse.md +2 -2
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_api.rb +481 -0
- data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
- data/lib/velopayments/api/login_api.rb +5 -5
- data/lib/velopayments/api/payee_invitation_api.rb +112 -112
- data/lib/velopayments/api/payees_api.rb +80 -80
- data/lib/velopayments/api/payment_audit_service_api.rb +34 -18
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +12 -12
- data/{spec/models/create_webhook_request_spec.rb → lib/velopayments/api/payor_hierarchy_api.rb} +67 -37
- data/lib/velopayments/api/payors_api.rb +41 -107
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +52 -52
- data/lib/velopayments/api/source_accounts_api.rb +632 -0
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +5 -5
- data/lib/velopayments/api/webhooks_api.rb +4 -4
- data/lib/velopayments/api_client.rb +5 -3
- data/lib/velopayments/api_error.rb +3 -2
- data/lib/velopayments/configuration.rb +31 -12
- data/lib/velopayments/models/accepted_payment_v3.rb +193 -23
- data/lib/velopayments/models/access_token_response.rb +15 -19
- data/lib/velopayments/models/access_token_validation_request.rb +17 -19
- data/lib/velopayments/models/auth_response.rb +19 -19
- data/lib/velopayments/models/{auto_top_up_config.rb → auto_top_up_config_v2.rb} +20 -22
- data/lib/velopayments/models/{auto_top_up_config2.rb → auto_top_up_config_v3.rb} +20 -22
- data/lib/velopayments/models/category.rb +8 -5
- data/lib/velopayments/models/{challenge.rb → challenge_v3.rb} +22 -22
- data/lib/velopayments/models/{challenge2.rb → challenge_v4.rb} +22 -22
- data/lib/velopayments/models/{company.rb → company_v3.rb} +20 -22
- data/lib/velopayments/models/{company2.rb → company_v4.rb} +20 -22
- data/lib/velopayments/models/create_funding_account_request_v2.rb +55 -37
- data/lib/velopayments/models/{create_individual.rb → create_individual_v3.rb} +29 -25
- data/lib/velopayments/models/{individual_name.rb → create_individual_v3_name.rb} +34 -26
- data/lib/velopayments/models/{create_individual2.rb → create_individual_v4.rb} +29 -25
- data/lib/velopayments/models/{create_payee_address2.rb → create_payee_address_v3.rb} +37 -51
- data/lib/velopayments/models/{create_payee_address.rb → create_payee_address_v4.rb} +49 -52
- data/lib/velopayments/models/{create_payee.rb → create_payee_v3.rb} +33 -28
- data/lib/velopayments/models/{create_payee2.rb → create_payee_v4.rb} +55 -50
- data/lib/velopayments/models/{create_payees_csv_request.rb → create_payees_csv_request_v3.rb} +209 -81
- data/lib/velopayments/models/{create_payees_csv_request2.rb → create_payees_csv_request_v4.rb} +209 -81
- data/lib/velopayments/models/{create_payees_csv_response.rb → create_payees_csv_response_v3.rb} +19 -23
- data/lib/velopayments/models/{create_payees_csv_response_rejected_csv_rows.rb → create_payees_csv_response_v3_rejected_csv_rows.rb} +18 -22
- data/lib/velopayments/models/{create_payees_csv_response2.rb → create_payees_csv_response_v4.rb} +19 -23
- data/lib/velopayments/models/{create_payees_request.rb → create_payees_request_v3.rb} +23 -23
- data/lib/velopayments/models/{create_payees_request2.rb → create_payees_request_v4.rb} +23 -23
- data/lib/velopayments/models/{create_payment_channel.rb → create_payment_channel_v3.rb} +104 -67
- data/lib/velopayments/models/{create_payment_channel2.rb → create_payment_channel_v4.rb} +104 -67
- data/lib/velopayments/models/create_payor_link_request.rb +21 -19
- data/lib/velopayments/models/create_payout_request_v3.rb +22 -20
- data/lib/velopayments/models/create_webhook_request.rb +28 -22
- data/lib/velopayments/models/debit_event.rb +23 -19
- data/lib/velopayments/models/debit_event_all_of.rb +17 -19
- data/lib/velopayments/models/debit_status_changed.rb +25 -19
- data/lib/velopayments/models/debit_status_changed_all_of.rb +17 -19
- data/lib/velopayments/models/error.rb +15 -19
- data/lib/velopayments/models/error_data.rb +15 -19
- data/lib/velopayments/models/error_response.rb +20 -20
- data/lib/velopayments/models/{failed_payee.rb → failed_payee_v3.rb} +25 -28
- data/lib/velopayments/models/{failed_payee2.rb → failed_payee_v4.rb} +26 -29
- data/lib/velopayments/models/{failed_submission.rb → failed_submission_v3.rb} +19 -23
- data/lib/velopayments/models/{failed_submission2.rb → failed_submission_v4.rb} +19 -23
- data/lib/velopayments/models/{funding_account_response2.rb → funding_account_response_v2.rb} +43 -28
- data/lib/velopayments/models/funding_audit.rb +18 -77
- data/lib/velopayments/models/funding_event.rb +17 -20
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +22 -22
- data/lib/velopayments/models/funding_request_v2.rb +17 -19
- data/lib/velopayments/models/funding_request_v3.rb +19 -19
- data/lib/velopayments/models/{source_account_response.rb → funding_response.rb} +178 -138
- data/lib/velopayments/models/fx_summary.rb +87 -61
- data/lib/velopayments/models/fx_summary_v3.rb +87 -61
- data/lib/velopayments/models/get_fundings_response.rb +15 -19
- data/lib/velopayments/models/get_fundings_response_links.rb +15 -19
- data/lib/velopayments/models/{get_payee_list_response_company.rb → get_payee_list_response_company_v3.rb} +24 -24
- data/lib/velopayments/models/{get_payee_list_response_company2.rb → get_payee_list_response_company_v4.rb} +24 -24
- data/lib/velopayments/models/{get_payee_list_response_individual.rb → get_payee_list_response_individual_v3.rb} +19 -23
- data/lib/velopayments/models/{get_payee_list_response_individual2.rb → get_payee_list_response_individual_v4.rb} +19 -23
- data/lib/velopayments/models/{get_payee_list_response.rb → get_payee_list_response_v3.rb} +66 -27
- data/lib/velopayments/models/{get_payee_list_response2.rb → get_payee_list_response_v4.rb} +67 -28
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +15 -19
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +15 -19
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +16 -54
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +17 -21
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +19 -21
- data/lib/velopayments/models/get_payout_statistics.rb +19 -19
- data/lib/velopayments/models/get_payouts_response.rb +17 -21
- data/lib/velopayments/models/get_payouts_response_v3.rb +15 -19
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +15 -19
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +15 -19
- data/lib/velopayments/models/{individual.rb → individual_v3.rb} +29 -25
- data/lib/velopayments/models/{create_individual_name.rb → individual_v3_name.rb} +34 -26
- data/lib/velopayments/models/{individual2.rb → individual_v4.rb} +29 -25
- data/lib/velopayments/models/inline_response400.rb +15 -19
- data/lib/velopayments/models/inline_response401.rb +15 -19
- data/lib/velopayments/models/inline_response403.rb +15 -19
- data/lib/velopayments/models/inline_response404.rb +15 -19
- data/lib/velopayments/models/inline_response409.rb +15 -19
- data/lib/velopayments/models/inline_response412.rb +15 -19
- data/lib/velopayments/models/{instruct_payout_request.rb → instruct_payout_request_v3.rb} +18 -22
- data/lib/velopayments/models/{invite_payee_request.rb → invite_payee_request_v3.rb} +20 -22
- data/lib/velopayments/models/{invite_payee_request2.rb → invite_payee_request_v4.rb} +20 -22
- data/lib/velopayments/models/invite_user_request.rb +37 -23
- data/lib/velopayments/models/link_for_response.rb +15 -19
- data/lib/velopayments/models/{list_funding_accounts_response2.rb → list_funding_accounts_response_v2.rb} +21 -25
- data/lib/velopayments/models/{payee_delta_response_links.rb → list_funding_accounts_response_v2_links.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response_page.rb → list_funding_accounts_response_v2_page.rb} +18 -22
- data/lib/velopayments/models/list_payments_response_v3.rb +15 -19
- data/lib/velopayments/models/list_payments_response_v3_page.rb +15 -19
- data/lib/velopayments/models/list_payments_response_v4.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v2.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v3.rb +15 -19
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +15 -19
- data/lib/velopayments/models/localisation_details.rb +15 -19
- data/lib/velopayments/models/mfa_details.rb +37 -19
- data/lib/velopayments/models/mfa_type.rb +8 -5
- data/lib/velopayments/models/{name.rb → name_v3.rb} +42 -30
- data/lib/velopayments/models/{name2.rb → name_v4.rb} +42 -30
- data/lib/velopayments/models/notification.rb +24 -22
- data/lib/velopayments/models/{invitation_status2.rb → notification_source.rb} +48 -20
- data/lib/velopayments/models/{notifications.rb → notifications_v2.rb} +18 -22
- data/lib/velopayments/models/{notifications2.rb → notifications_v3.rb} +18 -22
- data/lib/velopayments/models/onboarding_status_changed.rb +23 -19
- data/lib/velopayments/models/page_for_response.rb +15 -19
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +15 -19
- data/lib/velopayments/models/{paged_payee_invitation_status_response.rb → paged_payee_invitation_status_response_v3.rb} +21 -25
- data/lib/velopayments/models/{paged_payee_invitation_status_response_page.rb → paged_payee_invitation_status_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_invitation_status_response2.rb → paged_payee_invitation_status_response_v4.rb} +21 -25
- data/lib/velopayments/models/{paged_payee_response.rb → paged_payee_response_v3.rb} +22 -26
- data/lib/velopayments/models/{paged_payee_response_links.rb → paged_payee_response_v3_links.rb} +18 -22
- data/lib/velopayments/models/{payee_delta_response_page.rb → paged_payee_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response_summary.rb → paged_payee_response_v3_summary.rb} +18 -22
- data/lib/velopayments/models/{paged_payee_response2.rb → paged_payee_response_v4.rb} +22 -26
- data/lib/velopayments/models/paged_payments_response_v3.rb +17 -21
- data/lib/velopayments/models/paged_user_response.rb +15 -19
- data/lib/velopayments/models/paged_user_response_links.rb +15 -19
- data/lib/velopayments/models/paged_user_response_page.rb +15 -19
- data/lib/velopayments/models/password_request.rb +17 -19
- data/lib/velopayments/models/{payable_issue.rb → payable_issue_v3.rb} +22 -22
- data/lib/velopayments/models/{payable_issue2.rb → payable_issue_v4.rb} +22 -22
- data/lib/velopayments/models/payable_status_changed.rb +23 -19
- data/lib/velopayments/models/{payee_address2.rb → payee_address_v3.rb} +41 -27
- data/lib/velopayments/models/{payee_address.rb → payee_address_v4.rb} +24 -22
- data/lib/velopayments/models/{payee_delta_response.rb → payee_delta_response_v3.rb} +21 -25
- data/lib/velopayments/models/{payee_delta_response2_links.rb → payee_delta_response_v3_links.rb} +18 -22
- data/lib/velopayments/models/{list_source_account_response_page.rb → payee_delta_response_v3_page.rb} +18 -22
- data/lib/velopayments/models/{payee_delta_response2.rb → payee_delta_response_v4.rb} +21 -25
- data/lib/velopayments/models/{list_source_account_response_links.rb → payee_delta_response_v4_links.rb} +18 -22
- data/lib/velopayments/models/{payee_delta.rb → payee_delta_v3.rb} +24 -23
- data/lib/velopayments/models/{payee_delta2.rb → payee_delta_v4.rb} +64 -23
- data/lib/velopayments/models/{payee_detail_response2.rb → payee_detail_response_v3.rb} +69 -30
- data/lib/velopayments/models/{payee_detail_response.rb → payee_detail_response_v4.rb} +29 -30
- data/lib/velopayments/models/payee_details_changed.rb +23 -19
- data/lib/velopayments/models/payee_event.rb +23 -19
- data/lib/velopayments/models/payee_event_all_of.rb +17 -19
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +19 -19
- data/lib/velopayments/models/{payee_invitation_status_response.rb → payee_invitation_status_response_v3.rb} +23 -56
- data/lib/velopayments/models/{payee_invitation_status_response2.rb → payee_invitation_status_response_v4.rb} +23 -56
- data/lib/velopayments/models/payee_payor_ref_v3.rb +17 -21
- data/lib/velopayments/models/{payee_payor_ref.rb → payee_payor_ref_v4.rb} +20 -24
- data/lib/velopayments/models/payee_type.rb +8 -5
- data/lib/velopayments/models/{payee_type2.rb → payee_type_enum.rb} +9 -6
- data/lib/velopayments/models/payee_user_self_update_request.rb +15 -19
- data/lib/velopayments/models/payment_channel_country.rb +19 -19
- data/lib/velopayments/models/payment_channel_rule.rb +37 -23
- data/lib/velopayments/models/payment_channel_rules_response.rb +15 -19
- data/lib/velopayments/models/payment_delta.rb +19 -19
- data/lib/velopayments/models/payment_delta_response.rb +17 -21
- data/lib/velopayments/models/payment_delta_response_v1.rb +17 -21
- data/lib/velopayments/models/payment_delta_v1.rb +19 -19
- data/lib/velopayments/models/payment_event.rb +23 -19
- data/lib/velopayments/models/payment_event_all_of.rb +17 -19
- data/lib/velopayments/models/payment_event_response.rb +109 -55
- data/lib/velopayments/models/payment_event_response_v3.rb +79 -53
- data/lib/velopayments/models/payment_instruction_v3.rb +84 -29
- data/lib/velopayments/models/payment_rejected_or_returned.rb +29 -19
- data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +19 -19
- data/lib/velopayments/models/payment_response_v3.rb +101 -63
- data/lib/velopayments/models/payment_response_v4.rb +121 -64
- data/lib/velopayments/models/payment_response_v4_payout.rb +15 -19
- data/lib/velopayments/models/payment_status_changed.rb +25 -19
- data/lib/velopayments/models/payment_status_changed_all_of.rb +17 -19
- data/lib/velopayments/models/payment_v3.rb +158 -56
- data/lib/velopayments/models/payor_address.rb +21 -19
- data/lib/velopayments/models/payor_address_v2.rb +21 -19
- data/lib/velopayments/models/payor_aml_transaction.rb +15 -19
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +15 -19
- data/lib/velopayments/models/payor_branding_response.rb +20 -20
- data/lib/velopayments/models/payor_create_api_key_request.rb +23 -23
- data/lib/velopayments/models/payor_create_api_key_response.rb +15 -19
- data/lib/velopayments/models/payor_create_application_request.rb +17 -19
- data/lib/velopayments/models/payor_email_opt_out_request.rb +17 -19
- data/lib/velopayments/models/payor_links_response.rb +15 -19
- data/lib/velopayments/models/payor_links_response_links.rb +24 -53
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -53
- data/lib/velopayments/models/payor_v1.rb +19 -54
- data/lib/velopayments/models/payor_v2.rb +45 -58
- data/lib/velopayments/models/payout_company_v3.rb +17 -19
- data/lib/velopayments/models/payout_individual_v3.rb +17 -19
- data/lib/velopayments/models/payout_name_v3.rb +19 -19
- data/lib/velopayments/models/payout_payee_v3.rb +17 -19
- data/lib/velopayments/models/payout_payor.rb +25 -19
- data/lib/velopayments/models/payout_payor_ids.rb +21 -19
- data/lib/velopayments/models/payout_principal.rb +19 -19
- data/lib/velopayments/models/payout_schedule.rb +27 -20
- data/lib/velopayments/models/{payout_schedule2.rb → payout_schedule_v3.rb} +30 -23
- data/lib/velopayments/models/payout_summary_audit.rb +27 -21
- data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
- data/lib/velopayments/models/payout_summary_response_v3.rb +32 -20
- data/lib/velopayments/models/ping.rb +21 -19
- data/lib/velopayments/models/ping_response.rb +15 -19
- data/lib/velopayments/models/post_instruct_fx_info.rb +267 -0
- data/lib/velopayments/models/{query_batch_response.rb → query_batch_response_v3.rb} +20 -58
- data/lib/velopayments/models/{query_batch_response2.rb → query_batch_response_v4.rb} +20 -58
- data/lib/velopayments/models/quote_fx_summary_v3.rb +42 -65
- data/lib/velopayments/models/quote_response_v3.rb +15 -19
- data/lib/velopayments/models/region_v2.rb +15 -19
- data/lib/velopayments/models/register_sms_request.rb +17 -19
- data/lib/velopayments/models/rejected_payment_v3.rb +121 -19
- data/lib/velopayments/models/resend_token_request.rb +17 -19
- data/lib/velopayments/models/reset_password_request.rb +17 -19
- data/lib/velopayments/models/role.rb +17 -19
- data/lib/velopayments/models/role_update_request.rb +17 -19
- data/lib/velopayments/models/{schedule_payout_request.rb → schedule_payout_request_v3.rb} +22 -22
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +17 -19
- data/lib/velopayments/models/self_update_password_request.rb +19 -19
- data/lib/velopayments/models/set_notifications_request.rb +17 -19
- data/lib/velopayments/models/{funding_request_v1.rb → set_notifications_request2.rb} +46 -48
- data/lib/velopayments/models/source_account_response_v2.rb +44 -50
- data/lib/velopayments/models/source_account_response_v3.rb +66 -53
- data/lib/velopayments/models/source_account_summary.rb +49 -20
- data/lib/velopayments/models/source_account_summary_v3.rb +49 -20
- data/lib/velopayments/models/source_account_v3.rb +26 -19
- data/lib/velopayments/models/source_event.rb +21 -19
- data/lib/velopayments/models/supported_countries_response.rb +15 -19
- data/lib/velopayments/models/supported_countries_response_v2.rb +15 -19
- data/lib/velopayments/models/supported_country.rb +22 -22
- data/lib/velopayments/models/supported_country_v2.rb +22 -22
- data/lib/velopayments/models/supported_currency_response_v2.rb +15 -19
- data/lib/velopayments/models/supported_currency_v2.rb +22 -22
- data/lib/velopayments/models/{transfer_request2.rb → transfer_request_v2.rb} +24 -22
- data/lib/velopayments/models/{transfer_request.rb → transfer_request_v3.rb} +36 -22
- data/lib/velopayments/models/transmission_types.rb +21 -19
- data/lib/velopayments/models/transmission_types2.rb +21 -19
- data/lib/velopayments/models/unregister_mfa_request.rb +17 -19
- data/lib/velopayments/models/{update_payee_details_request.rb → update_payee_details_request_v3.rb} +45 -27
- data/lib/velopayments/models/{update_payee_details_request2.rb → update_payee_details_request_v4.rb} +50 -28
- data/lib/velopayments/models/{update_remote_id_request2.rb → update_remote_id_request_v3.rb} +22 -22
- data/lib/velopayments/models/{update_remote_id_request.rb → update_remote_id_request_v4.rb} +22 -22
- data/lib/velopayments/models/update_webhook_request.rb +21 -21
- data/lib/velopayments/models/user_details_update_request.rb +37 -19
- data/lib/velopayments/models/user_info.rb +37 -19
- data/lib/velopayments/models/user_response.rb +53 -29
- data/lib/velopayments/models/user_status.rb +8 -5
- data/lib/velopayments/models/user_type.rb +8 -5
- data/lib/velopayments/models/user_type2.rb +8 -5
- data/lib/velopayments/models/validate_password_response.rb +21 -21
- data/lib/velopayments/models/webhook_response.rb +15 -19
- data/lib/velopayments/models/webhooks_response.rb +17 -21
- data/lib/velopayments/models/withdraw_payment_request.rb +17 -19
- data/lib/velopayments/version.rb +3 -3
- data/lib/velopayments.rb +91 -111
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +41 -6
- data/spec/api/currencies_api_spec.rb +5 -3
- data/spec/api/funding_api_spec.rb +169 -0
- data/spec/api/funding_manager_private_api_spec.rb +4 -4
- data/spec/api/login_api_spec.rb +11 -11
- data/spec/api/payee_invitation_api_spec.rb +74 -38
- data/spec/api/payees_api_spec.rb +76 -42
- data/spec/api/payment_audit_service_api_spec.rb +90 -17
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +10 -10
- data/spec/{models/get_fundings_response_links_spec.rb → api/payor_hierarchy_api_spec.rb} +24 -15
- data/spec/api/payors_api_spec.rb +47 -35
- data/spec/api/payors_private_api_spec.rb +3 -3
- data/spec/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +20 -20
- data/spec/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +81 -162
- data/spec/api/tokens_api_spec.rb +3 -3
- data/spec/api/users_api_spec.rb +45 -19
- data/spec/api/webhooks_api_spec.rb +7 -7
- data/spec/api_client_spec.rb +4 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +19 -19
- data/specs/api/currencies_api_spec.rb +2 -2
- data/specs/api/funding_api_spec.rb +169 -0
- data/specs/api/funding_manager_private_api_spec.rb +16 -4
- data/specs/api/login_api_spec.rb +8 -7
- data/specs/api/payee_invitation_api_spec.rb +55 -39
- data/specs/api/payees_api_spec.rb +107 -45
- data/specs/api/payment_audit_service_api_spec.rb +29 -85
- data/specs/api/payment_audit_service_deprecated_api_spec.rb +10 -10
- data/{spec/models/company2_spec.rb → specs/api/payor_hierarchy_api_spec.rb} +23 -20
- data/specs/api/payors_api_spec.rb +27 -48
- data/specs/api/payors_private_api_spec.rb +4 -4
- data/specs/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +51 -24
- data/specs/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +36 -208
- data/specs/api/tokens_api_spec.rb +4 -4
- data/specs/api/users_api_spec.rb +38 -47
- data/specs/api/webhooks_api_spec.rb +7 -7
- data/velopayments.gemspec +3 -3
- metadata +208 -766
- data/docs/CreatePayee2.md +0 -38
- data/docs/FundingAccountResponse.md +0 -36
- data/docs/FundingAccountType.md +0 -15
- data/docs/FundingEventType.md +0 -15
- data/docs/FundingManagerApi.md +0 -1291
- data/docs/FundingRequestV1.md +0 -18
- data/docs/GetPayeeListResponseIndividual.md +0 -18
- data/docs/GetPayeeListResponseIndividual2.md +0 -18
- data/docs/InvitationStatus.md +0 -15
- data/docs/InvitationStatus2.md +0 -15
- data/docs/KycState.md +0 -15
- data/docs/ListFundingAccountsResponse.md +0 -22
- data/docs/ListFundingAccountsResponse2.md +0 -22
- data/docs/ListSourceAccountResponse.md +0 -22
- data/docs/OnboardedStatus.md +0 -15
- data/docs/OnboardedStatus2.md +0 -15
- data/docs/PagedPayeeInvitationStatusResponse.md +0 -22
- data/docs/PagedPayeeInvitationStatusResponse2.md +0 -22
- data/docs/PagedPayeeResponse.md +0 -24
- data/docs/PagedPayeeResponse2.md +0 -24
- data/docs/PayeeDeltaResponse.md +0 -22
- data/docs/PayeeDeltaResponse2.md +0 -22
- data/docs/PayeeType2.md +0 -15
- data/docs/PaymentAuditCurrency.md +0 -15
- data/docs/PaymentAuditCurrencyV3.md +0 -15
- data/docs/PaymentRails.md +0 -15
- data/docs/PayorLogoRequest.md +0 -18
- data/docs/PayoutStatus.md +0 -15
- data/docs/PayoutStatusV3.md +0 -15
- data/docs/PayoutType.md +0 -15
- data/docs/ScheduleStatus.md +0 -15
- data/docs/ScheduleStatus2.md +0 -15
- data/docs/SourceAccountResponse.md +0 -44
- data/docs/SourceAccountType.md +0 -15
- data/docs/TransmissionType.md +0 -15
- data/docs/WatchlistStatus.md +0 -15
- data/docs/WatchlistStatus2.md +0 -15
- data/lib/velopayments/api/funding_manager_api.rb +0 -1330
- data/lib/velopayments/models/funding_account_response.rb +0 -357
- data/lib/velopayments/models/funding_account_type.rb +0 -37
- data/lib/velopayments/models/funding_event_type.rb +0 -42
- data/lib/velopayments/models/invitation_status.rb +0 -38
- data/lib/velopayments/models/kyc_state.rb +0 -38
- data/lib/velopayments/models/list_funding_accounts_response.rb +0 -241
- data/lib/velopayments/models/list_source_account_response.rb +0 -241
- data/lib/velopayments/models/ofac_status.rb +0 -38
- data/lib/velopayments/models/onboarded_status.rb +0 -39
- data/lib/velopayments/models/onboarded_status2.rb +0 -39
- data/lib/velopayments/models/payment_audit_currency.rb +0 -38
- data/lib/velopayments/models/payment_audit_currency_v3.rb +0 -38
- data/lib/velopayments/models/payment_rails.rb +0 -37
- data/lib/velopayments/models/payor_logo_request.rb +0 -218
- data/lib/velopayments/models/payout_status.rb +0 -44
- data/lib/velopayments/models/payout_status_v3.rb +0 -44
- data/lib/velopayments/models/payout_type.rb +0 -38
- data/lib/velopayments/models/schedule_status.rb +0 -38
- data/lib/velopayments/models/schedule_status2.rb +0 -38
- data/lib/velopayments/models/source_account_type.rb +0 -37
- data/lib/velopayments/models/transmission_type.rb +0 -38
- data/lib/velopayments/models/watchlist_status.rb +0 -40
- data/lib/velopayments/models/watchlist_status2.rb +0 -40
- data/spec/models/accepted_payment_v3_spec.rb +0 -76
- data/spec/models/access_token_response_spec.rb +0 -70
- data/spec/models/access_token_validation_request_spec.rb +0 -34
- data/spec/models/auth_response_spec.rb +0 -64
- data/spec/models/auto_top_up_config2_spec.rb +0 -52
- data/spec/models/auto_top_up_config_spec.rb +0 -46
- data/spec/models/category_spec.rb +0 -28
- data/spec/models/challenge2_spec.rb +0 -40
- data/spec/models/challenge_spec.rb +0 -40
- data/spec/models/company_spec.rb +0 -46
- data/spec/models/create_funding_account_request_v2_spec.rb +0 -74
- data/spec/models/create_individual2_spec.rb +0 -46
- data/spec/models/create_individual_name_spec.rb +0 -52
- data/spec/models/create_individual_spec.rb +0 -46
- data/spec/models/create_payee2_spec.rb +0 -94
- data/spec/models/create_payee_address2_spec.rb +0 -80
- data/spec/models/create_payee_address_spec.rb +0 -80
- data/spec/models/create_payee_spec.rb +0 -94
- data/spec/models/create_payees_csv_request2_spec.rb +0 -214
- data/spec/models/create_payees_csv_request_spec.rb +0 -214
- data/spec/models/create_payees_csv_response2_spec.rb +0 -40
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +0 -46
- data/spec/models/create_payees_csv_response_spec.rb +0 -40
- data/spec/models/create_payees_request2_spec.rb +0 -40
- data/spec/models/create_payees_request_spec.rb +0 -40
- data/spec/models/create_payment_channel2_spec.rb +0 -78
- data/spec/models/create_payment_channel_spec.rb +0 -78
- data/spec/models/create_payor_link_request_spec.rb +0 -50
- data/spec/models/create_payout_request_v3_spec.rb +0 -52
- data/spec/models/debit_event_all_of_spec.rb +0 -34
- data/spec/models/debit_event_spec.rb +0 -52
- data/spec/models/debit_status_changed_all_of_spec.rb +0 -34
- data/spec/models/debit_status_changed_spec.rb +0 -58
- data/spec/models/error_data_spec.rb +0 -40
- data/spec/models/error_response_spec.rb +0 -46
- data/spec/models/error_spec.rb +0 -74
- data/spec/models/failed_payee2_spec.rb +0 -94
- data/spec/models/failed_payee_spec.rb +0 -94
- data/spec/models/failed_submission2_spec.rb +0 -40
- data/spec/models/failed_submission_spec.rb +0 -40
- data/spec/models/funding_account_response2_spec.rb +0 -88
- data/spec/models/funding_account_response_spec.rb +0 -88
- data/spec/models/funding_account_type_spec.rb +0 -28
- data/spec/models/funding_audit_spec.rb +0 -94
- data/spec/models/funding_event_spec.rb +0 -52
- data/spec/models/funding_event_type_spec.rb +0 -28
- data/spec/models/funding_payor_status_audit_response_spec.rb +0 -52
- data/spec/models/funding_request_v1_spec.rb +0 -34
- data/spec/models/funding_request_v2_spec.rb +0 -34
- data/spec/models/funding_request_v3_spec.rb +0 -40
- data/spec/models/fx_summary_spec.rb +0 -96
- data/spec/models/fx_summary_v3_spec.rb +0 -96
- data/spec/models/get_fundings_response_spec.rb +0 -46
- data/spec/models/get_payee_list_response2_spec.rb +0 -130
- data/spec/models/get_payee_list_response_company2_spec.rb +0 -40
- data/spec/models/get_payee_list_response_company_spec.rb +0 -40
- data/spec/models/get_payee_list_response_individual2_spec.rb +0 -34
- data/spec/models/get_payee_list_response_individual_spec.rb +0 -34
- data/spec/models/get_payee_list_response_spec.rb +0 -130
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +0 -58
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +0 -52
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +0 -92
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +0 -52
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +0 -148
- data/spec/models/get_payout_statistics_spec.rb +0 -40
- data/spec/models/get_payouts_response_spec.rb +0 -46
- data/spec/models/get_payouts_response_v3_links_spec.rb +0 -40
- data/spec/models/get_payouts_response_v3_page_spec.rb +0 -58
- data/spec/models/get_payouts_response_v3_spec.rb +0 -46
- data/spec/models/individual2_spec.rb +0 -46
- data/spec/models/individual_name_spec.rb +0 -52
- data/spec/models/individual_spec.rb +0 -46
- data/spec/models/inline_response400_spec.rb +0 -46
- data/spec/models/inline_response401_spec.rb +0 -46
- data/spec/models/inline_response403_spec.rb +0 -46
- data/spec/models/inline_response404_spec.rb +0 -46
- data/spec/models/inline_response409_spec.rb +0 -46
- data/spec/models/inline_response412_spec.rb +0 -46
- data/spec/models/instruct_payout_request_spec.rb +0 -34
- data/spec/models/invitation_status2_spec.rb +0 -28
- data/spec/models/invitation_status_spec.rb +0 -28
- data/spec/models/invite_payee_request2_spec.rb +0 -34
- data/spec/models/invite_payee_request_spec.rb +0 -34
- data/spec/models/invite_user_request_spec.rb +0 -102
- data/spec/models/kyc_state_spec.rb +0 -28
- data/spec/models/link_for_response_spec.rb +0 -40
- data/spec/models/list_funding_accounts_response2_spec.rb +0 -46
- data/spec/models/list_funding_accounts_response_spec.rb +0 -46
- data/spec/models/list_payments_response_v3_page_spec.rb +0 -58
- data/spec/models/list_payments_response_v3_spec.rb +0 -46
- data/spec/models/list_payments_response_v4_spec.rb +0 -46
- data/spec/models/list_source_account_response_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_page_spec.rb +0 -58
- data/spec/models/list_source_account_response_spec.rb +0 -46
- data/spec/models/list_source_account_response_v2_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_v2_spec.rb +0 -46
- data/spec/models/list_source_account_response_v3_links_spec.rb +0 -40
- data/spec/models/list_source_account_response_v3_spec.rb +0 -46
- data/spec/models/localisation_details_spec.rb +0 -40
- data/spec/models/mfa_details_spec.rb +0 -40
- data/spec/models/mfa_type_spec.rb +0 -28
- data/spec/models/name2_spec.rb +0 -52
- data/spec/models/name_spec.rb +0 -52
- data/spec/models/notification_spec.rb +0 -58
- data/spec/models/notifications2_spec.rb +0 -34
- data/spec/models/notifications_spec.rb +0 -34
- data/spec/models/ofac_status_spec.rb +0 -28
- data/spec/models/onboarded_status2_spec.rb +0 -28
- data/spec/models/onboarded_status_spec.rb +0 -28
- data/spec/models/onboarding_status_changed_spec.rb +0 -58
- data/spec/models/page_for_response_spec.rb +0 -58
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +0 -46
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +0 -46
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +0 -58
- data/spec/models/paged_payee_invitation_status_response_spec.rb +0 -46
- data/spec/models/paged_payee_response2_spec.rb +0 -52
- data/spec/models/paged_payee_response_links_spec.rb +0 -40
- data/spec/models/paged_payee_response_page_spec.rb +0 -58
- data/spec/models/paged_payee_response_spec.rb +0 -52
- data/spec/models/paged_payee_response_summary_spec.rb +0 -58
- data/spec/models/paged_payments_response_v3_spec.rb +0 -46
- data/spec/models/paged_user_response_links_spec.rb +0 -40
- data/spec/models/paged_user_response_page_spec.rb +0 -58
- data/spec/models/paged_user_response_spec.rb +0 -46
- data/spec/models/password_request_spec.rb +0 -34
- data/spec/models/payable_issue2_spec.rb +0 -40
- data/spec/models/payable_issue_spec.rb +0 -40
- data/spec/models/payable_status_changed_spec.rb +0 -58
- data/spec/models/payee_address2_spec.rb +0 -76
- data/spec/models/payee_address_spec.rb +0 -76
- data/spec/models/payee_delta2_spec.rb +0 -70
- data/spec/models/payee_delta_response2_links_spec.rb +0 -40
- data/spec/models/payee_delta_response2_spec.rb +0 -46
- data/spec/models/payee_delta_response_links_spec.rb +0 -40
- data/spec/models/payee_delta_response_page_spec.rb +0 -58
- data/spec/models/payee_delta_response_spec.rb +0 -46
- data/spec/models/payee_delta_spec.rb +0 -70
- data/spec/models/payee_detail_response2_spec.rb +0 -202
- data/spec/models/payee_detail_response_spec.rb +0 -202
- data/spec/models/payee_details_changed_spec.rb +0 -58
- data/spec/models/payee_event_all_of_reasons_spec.rb +0 -40
- data/spec/models/payee_event_all_of_spec.rb +0 -40
- data/spec/models/payee_event_spec.rb +0 -58
- data/spec/models/payee_invitation_status_response2_spec.rb +0 -50
- data/spec/models/payee_invitation_status_response_spec.rb +0 -50
- data/spec/models/payee_payor_ref_spec.rb +0 -70
- data/spec/models/payee_payor_ref_v3_spec.rb +0 -70
- data/spec/models/payee_type2_spec.rb +0 -28
- data/spec/models/payee_type_spec.rb +0 -28
- data/spec/models/payee_user_self_update_request_spec.rb +0 -64
- data/spec/models/payment_audit_currency_spec.rb +0 -28
- data/spec/models/payment_audit_currency_v3_spec.rb +0 -28
- data/spec/models/payment_channel_country_spec.rb +0 -40
- data/spec/models/payment_channel_rule_spec.rb +0 -70
- data/spec/models/payment_channel_rules_response_spec.rb +0 -34
- data/spec/models/payment_delta_response_spec.rb +0 -46
- data/spec/models/payment_delta_response_v1_spec.rb +0 -46
- data/spec/models/payment_delta_spec.rb +0 -76
- data/spec/models/payment_delta_v1_spec.rb +0 -76
- data/spec/models/payment_event_all_of_spec.rb +0 -46
- data/spec/models/payment_event_response_spec.rb +0 -104
- data/spec/models/payment_event_response_v3_spec.rb +0 -104
- data/spec/models/payment_event_spec.rb +0 -64
- data/spec/models/payment_instruction_v3_spec.rb +0 -82
- data/spec/models/payment_rails_spec.rb +0 -28
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +0 -40
- data/spec/models/payment_rejected_or_returned_spec.rb +0 -82
- data/spec/models/payment_response_v3_spec.rb +0 -252
- data/spec/models/payment_response_v4_payout_spec.rb +0 -46
- data/spec/models/payment_response_v4_spec.rb +0 -318
- data/spec/models/payment_status_changed_all_of_spec.rb +0 -34
- data/spec/models/payment_status_changed_spec.rb +0 -70
- data/spec/models/payment_v3_spec.rb +0 -116
- data/spec/models/payor_address_spec.rb +0 -76
- data/spec/models/payor_address_v2_spec.rb +0 -76
- data/spec/models/payor_aml_transaction_spec.rb +0 -190
- data/spec/models/payor_aml_transaction_v3_spec.rb +0 -178
- data/spec/models/payor_branding_response_spec.rb +0 -58
- data/spec/models/payor_create_api_key_request_spec.rb +0 -50
- data/spec/models/payor_create_api_key_response_spec.rb +0 -40
- data/spec/models/payor_create_application_request_spec.rb +0 -40
- data/spec/models/payor_email_opt_out_request_spec.rb +0 -34
- data/spec/models/payor_links_response_links_spec.rb +0 -56
- data/spec/models/payor_links_response_payors_spec.rb +0 -56
- data/spec/models/payor_links_response_spec.rb +0 -40
- data/spec/models/payor_logo_request_spec.rb +0 -34
- data/spec/models/payor_v1_spec.rb +0 -164
- data/spec/models/payor_v2_spec.rb +0 -182
- data/spec/models/payout_company_v3_spec.rb +0 -34
- data/spec/models/payout_individual_v3_spec.rb +0 -34
- data/spec/models/payout_name_v3_spec.rb +0 -40
- data/spec/models/payout_payee_v3_spec.rb +0 -46
- data/spec/models/payout_payor_ids_spec.rb +0 -46
- data/spec/models/payout_payor_spec.rb +0 -58
- data/spec/models/payout_principal_spec.rb +0 -40
- data/spec/models/payout_schedule2_spec.rb +0 -58
- data/spec/models/payout_schedule_spec.rb +0 -64
- data/spec/models/payout_status_spec.rb +0 -28
- data/spec/models/payout_status_v3_spec.rb +0 -28
- data/spec/models/payout_summary_audit_spec.rb +0 -130
- data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
- data/spec/models/payout_summary_response_v3_spec.rb +0 -94
- data/spec/models/payout_type_spec.rb +0 -28
- data/spec/models/ping_response_spec.rb +0 -40
- data/spec/models/ping_spec.rb +0 -46
- data/spec/models/query_batch_response2_spec.rb +0 -56
- data/spec/models/query_batch_response_spec.rb +0 -56
- data/spec/models/quote_fx_summary_v3_spec.rb +0 -102
- data/spec/models/quote_response_v3_spec.rb +0 -34
- data/spec/models/region_v2_spec.rb +0 -40
- data/spec/models/register_sms_request_spec.rb +0 -34
- data/spec/models/rejected_payment_v3_spec.rb +0 -94
- data/spec/models/resend_token_request_spec.rb +0 -44
- data/spec/models/reset_password_request_spec.rb +0 -34
- data/spec/models/role_spec.rb +0 -34
- data/spec/models/role_update_request_spec.rb +0 -40
- data/spec/models/schedule_payout_request_spec.rb +0 -40
- data/spec/models/schedule_status2_spec.rb +0 -28
- data/spec/models/schedule_status_spec.rb +0 -28
- data/spec/models/self_mfa_type_unregister_request_spec.rb +0 -38
- data/spec/models/self_update_password_request_spec.rb +0 -40
- data/spec/models/set_notifications_request_spec.rb +0 -34
- data/spec/models/source_account_response_spec.rb +0 -116
- data/spec/models/source_account_response_v2_spec.rb +0 -128
- data/spec/models/source_account_response_v3_spec.rb +0 -140
- data/spec/models/source_account_summary_spec.rb +0 -46
- data/spec/models/source_account_summary_v3_spec.rb +0 -46
- data/spec/models/source_account_type_spec.rb +0 -28
- data/spec/models/source_account_v3_spec.rb +0 -52
- data/spec/models/source_event_spec.rb +0 -46
- data/spec/models/supported_countries_response_spec.rb +0 -34
- data/spec/models/supported_countries_response_v2_spec.rb +0 -34
- data/spec/models/supported_country_spec.rb +0 -40
- data/spec/models/supported_country_v2_spec.rb +0 -46
- data/spec/models/supported_currency_response_v2_spec.rb +0 -34
- data/spec/models/supported_currency_v2_spec.rb +0 -40
- data/spec/models/transfer_request2_spec.rb +0 -46
- data/spec/models/transfer_request_spec.rb +0 -46
- data/spec/models/transmission_type_spec.rb +0 -28
- data/spec/models/transmission_types2_spec.rb +0 -46
- data/spec/models/transmission_types_spec.rb +0 -46
- data/spec/models/unregister_mfa_request_spec.rb +0 -44
- data/spec/models/update_payee_details_request2_spec.rb +0 -76
- data/spec/models/update_payee_details_request_spec.rb +0 -70
- data/spec/models/update_remote_id_request2_spec.rb +0 -40
- data/spec/models/update_remote_id_request_spec.rb +0 -40
- data/spec/models/update_webhook_request_spec.rb +0 -52
- data/spec/models/user_details_update_request_spec.rb +0 -76
- data/spec/models/user_info_spec.rb +0 -46
- data/spec/models/user_response_spec.rb +0 -140
- data/spec/models/user_status_spec.rb +0 -28
- data/spec/models/user_type2_spec.rb +0 -28
- data/spec/models/user_type_spec.rb +0 -28
- data/spec/models/validate_password_response_spec.rb +0 -52
- data/spec/models/watchlist_status2_spec.rb +0 -28
- data/spec/models/watchlist_status_spec.rb +0 -28
- data/spec/models/webhook_response_spec.rb +0 -64
- data/spec/models/webhooks_response_spec.rb +0 -46
- data/spec/models/withdraw_payment_request_spec.rb +0 -34
@@ -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.35.58
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -21,16 +21,16 @@ module VeloPayments
|
|
21
21
|
|
22
22
|
attr_accessor :payor_id
|
23
23
|
|
24
|
-
# Required if type is FBO
|
24
|
+
# Required if type is either FBO or PRIVATE
|
25
25
|
attr_accessor :account_name
|
26
26
|
|
27
|
-
# Required if type is FBO
|
27
|
+
# Required if type is either FBO or PRIVATE
|
28
28
|
attr_accessor :account_number
|
29
29
|
|
30
|
-
# Required if type is FBO
|
30
|
+
# Required if type is either FBO or PRIVATE
|
31
31
|
attr_accessor :routing_number
|
32
32
|
|
33
|
-
# ISO 4217 currency code, Required if type is WUBS_DECOUPLED
|
33
|
+
# ISO 4217 currency code, Required if type is either WUBS_DECOUPLED or PRIVATE
|
34
34
|
attr_accessor :currency
|
35
35
|
|
36
36
|
class EnumAttributeValidator
|
@@ -109,14 +109,20 @@ module VeloPayments
|
|
109
109
|
|
110
110
|
if attributes.key?(:'type')
|
111
111
|
self.type = attributes[:'type']
|
112
|
+
else
|
113
|
+
self.type = nil
|
112
114
|
end
|
113
115
|
|
114
116
|
if attributes.key?(:'name')
|
115
117
|
self.name = attributes[:'name']
|
118
|
+
else
|
119
|
+
self.name = nil
|
116
120
|
end
|
117
121
|
|
118
122
|
if attributes.key?(:'payor_id')
|
119
123
|
self.payor_id = attributes[:'payor_id']
|
124
|
+
else
|
125
|
+
self.payor_id = nil
|
120
126
|
end
|
121
127
|
|
122
128
|
if attributes.key?(:'account_name')
|
@@ -139,6 +145,7 @@ module VeloPayments
|
|
139
145
|
# Show invalid properties with the reasons. Usually used together with valid?
|
140
146
|
# @return Array for valid properties with the reasons
|
141
147
|
def list_invalid_properties
|
148
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
142
149
|
invalid_properties = Array.new
|
143
150
|
if @type.nil?
|
144
151
|
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
@@ -180,8 +187,8 @@ module VeloPayments
|
|
180
187
|
invalid_properties.push('invalid value for "routing_number", the character length must be smaller than or equal to 9.')
|
181
188
|
end
|
182
189
|
|
183
|
-
if !@routing_number.nil? && @routing_number.to_s.length <
|
184
|
-
invalid_properties.push('invalid value for "routing_number", the character length must be great than or equal to
|
190
|
+
if !@routing_number.nil? && @routing_number.to_s.length < 6
|
191
|
+
invalid_properties.push('invalid value for "routing_number", the character length must be great than or equal to 6.')
|
185
192
|
end
|
186
193
|
|
187
194
|
if !@currency.nil? && @currency.to_s.length > 3
|
@@ -198,8 +205,9 @@ module VeloPayments
|
|
198
205
|
# Check to see if the all the properties in the model are valid
|
199
206
|
# @return true if the model is valid
|
200
207
|
def valid?
|
208
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
201
209
|
return false if @type.nil?
|
202
|
-
type_validator = EnumAttributeValidator.new('String', ["FBO", "WUBS_DECOUPLED"])
|
210
|
+
type_validator = EnumAttributeValidator.new('String', ["FBO", "WUBS_DECOUPLED", "PRIVATE"])
|
203
211
|
return false unless type_validator.valid?(@type)
|
204
212
|
return false if @name.nil?
|
205
213
|
return false if @name.to_s.length > 30
|
@@ -210,7 +218,7 @@ module VeloPayments
|
|
210
218
|
return false if !@account_number.nil? && @account_number.to_s.length > 17
|
211
219
|
return false if !@account_number.nil? && @account_number.to_s.length < 4
|
212
220
|
return false if !@routing_number.nil? && @routing_number.to_s.length > 9
|
213
|
-
return false if !@routing_number.nil? && @routing_number.to_s.length <
|
221
|
+
return false if !@routing_number.nil? && @routing_number.to_s.length < 6
|
214
222
|
return false if !@currency.nil? && @currency.to_s.length > 3
|
215
223
|
return false if !@currency.nil? && @currency.to_s.length < 3
|
216
224
|
true
|
@@ -219,7 +227,7 @@ module VeloPayments
|
|
219
227
|
# Custom attribute writer method checking allowed values (enum).
|
220
228
|
# @param [Object] type Object to be assigned
|
221
229
|
def type=(type)
|
222
|
-
validator = EnumAttributeValidator.new('String', ["FBO", "WUBS_DECOUPLED"])
|
230
|
+
validator = EnumAttributeValidator.new('String', ["FBO", "WUBS_DECOUPLED", "PRIVATE"])
|
223
231
|
unless validator.valid?(type)
|
224
232
|
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
225
233
|
end
|
@@ -247,11 +255,15 @@ module VeloPayments
|
|
247
255
|
# Custom attribute writer method with validation
|
248
256
|
# @param [Object] account_name Value to be assigned
|
249
257
|
def account_name=(account_name)
|
250
|
-
if
|
258
|
+
if account_name.nil?
|
259
|
+
fail ArgumentError, 'account_name cannot be nil'
|
260
|
+
end
|
261
|
+
|
262
|
+
if account_name.to_s.length > 22
|
251
263
|
fail ArgumentError, 'invalid value for "account_name", the character length must be smaller than or equal to 22.'
|
252
264
|
end
|
253
265
|
|
254
|
-
if
|
266
|
+
if account_name.to_s.length < 1
|
255
267
|
fail ArgumentError, 'invalid value for "account_name", the character length must be great than or equal to 1.'
|
256
268
|
end
|
257
269
|
|
@@ -261,11 +273,15 @@ module VeloPayments
|
|
261
273
|
# Custom attribute writer method with validation
|
262
274
|
# @param [Object] account_number Value to be assigned
|
263
275
|
def account_number=(account_number)
|
264
|
-
if
|
276
|
+
if account_number.nil?
|
277
|
+
fail ArgumentError, 'account_number cannot be nil'
|
278
|
+
end
|
279
|
+
|
280
|
+
if account_number.to_s.length > 17
|
265
281
|
fail ArgumentError, 'invalid value for "account_number", the character length must be smaller than or equal to 17.'
|
266
282
|
end
|
267
283
|
|
268
|
-
if
|
284
|
+
if account_number.to_s.length < 4
|
269
285
|
fail ArgumentError, 'invalid value for "account_number", the character length must be great than or equal to 4.'
|
270
286
|
end
|
271
287
|
|
@@ -275,12 +291,16 @@ module VeloPayments
|
|
275
291
|
# Custom attribute writer method with validation
|
276
292
|
# @param [Object] routing_number Value to be assigned
|
277
293
|
def routing_number=(routing_number)
|
278
|
-
if
|
294
|
+
if routing_number.nil?
|
295
|
+
fail ArgumentError, 'routing_number cannot be nil'
|
296
|
+
end
|
297
|
+
|
298
|
+
if routing_number.to_s.length > 9
|
279
299
|
fail ArgumentError, 'invalid value for "routing_number", the character length must be smaller than or equal to 9.'
|
280
300
|
end
|
281
301
|
|
282
|
-
if
|
283
|
-
fail ArgumentError, 'invalid value for "routing_number", the character length must be great than or equal to
|
302
|
+
if routing_number.to_s.length < 6
|
303
|
+
fail ArgumentError, 'invalid value for "routing_number", the character length must be great than or equal to 6.'
|
284
304
|
end
|
285
305
|
|
286
306
|
@routing_number = routing_number
|
@@ -289,11 +309,15 @@ module VeloPayments
|
|
289
309
|
# Custom attribute writer method with validation
|
290
310
|
# @param [Object] currency Value to be assigned
|
291
311
|
def currency=(currency)
|
292
|
-
if
|
312
|
+
if currency.nil?
|
313
|
+
fail ArgumentError, 'currency cannot be nil'
|
314
|
+
end
|
315
|
+
|
316
|
+
if currency.to_s.length > 3
|
293
317
|
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
294
318
|
end
|
295
319
|
|
296
|
-
if
|
320
|
+
if currency.to_s.length < 3
|
297
321
|
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
298
322
|
end
|
299
323
|
|
@@ -330,36 +354,30 @@ module VeloPayments
|
|
330
354
|
# @param [Hash] attributes Model attributes in the form of hash
|
331
355
|
# @return [Object] Returns the model itself
|
332
356
|
def self.build_from_hash(attributes)
|
333
|
-
new.build_from_hash(attributes)
|
334
|
-
end
|
335
|
-
|
336
|
-
# Builds the object from hash
|
337
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
338
|
-
# @return [Object] Returns the model itself
|
339
|
-
def build_from_hash(attributes)
|
340
357
|
return nil unless attributes.is_a?(Hash)
|
341
|
-
|
342
|
-
|
343
|
-
|
358
|
+
attributes = attributes.transform_keys(&:to_sym)
|
359
|
+
transformed_hash = {}
|
360
|
+
openapi_types.each_pair do |key, type|
|
361
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
362
|
+
transformed_hash["#{key}"] = nil
|
344
363
|
elsif type =~ /\AArray<(.*)>/i
|
345
364
|
# check to ensure the input is an array given that the attribute
|
346
365
|
# is documented as an array but the input is not
|
347
|
-
if attributes[
|
348
|
-
|
366
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
367
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
349
368
|
end
|
350
|
-
elsif !attributes[
|
351
|
-
|
369
|
+
elsif !attributes[attribute_map[key]].nil?
|
370
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
352
371
|
end
|
353
372
|
end
|
354
|
-
|
355
|
-
self
|
373
|
+
new(transformed_hash)
|
356
374
|
end
|
357
375
|
|
358
376
|
# Deserializes the data based on type
|
359
377
|
# @param string type Data type
|
360
378
|
# @param string value Value to be deserialized
|
361
379
|
# @return [Object] Deserialized data
|
362
|
-
def _deserialize(type, value)
|
380
|
+
def self._deserialize(type, value)
|
363
381
|
case type.to_sym
|
364
382
|
when :Time
|
365
383
|
Time.parse(value)
|
@@ -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.35.58
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
14
14
|
require 'time'
|
15
15
|
|
16
16
|
module VeloPayments
|
17
|
-
class
|
17
|
+
class CreateIndividualV3
|
18
18
|
attr_accessor :name
|
19
19
|
|
20
20
|
attr_accessor :national_identification
|
@@ -39,7 +39,7 @@ module VeloPayments
|
|
39
39
|
# Attribute type mapping.
|
40
40
|
def self.openapi_types
|
41
41
|
{
|
42
|
-
:'name' => :'
|
42
|
+
:'name' => :'CreateIndividualV3Name',
|
43
43
|
:'national_identification' => :'String',
|
44
44
|
:'date_of_birth' => :'Date'
|
45
45
|
}
|
@@ -55,19 +55,21 @@ module VeloPayments
|
|
55
55
|
# @param [Hash] attributes Model attributes in the form of hash
|
56
56
|
def initialize(attributes = {})
|
57
57
|
if (!attributes.is_a?(Hash))
|
58
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
58
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::CreateIndividualV3` initialize method"
|
59
59
|
end
|
60
60
|
|
61
61
|
# check to see if the attribute exists and convert string to symbol for hash key
|
62
62
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
63
63
|
if (!self.class.attribute_map.key?(k.to_sym))
|
64
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
64
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::CreateIndividualV3`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
65
65
|
end
|
66
66
|
h[k.to_sym] = v
|
67
67
|
}
|
68
68
|
|
69
69
|
if attributes.key?(:'name')
|
70
70
|
self.name = attributes[:'name']
|
71
|
+
else
|
72
|
+
self.name = nil
|
71
73
|
end
|
72
74
|
|
73
75
|
if attributes.key?(:'national_identification')
|
@@ -76,12 +78,15 @@ module VeloPayments
|
|
76
78
|
|
77
79
|
if attributes.key?(:'date_of_birth')
|
78
80
|
self.date_of_birth = attributes[:'date_of_birth']
|
81
|
+
else
|
82
|
+
self.date_of_birth = nil
|
79
83
|
end
|
80
84
|
end
|
81
85
|
|
82
86
|
# Show invalid properties with the reasons. Usually used together with valid?
|
83
87
|
# @return Array for valid properties with the reasons
|
84
88
|
def list_invalid_properties
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
85
90
|
invalid_properties = Array.new
|
86
91
|
if @name.nil?
|
87
92
|
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
@@ -105,6 +110,7 @@ module VeloPayments
|
|
105
110
|
# Check to see if the all the properties in the model are valid
|
106
111
|
# @return true if the model is valid
|
107
112
|
def valid?
|
113
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
108
114
|
return false if @name.nil?
|
109
115
|
return false if !@national_identification.nil? && @national_identification.to_s.length > 30
|
110
116
|
return false if !@national_identification.nil? && @national_identification.to_s.length < 6
|
@@ -115,11 +121,15 @@ module VeloPayments
|
|
115
121
|
# Custom attribute writer method with validation
|
116
122
|
# @param [Object] national_identification Value to be assigned
|
117
123
|
def national_identification=(national_identification)
|
118
|
-
if
|
124
|
+
if national_identification.nil?
|
125
|
+
fail ArgumentError, 'national_identification cannot be nil'
|
126
|
+
end
|
127
|
+
|
128
|
+
if national_identification.to_s.length > 30
|
119
129
|
fail ArgumentError, 'invalid value for "national_identification", the character length must be smaller than or equal to 30.'
|
120
130
|
end
|
121
131
|
|
122
|
-
if
|
132
|
+
if national_identification.to_s.length < 6
|
123
133
|
fail ArgumentError, 'invalid value for "national_identification", the character length must be great than or equal to 6.'
|
124
134
|
end
|
125
135
|
|
@@ -152,36 +162,30 @@ module VeloPayments
|
|
152
162
|
# @param [Hash] attributes Model attributes in the form of hash
|
153
163
|
# @return [Object] Returns the model itself
|
154
164
|
def self.build_from_hash(attributes)
|
155
|
-
new.build_from_hash(attributes)
|
156
|
-
end
|
157
|
-
|
158
|
-
# Builds the object from hash
|
159
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
160
|
-
# @return [Object] Returns the model itself
|
161
|
-
def build_from_hash(attributes)
|
162
165
|
return nil unless attributes.is_a?(Hash)
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
+
attributes = attributes.transform_keys(&:to_sym)
|
167
|
+
transformed_hash = {}
|
168
|
+
openapi_types.each_pair do |key, type|
|
169
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
170
|
+
transformed_hash["#{key}"] = nil
|
166
171
|
elsif type =~ /\AArray<(.*)>/i
|
167
172
|
# check to ensure the input is an array given that the attribute
|
168
173
|
# is documented as an array but the input is not
|
169
|
-
if attributes[
|
170
|
-
|
174
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
175
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
171
176
|
end
|
172
|
-
elsif !attributes[
|
173
|
-
|
177
|
+
elsif !attributes[attribute_map[key]].nil?
|
178
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
174
179
|
end
|
175
180
|
end
|
176
|
-
|
177
|
-
self
|
181
|
+
new(transformed_hash)
|
178
182
|
end
|
179
183
|
|
180
184
|
# Deserializes the data based on type
|
181
185
|
# @param string type Data type
|
182
186
|
# @param string value Value to be deserialized
|
183
187
|
# @return [Object] Deserialized data
|
184
|
-
def _deserialize(type, value)
|
188
|
+
def self._deserialize(type, value)
|
185
189
|
case type.to_sym
|
186
190
|
when :Time
|
187
191
|
Time.parse(value)
|
@@ -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.35.58
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
14
14
|
require 'time'
|
15
15
|
|
16
16
|
module VeloPayments
|
17
|
-
class
|
17
|
+
class CreateIndividualV3Name
|
18
18
|
attr_accessor :title
|
19
19
|
|
20
20
|
attr_accessor :first_name
|
@@ -58,13 +58,13 @@ module VeloPayments
|
|
58
58
|
# @param [Hash] attributes Model attributes in the form of hash
|
59
59
|
def initialize(attributes = {})
|
60
60
|
if (!attributes.is_a?(Hash))
|
61
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::
|
61
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::CreateIndividualV3Name` initialize method"
|
62
62
|
end
|
63
63
|
|
64
64
|
# check to see if the attribute exists and convert string to symbol for hash key
|
65
65
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
66
66
|
if (!self.class.attribute_map.key?(k.to_sym))
|
67
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::
|
67
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::CreateIndividualV3Name`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
68
68
|
end
|
69
69
|
h[k.to_sym] = v
|
70
70
|
}
|
@@ -75,6 +75,8 @@ module VeloPayments
|
|
75
75
|
|
76
76
|
if attributes.key?(:'first_name')
|
77
77
|
self.first_name = attributes[:'first_name']
|
78
|
+
else
|
79
|
+
self.first_name = nil
|
78
80
|
end
|
79
81
|
|
80
82
|
if attributes.key?(:'other_names')
|
@@ -83,12 +85,15 @@ module VeloPayments
|
|
83
85
|
|
84
86
|
if attributes.key?(:'last_name')
|
85
87
|
self.last_name = attributes[:'last_name']
|
88
|
+
else
|
89
|
+
self.last_name = nil
|
86
90
|
end
|
87
91
|
end
|
88
92
|
|
89
93
|
# Show invalid properties with the reasons. Usually used together with valid?
|
90
94
|
# @return Array for valid properties with the reasons
|
91
95
|
def list_invalid_properties
|
96
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
92
97
|
invalid_properties = Array.new
|
93
98
|
if !@title.nil? && @title.to_s.length > 10
|
94
99
|
invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 10.')
|
@@ -136,6 +141,7 @@ module VeloPayments
|
|
136
141
|
# Check to see if the all the properties in the model are valid
|
137
142
|
# @return true if the model is valid
|
138
143
|
def valid?
|
144
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
139
145
|
return false if !@title.nil? && @title.to_s.length > 10
|
140
146
|
return false if !@title.nil? && @title.to_s.length < 1
|
141
147
|
return false if @first_name.nil?
|
@@ -152,11 +158,15 @@ module VeloPayments
|
|
152
158
|
# Custom attribute writer method with validation
|
153
159
|
# @param [Object] title Value to be assigned
|
154
160
|
def title=(title)
|
155
|
-
if
|
161
|
+
if title.nil?
|
162
|
+
fail ArgumentError, 'title cannot be nil'
|
163
|
+
end
|
164
|
+
|
165
|
+
if title.to_s.length > 10
|
156
166
|
fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 10.'
|
157
167
|
end
|
158
168
|
|
159
|
-
if
|
169
|
+
if title.to_s.length < 1
|
160
170
|
fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.'
|
161
171
|
end
|
162
172
|
|
@@ -184,11 +194,15 @@ module VeloPayments
|
|
184
194
|
# Custom attribute writer method with validation
|
185
195
|
# @param [Object] other_names Value to be assigned
|
186
196
|
def other_names=(other_names)
|
187
|
-
if
|
197
|
+
if other_names.nil?
|
198
|
+
fail ArgumentError, 'other_names cannot be nil'
|
199
|
+
end
|
200
|
+
|
201
|
+
if other_names.to_s.length > 40
|
188
202
|
fail ArgumentError, 'invalid value for "other_names", the character length must be smaller than or equal to 40.'
|
189
203
|
end
|
190
204
|
|
191
|
-
if
|
205
|
+
if other_names.to_s.length < 1
|
192
206
|
fail ArgumentError, 'invalid value for "other_names", the character length must be great than or equal to 1.'
|
193
207
|
end
|
194
208
|
|
@@ -240,36 +254,30 @@ module VeloPayments
|
|
240
254
|
# @param [Hash] attributes Model attributes in the form of hash
|
241
255
|
# @return [Object] Returns the model itself
|
242
256
|
def self.build_from_hash(attributes)
|
243
|
-
new.build_from_hash(attributes)
|
244
|
-
end
|
245
|
-
|
246
|
-
# Builds the object from hash
|
247
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
248
|
-
# @return [Object] Returns the model itself
|
249
|
-
def build_from_hash(attributes)
|
250
257
|
return nil unless attributes.is_a?(Hash)
|
251
|
-
|
252
|
-
|
253
|
-
|
258
|
+
attributes = attributes.transform_keys(&:to_sym)
|
259
|
+
transformed_hash = {}
|
260
|
+
openapi_types.each_pair do |key, type|
|
261
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
262
|
+
transformed_hash["#{key}"] = nil
|
254
263
|
elsif type =~ /\AArray<(.*)>/i
|
255
264
|
# check to ensure the input is an array given that the attribute
|
256
265
|
# is documented as an array but the input is not
|
257
|
-
if attributes[
|
258
|
-
|
266
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
267
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
259
268
|
end
|
260
|
-
elsif !attributes[
|
261
|
-
|
269
|
+
elsif !attributes[attribute_map[key]].nil?
|
270
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
262
271
|
end
|
263
272
|
end
|
264
|
-
|
265
|
-
self
|
273
|
+
new(transformed_hash)
|
266
274
|
end
|
267
275
|
|
268
276
|
# Deserializes the data based on type
|
269
277
|
# @param string type Data type
|
270
278
|
# @param string value Value to be deserialized
|
271
279
|
# @return [Object] Deserialized data
|
272
|
-
def _deserialize(type, value)
|
280
|
+
def self._deserialize(type, value)
|
273
281
|
case type.to_sym
|
274
282
|
when :Time
|
275
283
|
Time.parse(value)
|