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
|
|
@@ -27,36 +27,18 @@ module VeloPayments
|
|
27
27
|
|
28
28
|
attr_accessor :total_payment_amount
|
29
29
|
|
30
|
+
# ISO-4217 3 character currency code
|
30
31
|
attr_accessor :source_currency
|
31
32
|
|
33
|
+
# ISO-4217 3 character currency code
|
32
34
|
attr_accessor :payment_currency
|
33
35
|
|
36
|
+
# Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED
|
34
37
|
attr_accessor :status
|
35
38
|
|
39
|
+
# Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED
|
36
40
|
attr_accessor :funding_status
|
37
41
|
|
38
|
-
class EnumAttributeValidator
|
39
|
-
attr_reader :datatype
|
40
|
-
attr_reader :allowable_values
|
41
|
-
|
42
|
-
def initialize(datatype, allowable_values)
|
43
|
-
@allowable_values = allowable_values.map do |value|
|
44
|
-
case datatype.to_s
|
45
|
-
when /Integer/i
|
46
|
-
value.to_i
|
47
|
-
when /Float/i
|
48
|
-
value.to_f
|
49
|
-
else
|
50
|
-
value
|
51
|
-
end
|
52
|
-
end
|
53
|
-
end
|
54
|
-
|
55
|
-
def valid?(value)
|
56
|
-
!value || allowable_values.include?(value)
|
57
|
-
end
|
58
|
-
end
|
59
|
-
|
60
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
61
43
|
def self.attribute_map
|
62
44
|
{
|
@@ -87,8 +69,8 @@ module VeloPayments
|
|
87
69
|
:'inverted_rate' => :'Float',
|
88
70
|
:'total_cost' => :'Integer',
|
89
71
|
:'total_payment_amount' => :'Integer',
|
90
|
-
:'source_currency' => :'
|
91
|
-
:'payment_currency' => :'
|
72
|
+
:'source_currency' => :'String',
|
73
|
+
:'payment_currency' => :'String',
|
92
74
|
:'status' => :'String',
|
93
75
|
:'funding_status' => :'String'
|
94
76
|
}
|
@@ -117,26 +99,38 @@ module VeloPayments
|
|
117
99
|
|
118
100
|
if attributes.key?(:'quote_id')
|
119
101
|
self.quote_id = attributes[:'quote_id']
|
102
|
+
else
|
103
|
+
self.quote_id = nil
|
120
104
|
end
|
121
105
|
|
122
106
|
if attributes.key?(:'creation_date_time')
|
123
107
|
self.creation_date_time = attributes[:'creation_date_time']
|
108
|
+
else
|
109
|
+
self.creation_date_time = nil
|
124
110
|
end
|
125
111
|
|
126
112
|
if attributes.key?(:'rate')
|
127
113
|
self.rate = attributes[:'rate']
|
114
|
+
else
|
115
|
+
self.rate = nil
|
128
116
|
end
|
129
117
|
|
130
118
|
if attributes.key?(:'inverted_rate')
|
131
119
|
self.inverted_rate = attributes[:'inverted_rate']
|
120
|
+
else
|
121
|
+
self.inverted_rate = nil
|
132
122
|
end
|
133
123
|
|
134
124
|
if attributes.key?(:'total_cost')
|
135
125
|
self.total_cost = attributes[:'total_cost']
|
126
|
+
else
|
127
|
+
self.total_cost = nil
|
136
128
|
end
|
137
129
|
|
138
130
|
if attributes.key?(:'total_payment_amount')
|
139
131
|
self.total_payment_amount = attributes[:'total_payment_amount']
|
132
|
+
else
|
133
|
+
self.total_payment_amount = nil
|
140
134
|
end
|
141
135
|
|
142
136
|
if attributes.key?(:'source_currency')
|
@@ -149,16 +143,21 @@ module VeloPayments
|
|
149
143
|
|
150
144
|
if attributes.key?(:'status')
|
151
145
|
self.status = attributes[:'status']
|
146
|
+
else
|
147
|
+
self.status = nil
|
152
148
|
end
|
153
149
|
|
154
150
|
if attributes.key?(:'funding_status')
|
155
151
|
self.funding_status = attributes[:'funding_status']
|
152
|
+
else
|
153
|
+
self.funding_status = nil
|
156
154
|
end
|
157
155
|
end
|
158
156
|
|
159
157
|
# Show invalid properties with the reasons. Usually used together with valid?
|
160
158
|
# @return Array for valid properties with the reasons
|
161
159
|
def list_invalid_properties
|
160
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
162
161
|
invalid_properties = Array.new
|
163
162
|
if @quote_id.nil?
|
164
163
|
invalid_properties.push('invalid value for "quote_id", quote_id cannot be nil.')
|
@@ -184,6 +183,22 @@ module VeloPayments
|
|
184
183
|
invalid_properties.push('invalid value for "total_payment_amount", total_payment_amount cannot be nil.')
|
185
184
|
end
|
186
185
|
|
186
|
+
if !@source_currency.nil? && @source_currency.to_s.length > 3
|
187
|
+
invalid_properties.push('invalid value for "source_currency", the character length must be smaller than or equal to 3.')
|
188
|
+
end
|
189
|
+
|
190
|
+
if !@source_currency.nil? && @source_currency.to_s.length < 3
|
191
|
+
invalid_properties.push('invalid value for "source_currency", the character length must be great than or equal to 3.')
|
192
|
+
end
|
193
|
+
|
194
|
+
if !@payment_currency.nil? && @payment_currency.to_s.length > 3
|
195
|
+
invalid_properties.push('invalid value for "payment_currency", the character length must be smaller than or equal to 3.')
|
196
|
+
end
|
197
|
+
|
198
|
+
if !@payment_currency.nil? && @payment_currency.to_s.length < 3
|
199
|
+
invalid_properties.push('invalid value for "payment_currency", the character length must be great than or equal to 3.')
|
200
|
+
end
|
201
|
+
|
187
202
|
if @status.nil?
|
188
203
|
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
189
204
|
end
|
@@ -198,39 +213,56 @@ module VeloPayments
|
|
198
213
|
# Check to see if the all the properties in the model are valid
|
199
214
|
# @return true if the model is valid
|
200
215
|
def valid?
|
216
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
201
217
|
return false if @quote_id.nil?
|
202
218
|
return false if @creation_date_time.nil?
|
203
219
|
return false if @rate.nil?
|
204
220
|
return false if @inverted_rate.nil?
|
205
221
|
return false if @total_cost.nil?
|
206
222
|
return false if @total_payment_amount.nil?
|
223
|
+
return false if !@source_currency.nil? && @source_currency.to_s.length > 3
|
224
|
+
return false if !@source_currency.nil? && @source_currency.to_s.length < 3
|
225
|
+
return false if !@payment_currency.nil? && @payment_currency.to_s.length > 3
|
226
|
+
return false if !@payment_currency.nil? && @payment_currency.to_s.length < 3
|
207
227
|
return false if @status.nil?
|
208
|
-
status_validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED"])
|
209
|
-
return false unless status_validator.valid?(@status)
|
210
228
|
return false if @funding_status.nil?
|
211
|
-
funding_status_validator = EnumAttributeValidator.new('String', ["FUNDED", "INSTRUCTED", "UNFUNDED"])
|
212
|
-
return false unless funding_status_validator.valid?(@funding_status)
|
213
229
|
true
|
214
230
|
end
|
215
231
|
|
216
|
-
# Custom attribute writer method
|
217
|
-
# @param [Object]
|
218
|
-
def
|
219
|
-
|
220
|
-
|
221
|
-
|
232
|
+
# Custom attribute writer method with validation
|
233
|
+
# @param [Object] source_currency Value to be assigned
|
234
|
+
def source_currency=(source_currency)
|
235
|
+
if source_currency.nil?
|
236
|
+
fail ArgumentError, 'source_currency cannot be nil'
|
237
|
+
end
|
238
|
+
|
239
|
+
if source_currency.to_s.length > 3
|
240
|
+
fail ArgumentError, 'invalid value for "source_currency", the character length must be smaller than or equal to 3.'
|
222
241
|
end
|
223
|
-
|
242
|
+
|
243
|
+
if source_currency.to_s.length < 3
|
244
|
+
fail ArgumentError, 'invalid value for "source_currency", the character length must be great than or equal to 3.'
|
245
|
+
end
|
246
|
+
|
247
|
+
@source_currency = source_currency
|
224
248
|
end
|
225
249
|
|
226
|
-
# Custom attribute writer method
|
227
|
-
# @param [Object]
|
228
|
-
def
|
229
|
-
|
230
|
-
|
231
|
-
|
250
|
+
# Custom attribute writer method with validation
|
251
|
+
# @param [Object] payment_currency Value to be assigned
|
252
|
+
def payment_currency=(payment_currency)
|
253
|
+
if payment_currency.nil?
|
254
|
+
fail ArgumentError, 'payment_currency cannot be nil'
|
255
|
+
end
|
256
|
+
|
257
|
+
if payment_currency.to_s.length > 3
|
258
|
+
fail ArgumentError, 'invalid value for "payment_currency", the character length must be smaller than or equal to 3.'
|
232
259
|
end
|
233
|
-
|
260
|
+
|
261
|
+
if payment_currency.to_s.length < 3
|
262
|
+
fail ArgumentError, 'invalid value for "payment_currency", the character length must be great than or equal to 3.'
|
263
|
+
end
|
264
|
+
|
265
|
+
@payment_currency = payment_currency
|
234
266
|
end
|
235
267
|
|
236
268
|
# Checks equality by comparing each attribute.
|
@@ -266,36 +298,30 @@ module VeloPayments
|
|
266
298
|
# @param [Hash] attributes Model attributes in the form of hash
|
267
299
|
# @return [Object] Returns the model itself
|
268
300
|
def self.build_from_hash(attributes)
|
269
|
-
new.build_from_hash(attributes)
|
270
|
-
end
|
271
|
-
|
272
|
-
# Builds the object from hash
|
273
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
274
|
-
# @return [Object] Returns the model itself
|
275
|
-
def build_from_hash(attributes)
|
276
301
|
return nil unless attributes.is_a?(Hash)
|
277
|
-
|
278
|
-
|
279
|
-
|
302
|
+
attributes = attributes.transform_keys(&:to_sym)
|
303
|
+
transformed_hash = {}
|
304
|
+
openapi_types.each_pair do |key, type|
|
305
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
306
|
+
transformed_hash["#{key}"] = nil
|
280
307
|
elsif type =~ /\AArray<(.*)>/i
|
281
308
|
# check to ensure the input is an array given that the attribute
|
282
309
|
# is documented as an array but the input is not
|
283
|
-
if attributes[
|
284
|
-
|
310
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
311
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
285
312
|
end
|
286
|
-
elsif !attributes[
|
287
|
-
|
313
|
+
elsif !attributes[attribute_map[key]].nil?
|
314
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
288
315
|
end
|
289
316
|
end
|
290
|
-
|
291
|
-
self
|
317
|
+
new(transformed_hash)
|
292
318
|
end
|
293
319
|
|
294
320
|
# Deserializes the data based on type
|
295
321
|
# @param string type Data type
|
296
322
|
# @param string value Value to be deserialized
|
297
323
|
# @return [Object] Deserialized data
|
298
|
-
def _deserialize(type, value)
|
324
|
+
def self._deserialize(type, value)
|
299
325
|
case type.to_sym
|
300
326
|
when :Time
|
301
327
|
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
|
|
@@ -27,36 +27,18 @@ module VeloPayments
|
|
27
27
|
|
28
28
|
attr_accessor :total_payment_amount
|
29
29
|
|
30
|
+
# ISO 3 character currency code
|
30
31
|
attr_accessor :source_currency
|
31
32
|
|
33
|
+
# ISO 3 character currency code
|
32
34
|
attr_accessor :payment_currency
|
33
35
|
|
36
|
+
# Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED
|
34
37
|
attr_accessor :status
|
35
38
|
|
39
|
+
# Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED
|
36
40
|
attr_accessor :funding_status
|
37
41
|
|
38
|
-
class EnumAttributeValidator
|
39
|
-
attr_reader :datatype
|
40
|
-
attr_reader :allowable_values
|
41
|
-
|
42
|
-
def initialize(datatype, allowable_values)
|
43
|
-
@allowable_values = allowable_values.map do |value|
|
44
|
-
case datatype.to_s
|
45
|
-
when /Integer/i
|
46
|
-
value.to_i
|
47
|
-
when /Float/i
|
48
|
-
value.to_f
|
49
|
-
else
|
50
|
-
value
|
51
|
-
end
|
52
|
-
end
|
53
|
-
end
|
54
|
-
|
55
|
-
def valid?(value)
|
56
|
-
!value || allowable_values.include?(value)
|
57
|
-
end
|
58
|
-
end
|
59
|
-
|
60
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
61
43
|
def self.attribute_map
|
62
44
|
{
|
@@ -87,8 +69,8 @@ module VeloPayments
|
|
87
69
|
:'inverted_rate' => :'Float',
|
88
70
|
:'total_cost' => :'Integer',
|
89
71
|
:'total_payment_amount' => :'Integer',
|
90
|
-
:'source_currency' => :'
|
91
|
-
:'payment_currency' => :'
|
72
|
+
:'source_currency' => :'String',
|
73
|
+
:'payment_currency' => :'String',
|
92
74
|
:'status' => :'String',
|
93
75
|
:'funding_status' => :'String'
|
94
76
|
}
|
@@ -117,26 +99,38 @@ module VeloPayments
|
|
117
99
|
|
118
100
|
if attributes.key?(:'quote_id')
|
119
101
|
self.quote_id = attributes[:'quote_id']
|
102
|
+
else
|
103
|
+
self.quote_id = nil
|
120
104
|
end
|
121
105
|
|
122
106
|
if attributes.key?(:'creation_date_time')
|
123
107
|
self.creation_date_time = attributes[:'creation_date_time']
|
108
|
+
else
|
109
|
+
self.creation_date_time = nil
|
124
110
|
end
|
125
111
|
|
126
112
|
if attributes.key?(:'rate')
|
127
113
|
self.rate = attributes[:'rate']
|
114
|
+
else
|
115
|
+
self.rate = nil
|
128
116
|
end
|
129
117
|
|
130
118
|
if attributes.key?(:'inverted_rate')
|
131
119
|
self.inverted_rate = attributes[:'inverted_rate']
|
120
|
+
else
|
121
|
+
self.inverted_rate = nil
|
132
122
|
end
|
133
123
|
|
134
124
|
if attributes.key?(:'total_cost')
|
135
125
|
self.total_cost = attributes[:'total_cost']
|
126
|
+
else
|
127
|
+
self.total_cost = nil
|
136
128
|
end
|
137
129
|
|
138
130
|
if attributes.key?(:'total_payment_amount')
|
139
131
|
self.total_payment_amount = attributes[:'total_payment_amount']
|
132
|
+
else
|
133
|
+
self.total_payment_amount = nil
|
140
134
|
end
|
141
135
|
|
142
136
|
if attributes.key?(:'source_currency')
|
@@ -149,16 +143,21 @@ module VeloPayments
|
|
149
143
|
|
150
144
|
if attributes.key?(:'status')
|
151
145
|
self.status = attributes[:'status']
|
146
|
+
else
|
147
|
+
self.status = nil
|
152
148
|
end
|
153
149
|
|
154
150
|
if attributes.key?(:'funding_status')
|
155
151
|
self.funding_status = attributes[:'funding_status']
|
152
|
+
else
|
153
|
+
self.funding_status = nil
|
156
154
|
end
|
157
155
|
end
|
158
156
|
|
159
157
|
# Show invalid properties with the reasons. Usually used together with valid?
|
160
158
|
# @return Array for valid properties with the reasons
|
161
159
|
def list_invalid_properties
|
160
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
162
161
|
invalid_properties = Array.new
|
163
162
|
if @quote_id.nil?
|
164
163
|
invalid_properties.push('invalid value for "quote_id", quote_id cannot be nil.')
|
@@ -184,6 +183,22 @@ module VeloPayments
|
|
184
183
|
invalid_properties.push('invalid value for "total_payment_amount", total_payment_amount cannot be nil.')
|
185
184
|
end
|
186
185
|
|
186
|
+
if !@source_currency.nil? && @source_currency.to_s.length > 3
|
187
|
+
invalid_properties.push('invalid value for "source_currency", the character length must be smaller than or equal to 3.')
|
188
|
+
end
|
189
|
+
|
190
|
+
if !@source_currency.nil? && @source_currency.to_s.length < 3
|
191
|
+
invalid_properties.push('invalid value for "source_currency", the character length must be great than or equal to 3.')
|
192
|
+
end
|
193
|
+
|
194
|
+
if !@payment_currency.nil? && @payment_currency.to_s.length > 3
|
195
|
+
invalid_properties.push('invalid value for "payment_currency", the character length must be smaller than or equal to 3.')
|
196
|
+
end
|
197
|
+
|
198
|
+
if !@payment_currency.nil? && @payment_currency.to_s.length < 3
|
199
|
+
invalid_properties.push('invalid value for "payment_currency", the character length must be great than or equal to 3.')
|
200
|
+
end
|
201
|
+
|
187
202
|
if @status.nil?
|
188
203
|
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
189
204
|
end
|
@@ -198,39 +213,56 @@ module VeloPayments
|
|
198
213
|
# Check to see if the all the properties in the model are valid
|
199
214
|
# @return true if the model is valid
|
200
215
|
def valid?
|
216
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
201
217
|
return false if @quote_id.nil?
|
202
218
|
return false if @creation_date_time.nil?
|
203
219
|
return false if @rate.nil?
|
204
220
|
return false if @inverted_rate.nil?
|
205
221
|
return false if @total_cost.nil?
|
206
222
|
return false if @total_payment_amount.nil?
|
223
|
+
return false if !@source_currency.nil? && @source_currency.to_s.length > 3
|
224
|
+
return false if !@source_currency.nil? && @source_currency.to_s.length < 3
|
225
|
+
return false if !@payment_currency.nil? && @payment_currency.to_s.length > 3
|
226
|
+
return false if !@payment_currency.nil? && @payment_currency.to_s.length < 3
|
207
227
|
return false if @status.nil?
|
208
|
-
status_validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED"])
|
209
|
-
return false unless status_validator.valid?(@status)
|
210
228
|
return false if @funding_status.nil?
|
211
|
-
funding_status_validator = EnumAttributeValidator.new('String', ["FUNDED", "INSTRUCTED", "UNFUNDED"])
|
212
|
-
return false unless funding_status_validator.valid?(@funding_status)
|
213
229
|
true
|
214
230
|
end
|
215
231
|
|
216
|
-
# Custom attribute writer method
|
217
|
-
# @param [Object]
|
218
|
-
def
|
219
|
-
|
220
|
-
|
221
|
-
|
232
|
+
# Custom attribute writer method with validation
|
233
|
+
# @param [Object] source_currency Value to be assigned
|
234
|
+
def source_currency=(source_currency)
|
235
|
+
if source_currency.nil?
|
236
|
+
fail ArgumentError, 'source_currency cannot be nil'
|
237
|
+
end
|
238
|
+
|
239
|
+
if source_currency.to_s.length > 3
|
240
|
+
fail ArgumentError, 'invalid value for "source_currency", the character length must be smaller than or equal to 3.'
|
222
241
|
end
|
223
|
-
|
242
|
+
|
243
|
+
if source_currency.to_s.length < 3
|
244
|
+
fail ArgumentError, 'invalid value for "source_currency", the character length must be great than or equal to 3.'
|
245
|
+
end
|
246
|
+
|
247
|
+
@source_currency = source_currency
|
224
248
|
end
|
225
249
|
|
226
|
-
# Custom attribute writer method
|
227
|
-
# @param [Object]
|
228
|
-
def
|
229
|
-
|
230
|
-
|
231
|
-
|
250
|
+
# Custom attribute writer method with validation
|
251
|
+
# @param [Object] payment_currency Value to be assigned
|
252
|
+
def payment_currency=(payment_currency)
|
253
|
+
if payment_currency.nil?
|
254
|
+
fail ArgumentError, 'payment_currency cannot be nil'
|
255
|
+
end
|
256
|
+
|
257
|
+
if payment_currency.to_s.length > 3
|
258
|
+
fail ArgumentError, 'invalid value for "payment_currency", the character length must be smaller than or equal to 3.'
|
232
259
|
end
|
233
|
-
|
260
|
+
|
261
|
+
if payment_currency.to_s.length < 3
|
262
|
+
fail ArgumentError, 'invalid value for "payment_currency", the character length must be great than or equal to 3.'
|
263
|
+
end
|
264
|
+
|
265
|
+
@payment_currency = payment_currency
|
234
266
|
end
|
235
267
|
|
236
268
|
# Checks equality by comparing each attribute.
|
@@ -266,36 +298,30 @@ module VeloPayments
|
|
266
298
|
# @param [Hash] attributes Model attributes in the form of hash
|
267
299
|
# @return [Object] Returns the model itself
|
268
300
|
def self.build_from_hash(attributes)
|
269
|
-
new.build_from_hash(attributes)
|
270
|
-
end
|
271
|
-
|
272
|
-
# Builds the object from hash
|
273
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
274
|
-
# @return [Object] Returns the model itself
|
275
|
-
def build_from_hash(attributes)
|
276
301
|
return nil unless attributes.is_a?(Hash)
|
277
|
-
|
278
|
-
|
279
|
-
|
302
|
+
attributes = attributes.transform_keys(&:to_sym)
|
303
|
+
transformed_hash = {}
|
304
|
+
openapi_types.each_pair do |key, type|
|
305
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
306
|
+
transformed_hash["#{key}"] = nil
|
280
307
|
elsif type =~ /\AArray<(.*)>/i
|
281
308
|
# check to ensure the input is an array given that the attribute
|
282
309
|
# is documented as an array but the input is not
|
283
|
-
if attributes[
|
284
|
-
|
310
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
311
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
285
312
|
end
|
286
|
-
elsif !attributes[
|
287
|
-
|
313
|
+
elsif !attributes[attribute_map[key]].nil?
|
314
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
288
315
|
end
|
289
316
|
end
|
290
|
-
|
291
|
-
self
|
317
|
+
new(transformed_hash)
|
292
318
|
end
|
293
319
|
|
294
320
|
# Deserializes the data based on type
|
295
321
|
# @param string type Data type
|
296
322
|
# @param string value Value to be deserialized
|
297
323
|
# @return [Object] Deserialized data
|
298
|
-
def _deserialize(type, value)
|
324
|
+
def self._deserialize(type, value)
|
299
325
|
case type.to_sym
|
300
326
|
when :Time
|
301
327
|
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
|
|
@@ -86,6 +86,7 @@ module VeloPayments
|
|
86
86
|
# Show invalid properties with the reasons. Usually used together with valid?
|
87
87
|
# @return Array for valid properties with the reasons
|
88
88
|
def list_invalid_properties
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
89
90
|
invalid_properties = Array.new
|
90
91
|
invalid_properties
|
91
92
|
end
|
@@ -93,6 +94,7 @@ module VeloPayments
|
|
93
94
|
# Check to see if the all the properties in the model are valid
|
94
95
|
# @return true if the model is valid
|
95
96
|
def valid?
|
97
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
96
98
|
true
|
97
99
|
end
|
98
100
|
|
@@ -122,36 +124,30 @@ module VeloPayments
|
|
122
124
|
# @param [Hash] attributes Model attributes in the form of hash
|
123
125
|
# @return [Object] Returns the model itself
|
124
126
|
def self.build_from_hash(attributes)
|
125
|
-
new.build_from_hash(attributes)
|
126
|
-
end
|
127
|
-
|
128
|
-
# Builds the object from hash
|
129
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
130
|
-
# @return [Object] Returns the model itself
|
131
|
-
def build_from_hash(attributes)
|
132
127
|
return nil unless attributes.is_a?(Hash)
|
133
|
-
|
134
|
-
|
135
|
-
|
128
|
+
attributes = attributes.transform_keys(&:to_sym)
|
129
|
+
transformed_hash = {}
|
130
|
+
openapi_types.each_pair do |key, type|
|
131
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
132
|
+
transformed_hash["#{key}"] = nil
|
136
133
|
elsif type =~ /\AArray<(.*)>/i
|
137
134
|
# check to ensure the input is an array given that the attribute
|
138
135
|
# is documented as an array but the input is not
|
139
|
-
if attributes[
|
140
|
-
|
136
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
137
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
141
138
|
end
|
142
|
-
elsif !attributes[
|
143
|
-
|
139
|
+
elsif !attributes[attribute_map[key]].nil?
|
140
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
144
141
|
end
|
145
142
|
end
|
146
|
-
|
147
|
-
self
|
143
|
+
new(transformed_hash)
|
148
144
|
end
|
149
145
|
|
150
146
|
# Deserializes the data based on type
|
151
147
|
# @param string type Data type
|
152
148
|
# @param string value Value to be deserialized
|
153
149
|
# @return [Object] Deserialized data
|
154
|
-
def _deserialize(type, value)
|
150
|
+
def self._deserialize(type, value)
|
155
151
|
case type.to_sym
|
156
152
|
when :Time
|
157
153
|
Time.parse(value)
|