velopayments 2.26.124.beta1 → 2.35.58.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/Gemfile.lock +72 -0
- data/Makefile +8 -18
- data/README.md +125 -133
- data/credentials +1 -0
- 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} +4 -4
- 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/CreatePayeesCSVRequestV3.md +74 -0
- data/docs/CreatePayeesCSVRequestV4.md +74 -0
- 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/FundingManagerPrivateApi.md +2 -2
- 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 +5 -3
- 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/InstructPayoutRequestV3.md +18 -0
- data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
- data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
- data/docs/InviteUserRequest.md +5 -3
- 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 +127 -127
- 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/{PayoutStatus.md → PayeeTypeEnum.md} +2 -2
- data/docs/PayeesApi.md +91 -91
- data/docs/PaymentAuditServiceApi.md +44 -24
- data/docs/PaymentAuditServiceDeprecatedApi.md +18 -18
- 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 +17 -7
- data/docs/PaymentV3.md +25 -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 +13 -5
- data/docs/PayorsApi.md +57 -133
- data/docs/PayoutSchedule.md +28 -0
- data/docs/PayoutScheduleV3.md +26 -0
- data/docs/PayoutSummaryAudit.md +5 -3
- data/docs/PayoutSummaryAuditV3.md +1 -1
- data/docs/PayoutSummaryResponseV3.md +12 -10
- data/docs/{PayoutServiceApi.md → PayoutsApi.md} +194 -48
- data/docs/PingResponse.md +20 -0
- 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/SchedulePayoutRequestV3.md +20 -0
- 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/TokensApi.md +2 -2
- 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/UpdatePayeeDetailsRequestV4.md +32 -0
- data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
- data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
- data/docs/UserResponse.md +4 -0
- data/docs/UsersApi.md +24 -22
- data/docs/WebhooksApi.md +74 -6
- 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 +6 -3
- data/lib/velopayments/api/login_api.rb +13 -7
- data/lib/velopayments/api/payee_invitation_api.rb +124 -112
- data/lib/velopayments/api/payees_api.rb +98 -86
- data/lib/velopayments/api/payment_audit_service_api.rb +62 -20
- 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 +57 -111
- data/lib/velopayments/api/payors_private_api.rb +6 -3
- data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +189 -43
- data/lib/velopayments/api/source_accounts_api.rb +632 -0
- data/lib/velopayments/api/tokens_api.rb +6 -3
- data/lib/velopayments/api/users_api.rb +48 -15
- data/lib/velopayments/api/webhooks_api.rb +71 -6
- data/lib/velopayments/api_client.rb +8 -6
- data/lib/velopayments/api_error.rb +3 -2
- data/lib/velopayments/configuration.rb +33 -13
- 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/{challenge2.rb → challenge_v3.rb} +22 -22
- data/lib/velopayments/models/{challenge.rb → challenge_v4.rb} +24 -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_v3.rb +1277 -0
- data/lib/velopayments/models/create_payees_csv_request_v4.rb +1277 -0
- 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 +32 -25
- 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_v3.rb +215 -0
- 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 +62 -26
- 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 -21
- data/lib/velopayments/models/{funding_event_type.rb → notification_source.rb} +48 -24
- 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 +10 -7
- data/lib/velopayments/models/{payment_rails.rb → payee_type_enum.rb} +11 -8
- 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 +139 -63
- 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 +167 -55
- 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 +65 -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 +298 -0
- data/lib/velopayments/models/payout_schedule_v3.rb +288 -0
- data/lib/velopayments/models/payout_summary_audit.rb +40 -25
- data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
- data/lib/velopayments/models/payout_summary_response_v3.rb +44 -23
- data/lib/velopayments/models/ping.rb +21 -19
- data/lib/velopayments/models/ping_response.rb +223 -0
- 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/{funding_request_v1.rb → schedule_payout_request_v3.rb} +46 -59
- 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/set_notifications_request2.rb +250 -0
- 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} +81 -32
- 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 +108 -28
- 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 +93 -102
- 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 +77 -43
- data/spec/api/payment_audit_service_api_spec.rb +97 -18
- 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} +43 -17
- 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 +46 -19
- data/spec/api/webhooks_api_spec.rb +16 -6
- data/spec/api_client_spec.rb +6 -4
- 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 +177 -0
- 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/{spec/models/failed_payee_spec.rb → specs/api/webhooks_api_spec.rb} +53 -51
- data/velopayments.gemspec +3 -3
- metadata +213 -724
- 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/OfacStatus.md +0 -15
- 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/PaymentAuditCurrency.md +0 -15
- data/docs/PaymentAuditCurrencyV3.md +0 -15
- data/docs/PaymentRails.md +0 -15
- data/docs/PayoutStatusV3.md +0 -15
- data/docs/PayoutType.md +0 -15
- data/docs/SourceAccountResponse.md +0 -44
- data/docs/SourceAccountType.md +0 -15
- data/docs/TransmissionType.md +0 -15
- data/docs/UpdatePayeeDetailsRequest2.md +0 -30
- data/docs/WatchlistStatus.md +0 -15
- data/docs/WatchlistStatus2.md +0 -15
- data/lib/velopayments/api/funding_manager_api.rb +0 -1312
- data/lib/velopayments/models/funding_account_response.rb +0 -357
- data/lib/velopayments/models/funding_account_type.rb +0 -37
- data/lib/velopayments/models/invitation_status.rb +0 -38
- data/lib/velopayments/models/invitation_status2.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/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/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_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_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 -142
- 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/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 -92
- 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_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 -306
- 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 -110
- 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_v1_spec.rb +0 -164
- data/spec/models/payor_v2_spec.rb +0 -170
- 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_status_spec.rb +0 -28
- data/spec/models/payout_status_v3_spec.rb +0 -28
- data/spec/models/payout_summary_audit_spec.rb +0 -124
- data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
- data/spec/models/payout_summary_response_v3_spec.rb +0 -88
- data/spec/models/payout_type_spec.rb +0 -28
- 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/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 -70
- 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 -124
- 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,6 +21,7 @@ module VeloPayments
|
|
21
21
|
# Decimal implied
|
22
22
|
attr_accessor :balance
|
23
23
|
|
24
|
+
# Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details.
|
24
25
|
attr_accessor :currency
|
25
26
|
|
26
27
|
# The funding reference (will not be set for DECOUPLED accounts).
|
@@ -49,7 +50,7 @@ module VeloPayments
|
|
49
50
|
|
50
51
|
attr_accessor :type
|
51
52
|
|
52
|
-
#
|
53
|
+
# Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details.
|
53
54
|
attr_accessor :country
|
54
55
|
|
55
56
|
# An optional flag for whether the source account has been deleted. Only present in the response if true.
|
@@ -61,28 +62,6 @@ module VeloPayments
|
|
61
62
|
# An optional timestamp when the source account has been deleted. Only present in the response if deleted.
|
62
63
|
attr_accessor :deleted_at
|
63
64
|
|
64
|
-
class EnumAttributeValidator
|
65
|
-
attr_reader :datatype
|
66
|
-
attr_reader :allowable_values
|
67
|
-
|
68
|
-
def initialize(datatype, allowable_values)
|
69
|
-
@allowable_values = allowable_values.map do |value|
|
70
|
-
case datatype.to_s
|
71
|
-
when /Integer/i
|
72
|
-
value.to_i
|
73
|
-
when /Float/i
|
74
|
-
value.to_f
|
75
|
-
else
|
76
|
-
value
|
77
|
-
end
|
78
|
-
end
|
79
|
-
end
|
80
|
-
|
81
|
-
def valid?(value)
|
82
|
-
!value || allowable_values.include?(value)
|
83
|
-
end
|
84
|
-
end
|
85
|
-
|
86
65
|
# Attribute mapping from ruby-style variable name to JSON key.
|
87
66
|
def self.attribute_map
|
88
67
|
{
|
@@ -126,8 +105,8 @@ module VeloPayments
|
|
126
105
|
:'pooled' => :'Boolean',
|
127
106
|
:'customer_id' => :'String',
|
128
107
|
:'physical_account_id' => :'String',
|
129
|
-
:'notifications' => :'
|
130
|
-
:'auto_top_up_config' => :'
|
108
|
+
:'notifications' => :'NotificationsV3',
|
109
|
+
:'auto_top_up_config' => :'AutoTopUpConfigV3',
|
131
110
|
:'type' => :'String',
|
132
111
|
:'country' => :'String',
|
133
112
|
:'deleted' => :'Boolean',
|
@@ -160,6 +139,8 @@ module VeloPayments
|
|
160
139
|
|
161
140
|
if attributes.key?(:'id')
|
162
141
|
self.id = attributes[:'id']
|
142
|
+
else
|
143
|
+
self.id = nil
|
163
144
|
end
|
164
145
|
|
165
146
|
if attributes.key?(:'balance')
|
@@ -180,6 +161,8 @@ module VeloPayments
|
|
180
161
|
|
181
162
|
if attributes.key?(:'rails_id')
|
182
163
|
self.rails_id = attributes[:'rails_id']
|
164
|
+
else
|
165
|
+
self.rails_id = nil
|
183
166
|
end
|
184
167
|
|
185
168
|
if attributes.key?(:'payor_id')
|
@@ -212,6 +195,8 @@ module VeloPayments
|
|
212
195
|
|
213
196
|
if attributes.key?(:'type')
|
214
197
|
self.type = attributes[:'type']
|
198
|
+
else
|
199
|
+
self.type = nil
|
215
200
|
end
|
216
201
|
|
217
202
|
if attributes.key?(:'country')
|
@@ -234,6 +219,7 @@ module VeloPayments
|
|
234
219
|
# Show invalid properties with the reasons. Usually used together with valid?
|
235
220
|
# @return Array for valid properties with the reasons
|
236
221
|
def list_invalid_properties
|
222
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
237
223
|
invalid_properties = Array.new
|
238
224
|
if @id.nil?
|
239
225
|
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
@@ -247,6 +233,11 @@ module VeloPayments
|
|
247
233
|
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
248
234
|
end
|
249
235
|
|
236
|
+
pattern = Regexp.new(/^[A-Z]{3}$/)
|
237
|
+
if !@currency.nil? && @currency !~ pattern
|
238
|
+
invalid_properties.push("invalid value for \"currency\", must conform to the pattern #{pattern}.")
|
239
|
+
end
|
240
|
+
|
250
241
|
if @rails_id.nil?
|
251
242
|
invalid_properties.push('invalid value for "rails_id", rails_id cannot be nil.')
|
252
243
|
end
|
@@ -263,45 +254,73 @@ module VeloPayments
|
|
263
254
|
invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
|
264
255
|
end
|
265
256
|
|
257
|
+
pattern = Regexp.new(/^[A-Z]{2}$/)
|
258
|
+
if !@country.nil? && @country !~ pattern
|
259
|
+
invalid_properties.push("invalid value for \"country\", must conform to the pattern #{pattern}.")
|
260
|
+
end
|
261
|
+
|
266
262
|
invalid_properties
|
267
263
|
end
|
268
264
|
|
269
265
|
# Check to see if the all the properties in the model are valid
|
270
266
|
# @return true if the model is valid
|
271
267
|
def valid?
|
268
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
272
269
|
return false if @id.nil?
|
273
|
-
currency_validator = EnumAttributeValidator.new('String', ["USD", "EUR", "GBP", "CAD", "HKD"])
|
274
|
-
return false unless currency_validator.valid?(@currency)
|
275
270
|
return false if !@currency.nil? && @currency.to_s.length > 3
|
276
271
|
return false if !@currency.nil? && @currency.to_s.length < 3
|
272
|
+
return false if !@currency.nil? && @currency !~ Regexp.new(/^[A-Z]{3}$/)
|
277
273
|
return false if @rails_id.nil?
|
278
274
|
return false if @type.nil?
|
279
275
|
return false if !@country.nil? && @country.to_s.length > 2
|
280
276
|
return false if !@country.nil? && @country.to_s.length < 2
|
277
|
+
return false if !@country.nil? && @country !~ Regexp.new(/^[A-Z]{2}$/)
|
281
278
|
true
|
282
279
|
end
|
283
280
|
|
284
|
-
# Custom attribute writer method
|
285
|
-
# @param [Object] currency
|
281
|
+
# Custom attribute writer method with validation
|
282
|
+
# @param [Object] currency Value to be assigned
|
286
283
|
def currency=(currency)
|
287
|
-
|
288
|
-
|
289
|
-
|
284
|
+
if currency.nil?
|
285
|
+
fail ArgumentError, 'currency cannot be nil'
|
286
|
+
end
|
287
|
+
|
288
|
+
if currency.to_s.length > 3
|
289
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
290
|
+
end
|
291
|
+
|
292
|
+
if currency.to_s.length < 3
|
293
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
294
|
+
end
|
295
|
+
|
296
|
+
pattern = Regexp.new(/^[A-Z]{3}$/)
|
297
|
+
if currency !~ pattern
|
298
|
+
fail ArgumentError, "invalid value for \"currency\", must conform to the pattern #{pattern}."
|
290
299
|
end
|
300
|
+
|
291
301
|
@currency = currency
|
292
302
|
end
|
293
303
|
|
294
304
|
# Custom attribute writer method with validation
|
295
305
|
# @param [Object] country Value to be assigned
|
296
306
|
def country=(country)
|
297
|
-
if
|
307
|
+
if country.nil?
|
308
|
+
fail ArgumentError, 'country cannot be nil'
|
309
|
+
end
|
310
|
+
|
311
|
+
if country.to_s.length > 2
|
298
312
|
fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
|
299
313
|
end
|
300
314
|
|
301
|
-
if
|
315
|
+
if country.to_s.length < 2
|
302
316
|
fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
|
303
317
|
end
|
304
318
|
|
319
|
+
pattern = Regexp.new(/^[A-Z]{2}$/)
|
320
|
+
if country !~ pattern
|
321
|
+
fail ArgumentError, "invalid value for \"country\", must conform to the pattern #{pattern}."
|
322
|
+
end
|
323
|
+
|
305
324
|
@country = country
|
306
325
|
end
|
307
326
|
|
@@ -346,36 +365,30 @@ module VeloPayments
|
|
346
365
|
# @param [Hash] attributes Model attributes in the form of hash
|
347
366
|
# @return [Object] Returns the model itself
|
348
367
|
def self.build_from_hash(attributes)
|
349
|
-
new.build_from_hash(attributes)
|
350
|
-
end
|
351
|
-
|
352
|
-
# Builds the object from hash
|
353
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
354
|
-
# @return [Object] Returns the model itself
|
355
|
-
def build_from_hash(attributes)
|
356
368
|
return nil unless attributes.is_a?(Hash)
|
357
|
-
|
358
|
-
|
359
|
-
|
369
|
+
attributes = attributes.transform_keys(&:to_sym)
|
370
|
+
transformed_hash = {}
|
371
|
+
openapi_types.each_pair do |key, type|
|
372
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
373
|
+
transformed_hash["#{key}"] = nil
|
360
374
|
elsif type =~ /\AArray<(.*)>/i
|
361
375
|
# check to ensure the input is an array given that the attribute
|
362
376
|
# is documented as an array but the input is not
|
363
|
-
if attributes[
|
364
|
-
|
377
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
378
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
365
379
|
end
|
366
|
-
elsif !attributes[
|
367
|
-
|
380
|
+
elsif !attributes[attribute_map[key]].nil?
|
381
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
368
382
|
end
|
369
383
|
end
|
370
|
-
|
371
|
-
self
|
384
|
+
new(transformed_hash)
|
372
385
|
end
|
373
386
|
|
374
387
|
# Deserializes the data based on type
|
375
388
|
# @param string type Data type
|
376
389
|
# @param string value Value to be deserialized
|
377
390
|
# @return [Object] Deserialized data
|
378
|
-
def _deserialize(type, value)
|
391
|
+
def self._deserialize(type, value)
|
379
392
|
case type.to_sym
|
380
393
|
when :Time
|
381
394
|
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
|
|
@@ -19,6 +19,7 @@ module VeloPayments
|
|
19
19
|
|
20
20
|
attr_accessor :total_cost
|
21
21
|
|
22
|
+
# ISO-4217 3 character currency code
|
22
23
|
attr_accessor :currency
|
23
24
|
|
24
25
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -40,7 +41,7 @@ module VeloPayments
|
|
40
41
|
{
|
41
42
|
:'source_account_id' => :'String',
|
42
43
|
:'total_cost' => :'Integer',
|
43
|
-
:'currency' => :'
|
44
|
+
:'currency' => :'String'
|
44
45
|
}
|
45
46
|
end
|
46
47
|
|
@@ -67,10 +68,14 @@ module VeloPayments
|
|
67
68
|
|
68
69
|
if attributes.key?(:'source_account_id')
|
69
70
|
self.source_account_id = attributes[:'source_account_id']
|
71
|
+
else
|
72
|
+
self.source_account_id = nil
|
70
73
|
end
|
71
74
|
|
72
75
|
if attributes.key?(:'total_cost')
|
73
76
|
self.total_cost = attributes[:'total_cost']
|
77
|
+
else
|
78
|
+
self.total_cost = nil
|
74
79
|
end
|
75
80
|
|
76
81
|
if attributes.key?(:'currency')
|
@@ -81,6 +86,7 @@ module VeloPayments
|
|
81
86
|
# Show invalid properties with the reasons. Usually used together with valid?
|
82
87
|
# @return Array for valid properties with the reasons
|
83
88
|
def list_invalid_properties
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
84
90
|
invalid_properties = Array.new
|
85
91
|
if @source_account_id.nil?
|
86
92
|
invalid_properties.push('invalid value for "source_account_id", source_account_id cannot be nil.')
|
@@ -90,17 +96,46 @@ module VeloPayments
|
|
90
96
|
invalid_properties.push('invalid value for "total_cost", total_cost cannot be nil.')
|
91
97
|
end
|
92
98
|
|
99
|
+
if !@currency.nil? && @currency.to_s.length > 3
|
100
|
+
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
101
|
+
end
|
102
|
+
|
103
|
+
if !@currency.nil? && @currency.to_s.length < 3
|
104
|
+
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
105
|
+
end
|
106
|
+
|
93
107
|
invalid_properties
|
94
108
|
end
|
95
109
|
|
96
110
|
# Check to see if the all the properties in the model are valid
|
97
111
|
# @return true if the model is valid
|
98
112
|
def valid?
|
113
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
99
114
|
return false if @source_account_id.nil?
|
100
115
|
return false if @total_cost.nil?
|
116
|
+
return false if !@currency.nil? && @currency.to_s.length > 3
|
117
|
+
return false if !@currency.nil? && @currency.to_s.length < 3
|
101
118
|
true
|
102
119
|
end
|
103
120
|
|
121
|
+
# Custom attribute writer method with validation
|
122
|
+
# @param [Object] currency Value to be assigned
|
123
|
+
def currency=(currency)
|
124
|
+
if currency.nil?
|
125
|
+
fail ArgumentError, 'currency cannot be nil'
|
126
|
+
end
|
127
|
+
|
128
|
+
if currency.to_s.length > 3
|
129
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
130
|
+
end
|
131
|
+
|
132
|
+
if currency.to_s.length < 3
|
133
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
134
|
+
end
|
135
|
+
|
136
|
+
@currency = currency
|
137
|
+
end
|
138
|
+
|
104
139
|
# Checks equality by comparing each attribute.
|
105
140
|
# @param [Object] Object to be compared
|
106
141
|
def ==(o)
|
@@ -127,36 +162,30 @@ module VeloPayments
|
|
127
162
|
# @param [Hash] attributes Model attributes in the form of hash
|
128
163
|
# @return [Object] Returns the model itself
|
129
164
|
def self.build_from_hash(attributes)
|
130
|
-
new.build_from_hash(attributes)
|
131
|
-
end
|
132
|
-
|
133
|
-
# Builds the object from hash
|
134
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
135
|
-
# @return [Object] Returns the model itself
|
136
|
-
def build_from_hash(attributes)
|
137
165
|
return nil unless attributes.is_a?(Hash)
|
138
|
-
|
139
|
-
|
140
|
-
|
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
|
141
171
|
elsif type =~ /\AArray<(.*)>/i
|
142
172
|
# check to ensure the input is an array given that the attribute
|
143
173
|
# is documented as an array but the input is not
|
144
|
-
if attributes[
|
145
|
-
|
174
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
175
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
146
176
|
end
|
147
|
-
elsif !attributes[
|
148
|
-
|
177
|
+
elsif !attributes[attribute_map[key]].nil?
|
178
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
149
179
|
end
|
150
180
|
end
|
151
|
-
|
152
|
-
self
|
181
|
+
new(transformed_hash)
|
153
182
|
end
|
154
183
|
|
155
184
|
# Deserializes the data based on type
|
156
185
|
# @param string type Data type
|
157
186
|
# @param string value Value to be deserialized
|
158
187
|
# @return [Object] Deserialized data
|
159
|
-
def _deserialize(type, value)
|
188
|
+
def self._deserialize(type, value)
|
160
189
|
case type.to_sym
|
161
190
|
when :Time
|
162
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
|
|
@@ -19,6 +19,7 @@ module VeloPayments
|
|
19
19
|
|
20
20
|
attr_accessor :total_cost
|
21
21
|
|
22
|
+
# ISO 3 character currency code
|
22
23
|
attr_accessor :currency
|
23
24
|
|
24
25
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -40,7 +41,7 @@ module VeloPayments
|
|
40
41
|
{
|
41
42
|
:'source_account_id' => :'String',
|
42
43
|
:'total_cost' => :'Integer',
|
43
|
-
:'currency' => :'
|
44
|
+
:'currency' => :'String'
|
44
45
|
}
|
45
46
|
end
|
46
47
|
|
@@ -67,10 +68,14 @@ module VeloPayments
|
|
67
68
|
|
68
69
|
if attributes.key?(:'source_account_id')
|
69
70
|
self.source_account_id = attributes[:'source_account_id']
|
71
|
+
else
|
72
|
+
self.source_account_id = nil
|
70
73
|
end
|
71
74
|
|
72
75
|
if attributes.key?(:'total_cost')
|
73
76
|
self.total_cost = attributes[:'total_cost']
|
77
|
+
else
|
78
|
+
self.total_cost = nil
|
74
79
|
end
|
75
80
|
|
76
81
|
if attributes.key?(:'currency')
|
@@ -81,6 +86,7 @@ module VeloPayments
|
|
81
86
|
# Show invalid properties with the reasons. Usually used together with valid?
|
82
87
|
# @return Array for valid properties with the reasons
|
83
88
|
def list_invalid_properties
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
84
90
|
invalid_properties = Array.new
|
85
91
|
if @source_account_id.nil?
|
86
92
|
invalid_properties.push('invalid value for "source_account_id", source_account_id cannot be nil.')
|
@@ -90,17 +96,46 @@ module VeloPayments
|
|
90
96
|
invalid_properties.push('invalid value for "total_cost", total_cost cannot be nil.')
|
91
97
|
end
|
92
98
|
|
99
|
+
if !@currency.nil? && @currency.to_s.length > 3
|
100
|
+
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
101
|
+
end
|
102
|
+
|
103
|
+
if !@currency.nil? && @currency.to_s.length < 3
|
104
|
+
invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
|
105
|
+
end
|
106
|
+
|
93
107
|
invalid_properties
|
94
108
|
end
|
95
109
|
|
96
110
|
# Check to see if the all the properties in the model are valid
|
97
111
|
# @return true if the model is valid
|
98
112
|
def valid?
|
113
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
99
114
|
return false if @source_account_id.nil?
|
100
115
|
return false if @total_cost.nil?
|
116
|
+
return false if !@currency.nil? && @currency.to_s.length > 3
|
117
|
+
return false if !@currency.nil? && @currency.to_s.length < 3
|
101
118
|
true
|
102
119
|
end
|
103
120
|
|
121
|
+
# Custom attribute writer method with validation
|
122
|
+
# @param [Object] currency Value to be assigned
|
123
|
+
def currency=(currency)
|
124
|
+
if currency.nil?
|
125
|
+
fail ArgumentError, 'currency cannot be nil'
|
126
|
+
end
|
127
|
+
|
128
|
+
if currency.to_s.length > 3
|
129
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
130
|
+
end
|
131
|
+
|
132
|
+
if currency.to_s.length < 3
|
133
|
+
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
134
|
+
end
|
135
|
+
|
136
|
+
@currency = currency
|
137
|
+
end
|
138
|
+
|
104
139
|
# Checks equality by comparing each attribute.
|
105
140
|
# @param [Object] Object to be compared
|
106
141
|
def ==(o)
|
@@ -127,36 +162,30 @@ module VeloPayments
|
|
127
162
|
# @param [Hash] attributes Model attributes in the form of hash
|
128
163
|
# @return [Object] Returns the model itself
|
129
164
|
def self.build_from_hash(attributes)
|
130
|
-
new.build_from_hash(attributes)
|
131
|
-
end
|
132
|
-
|
133
|
-
# Builds the object from hash
|
134
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
135
|
-
# @return [Object] Returns the model itself
|
136
|
-
def build_from_hash(attributes)
|
137
165
|
return nil unless attributes.is_a?(Hash)
|
138
|
-
|
139
|
-
|
140
|
-
|
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
|
141
171
|
elsif type =~ /\AArray<(.*)>/i
|
142
172
|
# check to ensure the input is an array given that the attribute
|
143
173
|
# is documented as an array but the input is not
|
144
|
-
if attributes[
|
145
|
-
|
174
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
175
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
146
176
|
end
|
147
|
-
elsif !attributes[
|
148
|
-
|
177
|
+
elsif !attributes[attribute_map[key]].nil?
|
178
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
149
179
|
end
|
150
180
|
end
|
151
|
-
|
152
|
-
self
|
181
|
+
new(transformed_hash)
|
153
182
|
end
|
154
183
|
|
155
184
|
# Deserializes the data based on type
|
156
185
|
# @param string type Data type
|
157
186
|
# @param string value Value to be deserialized
|
158
187
|
# @return [Object] Deserialized data
|
159
|
-
def _deserialize(type, value)
|
188
|
+
def self._deserialize(type, value)
|
160
189
|
case type.to_sym
|
161
190
|
when :Time
|
162
191
|
Time.parse(value)
|