velopayments 2.20.29.beta1 → 2.29.128.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +2 -2
- data/Makefile +27 -18
- data/README.md +174 -99
- data/docs/AcceptedPaymentV3.md +32 -0
- data/docs/AccessTokenResponse.md +20 -19
- data/docs/AccessTokenValidationRequest.md +8 -7
- data/docs/AuthResponse.md +18 -17
- data/docs/AutoTopUpConfig.md +12 -11
- data/docs/AutoTopUpConfig2.md +24 -0
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +20 -0
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +91 -38
- data/docs/CreateFundingAccountRequestV2.md +30 -0
- data/docs/CreateIndividual.md +12 -11
- data/docs/CreateIndividual2.md +12 -11
- data/docs/CreateIndividualName.md +24 -0
- data/docs/CreatePayee.md +28 -27
- data/docs/CreatePayee2.md +28 -27
- data/docs/CreatePayeeAddress.md +22 -21
- data/docs/CreatePayeeAddress2.md +22 -21
- data/docs/CreatePayeesCSVRequest.md +64 -63
- data/docs/CreatePayeesCSVRequest2.md +64 -63
- data/docs/CreatePayeesCSVResponse.md +10 -9
- data/docs/CreatePayeesCSVResponse2.md +10 -9
- data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
- data/docs/CreatePayeesRequest.md +10 -9
- data/docs/CreatePayeesRequest2.md +10 -9
- data/docs/CreatePaymentChannel.md +20 -19
- data/docs/CreatePaymentChannel2.md +20 -19
- data/docs/CreatePayorLinkRequest.md +12 -11
- data/docs/CreatePayoutRequestV3.md +24 -0
- data/docs/CreateWebhookRequest.md +26 -0
- data/docs/CurrenciesApi.md +29 -12
- data/docs/DebitEvent.md +24 -0
- data/docs/DebitEventAllOf.md +18 -0
- data/docs/DebitStatusChanged.md +26 -0
- data/docs/DebitStatusChangedAllOf.md +18 -0
- data/docs/Error.md +20 -13
- data/docs/ErrorData.md +20 -0
- data/docs/ErrorResponse.md +12 -9
- data/docs/FailedPayee.md +38 -0
- data/docs/FailedPayee2.md +38 -0
- data/docs/FailedSubmission.md +10 -9
- data/docs/FailedSubmission2.md +10 -9
- data/docs/FundingAccountResponse.md +26 -17
- data/docs/FundingAccountResponse2.md +36 -0
- data/docs/FundingAccountType.md +15 -0
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +772 -185
- data/docs/FundingManagerPrivateApi.md +101 -16
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +20 -0
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +20 -0
- data/docs/GetPayeeListResponse.md +50 -0
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +20 -0
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +18 -0
- data/docs/GetPayeeListResponseIndividual2.md +18 -0
- data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
- data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
- data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
- data/docs/GetPaymentsForPayoutResponseV4Summary.md +46 -41
- data/docs/GetPayoutStatistics.md +10 -9
- data/docs/GetPayoutsResponse.md +22 -0
- data/docs/GetPayoutsResponseV3.md +12 -11
- data/docs/GetPayoutsResponseV3Links.md +10 -9
- data/docs/GetPayoutsResponseV3Page.md +16 -15
- data/docs/Individual.md +12 -11
- data/docs/Individual2.md +12 -11
- data/docs/IndividualName.md +24 -0
- data/docs/InlineResponse400.md +12 -9
- data/docs/InlineResponse401.md +12 -9
- data/docs/InlineResponse403.md +12 -9
- data/docs/InlineResponse404.md +22 -0
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +22 -0
- data/docs/InstructPayoutRequest.md +18 -0
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +15 -0
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +28 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +22 -0
- data/docs/ListPaymentsResponseV3.md +22 -0
- data/docs/ListPaymentsResponseV3Page.md +26 -0
- data/docs/ListPaymentsResponseV4.md +12 -11
- data/docs/ListSourceAccountResponse.md +12 -11
- data/docs/ListSourceAccountResponseLinks.md +10 -9
- data/docs/ListSourceAccountResponsePage.md +16 -15
- data/docs/ListSourceAccountResponseV2.md +12 -11
- data/docs/ListSourceAccountResponseV2Links.md +20 -0
- data/docs/ListSourceAccountResponseV3.md +22 -0
- data/docs/ListSourceAccountResponseV3Links.md +20 -0
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +113 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +24 -0
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +18 -0
- data/docs/OfacStatus.md +4 -5
- data/docs/OnboardedStatus.md +4 -5
- data/docs/OnboardedStatus2.md +4 -5
- data/docs/OnboardingStatusChanged.md +26 -0
- data/docs/PageForResponse.md +16 -15
- data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
- data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
- data/docs/PagedPayeeResponse.md +14 -13
- data/docs/PagedPayeeResponse2.md +14 -13
- data/docs/PagedPayeeResponseLinks.md +10 -9
- data/docs/PagedPayeeResponsePage.md +16 -15
- data/docs/PagedPayeeResponseSummary.md +16 -15
- data/docs/PagedPaymentsResponseV3.md +22 -0
- data/docs/PagedUserResponse.md +12 -11
- data/docs/PagedUserResponseLinks.md +10 -9
- data/docs/PagedUserResponsePage.md +16 -15
- data/docs/PasswordRequest.md +8 -7
- data/docs/PayableIssue.md +20 -0
- data/docs/PayableIssue2.md +20 -0
- data/docs/PayableStatusChanged.md +26 -0
- data/docs/PayeeAddress.md +22 -21
- data/docs/PayeeAddress2.md +22 -21
- data/docs/PayeeDelta.md +20 -19
- data/docs/PayeeDelta2.md +20 -19
- data/docs/PayeeDeltaResponse.md +12 -11
- data/docs/PayeeDeltaResponse2.md +12 -11
- data/docs/PayeeDeltaResponse2Links.md +10 -9
- data/docs/PayeeDeltaResponseLinks.md +10 -9
- data/docs/PayeeDeltaResponsePage.md +16 -15
- data/docs/PayeeDetailResponse.md +74 -0
- data/docs/PayeeDetailResponse2.md +74 -0
- data/docs/PayeeDetailsChanged.md +26 -0
- data/docs/PayeeEvent.md +26 -0
- data/docs/PayeeEventAllOf.md +20 -0
- data/docs/PayeeEventAllOfReasons.md +20 -0
- data/docs/PayeeInvitationApi.md +253 -171
- data/docs/PayeeInvitationStatusResponse.md +12 -11
- data/docs/PayeeInvitationStatusResponse2.md +12 -11
- data/docs/PayeePayorRef.md +20 -11
- data/docs/PayeePayorRefV3.md +20 -15
- data/docs/PayeeType.md +4 -5
- data/docs/PayeeType2.md +15 -0
- data/docs/PayeeUserSelfUpdateRequest.md +28 -0
- data/docs/PayeesApi.md +472 -212
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +293 -438
- data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
- data/docs/PaymentChannelCountry.md +10 -9
- data/docs/PaymentChannelRule.md +20 -19
- data/docs/PaymentChannelRulesResponse.md +8 -7
- data/docs/PaymentDelta.md +22 -21
- data/docs/PaymentDeltaResponse.md +12 -11
- data/docs/PaymentDeltaResponseV1.md +22 -0
- data/docs/PaymentDeltaV1.md +32 -0
- data/docs/PaymentEvent.md +28 -0
- data/docs/PaymentEventAllOf.md +22 -0
- data/docs/PaymentEventResponse.md +40 -0
- data/docs/PaymentEventResponseV3.md +30 -29
- data/docs/PaymentInstructionV3.md +34 -0
- data/docs/PaymentRails.md +4 -5
- data/docs/PaymentRejectedOrReturned.md +34 -0
- data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
- data/docs/PaymentResponseV3.md +78 -77
- data/docs/PaymentResponseV4.md +100 -79
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +44 -0
- data/docs/PayorAddress.md +22 -21
- data/docs/PayorAddressV2.md +22 -21
- data/docs/PayorAmlTransaction.md +70 -0
- data/docs/PayorAmlTransactionV3.md +56 -61
- data/docs/PayorBrandingResponse.md +16 -15
- data/docs/PayorCreateApiKeyRequest.md +12 -11
- data/docs/PayorCreateApiKeyResponse.md +10 -9
- data/docs/PayorCreateApplicationRequest.md +10 -9
- data/docs/PayorEmailOptOutRequest.md +8 -7
- data/docs/PayorLinksResponse.md +10 -9
- data/docs/PayorLinksResponseLinks.md +14 -13
- data/docs/PayorLinksResponsePayors.md +14 -13
- data/docs/PayorLogoRequest.md +8 -7
- data/docs/PayorV1.md +50 -47
- data/docs/PayorV2.md +56 -45
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +18 -0
- data/docs/PayoutIndividualV3.md +18 -0
- data/docs/PayoutNameV3.md +20 -0
- data/docs/PayoutPayeeV3.md +22 -0
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutSchedule.md +28 -0
- data/docs/PayoutSchedule2.md +26 -0
- data/docs/PayoutServiceApi.md +659 -0
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +50 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +38 -0
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/PingResponse.md +20 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +38 -0
- data/docs/QuoteResponseV3.md +18 -0
- data/docs/RegionV2.md +20 -0
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +38 -0
- data/docs/ResendTokenRequest.md +10 -9
- data/docs/ResetPasswordRequest.md +8 -7
- data/docs/Role.md +8 -7
- data/docs/RoleUpdateRequest.md +10 -9
- data/docs/SchedulePayoutRequest.md +20 -0
- data/docs/ScheduleStatus.md +15 -0
- data/docs/ScheduleStatus2.md +15 -0
- data/docs/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -31
- data/docs/SourceAccountResponseV2.md +38 -35
- data/docs/SourceAccountResponseV3.md +52 -0
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +15 -0
- data/docs/SourceAccountV3.md +24 -0
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +18 -0
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +22 -0
- data/docs/SupportedCurrencyResponseV2.md +18 -0
- data/docs/SupportedCurrencyV2.md +20 -0
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +22 -0
- data/docs/TransmissionType.md +15 -0
- data/docs/TransmissionTypes.md +22 -0
- data/docs/TransmissionTypes2.md +22 -0
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +30 -0
- data/docs/UpdatePayeeDetailsRequest2.md +32 -0
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +24 -0
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +38 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +528 -181
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +15 -0
- data/docs/WebhookResponse.md +28 -0
- data/docs/WebhooksApi.md +365 -0
- data/docs/WebhooksResponse.md +22 -0
- data/docs/WithdrawPaymentRequest.md +18 -0
- data/lib/velopayments/api/countries_api.rb +38 -35
- data/lib/velopayments/api/currencies_api.rb +13 -12
- data/lib/velopayments/api/funding_manager_api.rb +541 -78
- data/lib/velopayments/api/funding_manager_private_api.rb +81 -14
- data/lib/velopayments/api/login_api.rb +29 -16
- data/lib/velopayments/api/payee_invitation_api.rb +116 -158
- data/lib/velopayments/api/payees_api.rb +317 -209
- data/lib/velopayments/api/payment_audit_service_api.rb +181 -461
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +64 -44
- data/lib/velopayments/api/payors_private_api.rb +10 -6
- data/lib/velopayments/api/payout_service_api.rb +659 -0
- data/lib/velopayments/api/tokens_api.rb +10 -6
- data/lib/velopayments/api/users_api.rb +188 -63
- data/lib/velopayments/api/webhooks_api.rb +356 -0
- data/lib/velopayments/api_client.rb +54 -50
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +42 -12
- data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +45 -15
- data/lib/velopayments/models/access_token_response.rb +20 -8
- data/lib/velopayments/models/access_token_validation_request.rb +20 -8
- data/lib/velopayments/models/auth_response.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config.rb +20 -8
- data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
- data/lib/velopayments/models/{language.rb → category.rb} +9 -16
- data/lib/velopayments/models/challenge.rb +20 -8
- data/lib/velopayments/models/challenge2.rb +295 -0
- data/lib/velopayments/models/company.rb +25 -13
- data/lib/velopayments/models/company2.rb +25 -13
- data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
- data/lib/velopayments/models/create_individual.rb +21 -9
- data/lib/velopayments/models/create_individual2.rb +21 -9
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +23 -11
- data/lib/velopayments/models/create_payee.rb +25 -12
- data/lib/velopayments/models/create_payee2.rb +26 -13
- data/lib/velopayments/models/create_payee_address.rb +53 -25
- data/lib/velopayments/models/create_payee_address2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_request.rb +47 -46
- data/lib/velopayments/models/create_payees_csv_request2.rb +22 -21
- data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
- data/lib/velopayments/models/create_payees_request.rb +20 -8
- data/lib/velopayments/models/create_payees_request2.rb +20 -8
- data/lib/velopayments/models/create_payment_channel.rb +20 -8
- data/lib/velopayments/models/create_payment_channel2.rb +20 -8
- data/lib/velopayments/models/create_payor_link_request.rb +20 -8
- data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
- data/lib/velopayments/models/create_webhook_request.rb +338 -0
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/debit_event_all_of.rb +224 -0
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/error.rb +54 -14
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +49 -14
- data/lib/velopayments/models/failed_payee.rb +313 -0
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +21 -9
- data/lib/velopayments/models/failed_submission2.rb +21 -9
- data/lib/velopayments/models/funding_account_response.rb +115 -12
- data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
- data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
- data/lib/velopayments/models/funding_audit.rb +33 -19
- data/lib/velopayments/models/funding_event.rb +21 -9
- data/lib/velopayments/models/funding_event_type.rb +3 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
- data/lib/velopayments/models/funding_request_v1.rb +20 -8
- data/lib/velopayments/models/funding_request_v2.rb +20 -8
- data/lib/velopayments/models/funding_request_v3.rb +267 -0
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
- data/lib/velopayments/models/fx_summary_v3.rb +21 -9
- data/lib/velopayments/models/get_fundings_response.rb +23 -18
- data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
- data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +97 -116
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +98 -117
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
- data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
- data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
- data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +53 -57
- data/lib/velopayments/models/get_payout_statistics.rb +20 -8
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
- data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
- data/lib/velopayments/models/individual.rb +21 -9
- data/lib/velopayments/models/individual2.rb +21 -9
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +23 -11
- data/lib/velopayments/models/inline_response400.rb +51 -14
- data/lib/velopayments/models/inline_response401.rb +51 -14
- data/lib/velopayments/models/inline_response403.rb +51 -14
- data/lib/velopayments/models/inline_response404.rb +258 -0
- data/lib/velopayments/models/inline_response409.rb +51 -14
- data/lib/velopayments/models/inline_response412.rb +258 -0
- data/lib/velopayments/models/instruct_payout_request.rb +219 -0
- data/lib/velopayments/models/invitation_status.rb +3 -2
- data/lib/velopayments/models/invitation_status2.rb +38 -0
- data/lib/velopayments/models/invite_payee_request.rb +20 -8
- data/lib/velopayments/models/invite_payee_request2.rb +20 -8
- data/lib/velopayments/models/invite_user_request.rb +54 -20
- data/lib/velopayments/models/kyc_state.rb +3 -2
- data/lib/velopayments/models/link_for_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
- data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
- data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
- data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +23 -11
- data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
- data/lib/velopayments/models/list_source_account_response.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
- data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +227 -0
- data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +20 -8
- data/lib/velopayments/models/mfa_type.rb +3 -2
- data/lib/velopayments/models/name.rb +341 -0
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +78 -58
- data/lib/velopayments/models/notifications.rb +20 -8
- data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
- data/lib/velopayments/models/ofac_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status.rb +3 -2
- data/lib/velopayments/models/onboarded_status2.rb +3 -2
- data/lib/velopayments/models/{inline_response409_errors.rb → onboarding_status_changed.rb} +92 -39
- data/lib/velopayments/models/page_for_response.rb +20 -8
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response.rb +21 -9
- data/lib/velopayments/models/paged_payee_response2.rb +22 -10
- data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
- data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
- data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
- data/lib/velopayments/models/paged_user_response.rb +20 -8
- data/lib/velopayments/models/paged_user_response_links.rb +20 -8
- data/lib/velopayments/models/paged_user_response_page.rb +20 -8
- data/lib/velopayments/models/password_request.rb +20 -8
- data/lib/velopayments/models/payable_issue.rb +238 -0
- data/lib/velopayments/models/payable_issue2.rb +238 -0
- data/lib/velopayments/models/payable_status_changed.rb +289 -0
- data/lib/velopayments/models/payee_address.rb +20 -8
- data/lib/velopayments/models/payee_address2.rb +20 -8
- data/lib/velopayments/models/payee_delta.rb +21 -9
- data/lib/velopayments/models/payee_delta2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2.rb +20 -8
- data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
- data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
- data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +46 -24
- data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +78 -65
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
- data/lib/velopayments/models/payee_event_all_of.rb +236 -0
- data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
- data/lib/velopayments/models/payee_invitation_status_response.rb +20 -8
- data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
- data/lib/velopayments/models/payee_payor_ref.rb +66 -12
- data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
- data/lib/velopayments/models/payee_type.rb +5 -4
- data/lib/velopayments/models/payee_type2.rb +37 -0
- data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
- data/lib/velopayments/models/payment_channel_country.rb +20 -8
- data/lib/velopayments/models/payment_channel_rule.rb +20 -8
- data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
- data/lib/velopayments/models/payment_delta.rb +20 -8
- data/lib/velopayments/models/payment_delta_response.rb +20 -8
- data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
- data/lib/velopayments/models/payment_delta_v1.rb +297 -0
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/{list_payments_response_page.rb → payment_event_all_of.rb} +49 -48
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
- data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
- data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +108 -15
- data/lib/velopayments/models/payment_rails.rb +3 -2
- data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
- data/lib/velopayments/models/payment_response_v3.rb +21 -9
- data/lib/velopayments/models/payment_response_v4.rb +120 -13
- data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
- data/lib/velopayments/models/payment_v3.rb +399 -0
- data/lib/velopayments/models/payor_address.rb +20 -8
- data/lib/velopayments/models/payor_address_v2.rb +20 -8
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
- data/lib/velopayments/models/payor_branding_response.rb +20 -8
- data/lib/velopayments/models/payor_create_api_key_request.rb +31 -9
- data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
- data/lib/velopayments/models/payor_create_application_request.rb +20 -8
- data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
- data/lib/velopayments/models/payor_links_response.rb +20 -8
- data/lib/velopayments/models/payor_links_response_links.rb +20 -8
- data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
- data/lib/velopayments/models/payor_logo_request.rb +20 -8
- data/lib/velopayments/models/payor_v1.rb +33 -12
- data/lib/velopayments/models/payor_v2.rb +75 -12
- data/lib/velopayments/models/payout_company_v3.rb +223 -0
- data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
- data/lib/velopayments/models/payout_name_v3.rb +237 -0
- data/lib/velopayments/models/payout_payee_v3.rb +242 -0
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
- data/lib/velopayments/models/payout_schedule.rb +291 -0
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → payout_schedule2.rb} +81 -78
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
- data/lib/velopayments/models/payout_status_v3.rb +3 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +51 -21
- data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
- data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +53 -18
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +68 -48
- data/lib/velopayments/models/{invitation_status_response.rb → ping_response.rb} +39 -25
- data/lib/velopayments/models/query_batch_response.rb +20 -8
- data/lib/velopayments/models/query_batch_response2.rb +20 -8
- data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +25 -13
- data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
- data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
- data/lib/velopayments/models/register_sms_request.rb +23 -11
- data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +42 -12
- data/lib/velopayments/models/resend_token_request.rb +20 -8
- data/lib/velopayments/models/reset_password_request.rb +20 -8
- data/lib/velopayments/models/role.rb +20 -8
- data/lib/velopayments/models/role_update_request.rb +20 -8
- data/lib/velopayments/models/{inline_response401_errors.rb → schedule_payout_request.rb} +48 -45
- data/lib/velopayments/models/schedule_status.rb +38 -0
- data/lib/velopayments/models/schedule_status2.rb +38 -0
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
- data/lib/velopayments/models/self_update_password_request.rb +20 -8
- data/lib/velopayments/models/set_notifications_request.rb +20 -8
- data/lib/velopayments/models/source_account_response.rb +34 -13
- data/lib/velopayments/models/source_account_response_v2.rb +36 -15
- data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
- data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
- data/lib/velopayments/models/source_account_type.rb +37 -0
- data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +23 -11
- data/lib/velopayments/models/source_event.rb +255 -0
- data/lib/velopayments/models/supported_countries_response.rb +20 -8
- data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
- data/lib/velopayments/models/supported_country.rb +20 -8
- data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
- data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +23 -11
- data/lib/velopayments/models/transfer_request.rb +20 -8
- data/lib/velopayments/models/transfer_request2.rb +309 -0
- data/lib/velopayments/models/transmission_type.rb +38 -0
- data/lib/velopayments/models/{currency_type.rb → transmission_types.rb} +60 -45
- data/lib/velopayments/models/transmission_types2.rb +254 -0
- data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
- data/lib/velopayments/models/update_payee_details_request.rb +275 -0
- data/lib/velopayments/models/update_payee_details_request2.rb +302 -0
- data/lib/velopayments/models/update_remote_id_request.rb +20 -8
- data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
- data/lib/velopayments/models/update_webhook_request.rb +312 -0
- data/lib/velopayments/models/user_details_update_request.rb +29 -17
- data/lib/velopayments/models/user_info.rb +20 -8
- data/lib/velopayments/models/user_response.rb +102 -19
- data/lib/velopayments/models/user_status.rb +3 -2
- data/lib/velopayments/models/user_type.rb +3 -2
- data/lib/velopayments/models/user_type2.rb +3 -2
- data/lib/velopayments/models/validate_password_response.rb +20 -8
- data/lib/velopayments/models/watchlist_status.rb +3 -2
- data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
- data/lib/velopayments/models/webhook_response.rb +265 -0
- data/lib/velopayments/models/webhooks_response.rb +241 -0
- data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
- data/lib/velopayments/version.rb +3 -3
- data/lib/velopayments.rb +117 -68
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +12 -12
- data/spec/api/currencies_api_spec.rb +5 -5
- data/spec/api/funding_manager_api_spec.rb +94 -18
- data/spec/api/funding_manager_private_api_spec.rb +17 -5
- data/spec/api/login_api_spec.rb +3 -2
- data/spec/api/payee_invitation_api_spec.rb +23 -35
- data/spec/api/payees_api_spec.rb +65 -49
- data/spec/api/payment_audit_service_api_spec.rb +35 -113
- data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/spec/api/payors_api_spec.rb +9 -9
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +154 -0
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +18 -4
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +76 -0
- data/spec/models/access_token_response_spec.rb +5 -12
- data/spec/models/access_token_validation_request_spec.rb +5 -12
- data/spec/models/auth_response_spec.rb +5 -12
- data/spec/models/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
- data/spec/models/auto_top_up_config_spec.rb +5 -12
- data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
- data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
- data/spec/models/challenge_spec.rb +5 -12
- data/spec/models/company2_spec.rb +5 -12
- data/spec/models/company_spec.rb +5 -12
- data/spec/models/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
- data/spec/models/create_individual2_spec.rb +5 -12
- data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
- data/spec/models/create_individual_spec.rb +5 -12
- data/spec/models/create_payee2_spec.rb +5 -12
- data/spec/models/create_payee_address2_spec.rb +6 -13
- data/spec/models/create_payee_address_spec.rb +9 -12
- data/spec/models/create_payee_spec.rb +5 -12
- data/spec/models/create_payees_csv_request2_spec.rb +8 -19
- data/spec/models/create_payees_csv_request_spec.rb +11 -18
- data/spec/models/create_payees_csv_response2_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
- data/spec/models/create_payees_csv_response_spec.rb +5 -12
- data/spec/models/create_payees_request2_spec.rb +5 -12
- data/spec/models/create_payees_request_spec.rb +5 -12
- data/spec/models/create_payment_channel2_spec.rb +7 -14
- data/spec/models/create_payment_channel_spec.rb +7 -14
- data/spec/models/create_payor_link_request_spec.rb +6 -13
- data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -21
- data/spec/models/create_webhook_request_spec.rb +58 -0
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/debit_event_spec.rb +52 -0
- data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{marketing_opt_in_spec.rb → error_data_spec.rb} +10 -17
- data/spec/models/error_response_spec.rb +11 -12
- data/spec/models/error_spec.rb +24 -13
- data/spec/models/failed_payee2_spec.rb +94 -0
- data/spec/models/failed_payee_spec.rb +94 -0
- data/spec/models/failed_submission2_spec.rb +5 -12
- data/spec/models/failed_submission_spec.rb +5 -12
- data/spec/models/funding_account_response2_spec.rb +88 -0
- data/spec/models/funding_account_response_spec.rb +29 -12
- data/spec/models/{ofac_status2_spec.rb → funding_account_type_spec.rb} +8 -15
- data/spec/models/funding_audit_spec.rb +14 -21
- data/spec/models/funding_event_spec.rb +5 -12
- data/spec/models/funding_event_type_spec.rb +5 -12
- data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/funding_request_v1_spec.rb +5 -12
- data/spec/models/funding_request_v2_spec.rb +5 -12
- data/spec/models/funding_request_v3_spec.rb +40 -0
- data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
- data/spec/models/fx_summary_v3_spec.rb +7 -14
- data/spec/models/get_fundings_response_links_spec.rb +40 -0
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
- data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
- data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
- data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
- data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +17 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
- data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
- data/spec/models/get_payouts_response_v3_spec.rb +5 -12
- data/spec/models/individual2_spec.rb +5 -12
- data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
- data/spec/models/individual_spec.rb +5 -12
- data/spec/models/inline_response400_spec.rb +11 -12
- data/spec/models/inline_response401_spec.rb +11 -12
- data/spec/models/inline_response403_spec.rb +11 -12
- data/spec/models/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +46 -0
- data/spec/models/instruct_payout_request_spec.rb +34 -0
- data/spec/models/{location_type_spec.rb → invitation_status2_spec.rb} +8 -15
- data/spec/models/invitation_status_spec.rb +5 -12
- data/spec/models/invite_payee_request2_spec.rb +5 -12
- data/spec/models/invite_payee_request_spec.rb +5 -12
- data/spec/models/invite_user_request_spec.rb +16 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/{list_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
- data/spec/models/list_payments_response_v3_spec.rb +46 -0
- data/spec/models/list_payments_response_v4_spec.rb +5 -12
- data/spec/models/list_source_account_response_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_page_spec.rb +5 -12
- data/spec/models/list_source_account_response_spec.rb +5 -12
- data/spec/models/list_source_account_response_v2_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
- data/spec/models/list_source_account_response_v3_spec.rb +46 -0
- data/spec/models/localisation_details_spec.rb +40 -0
- data/spec/models/mfa_details_spec.rb +5 -12
- data/spec/models/mfa_type_spec.rb +5 -12
- data/spec/models/name2_spec.rb +52 -0
- data/spec/models/name_spec.rb +52 -0
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +34 -0
- data/spec/models/notifications_spec.rb +5 -12
- data/spec/models/ofac_status_spec.rb +5 -12
- data/spec/models/onboarded_status2_spec.rb +5 -12
- data/spec/models/onboarded_status_spec.rb +5 -12
- data/spec/models/{list_payments_response_page_spec.rb → onboarding_status_changed_spec.rb} +13 -20
- data/spec/models/page_for_response_spec.rb +5 -12
- data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
- data/spec/models/paged_payee_response2_spec.rb +5 -12
- data/spec/models/paged_payee_response_links_spec.rb +5 -12
- data/spec/models/paged_payee_response_page_spec.rb +5 -12
- data/spec/models/paged_payee_response_spec.rb +5 -12
- data/spec/models/paged_payee_response_summary_spec.rb +6 -13
- data/spec/models/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
- data/spec/models/paged_user_response_links_spec.rb +5 -12
- data/spec/models/paged_user_response_page_spec.rb +5 -12
- data/spec/models/paged_user_response_spec.rb +5 -12
- data/spec/models/password_request_spec.rb +5 -12
- data/spec/models/payable_issue2_spec.rb +40 -0
- data/spec/models/payable_issue_spec.rb +40 -0
- data/spec/models/payable_status_changed_spec.rb +58 -0
- data/spec/models/payee_address2_spec.rb +5 -12
- data/spec/models/payee_address_spec.rb +5 -12
- data/spec/models/payee_delta2_spec.rb +5 -12
- data/spec/models/payee_delta_response2_links_spec.rb +5 -12
- data/spec/models/payee_delta_response2_spec.rb +5 -12
- data/spec/models/payee_delta_response_links_spec.rb +5 -12
- data/spec/models/payee_delta_response_page_spec.rb +5 -12
- data/spec/models/payee_delta_response_spec.rb +5 -12
- data/spec/models/payee_delta_spec.rb +5 -12
- data/spec/models/{payee_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
- data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
- data/spec/models/payee_details_changed_spec.rb +58 -0
- data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
- data/spec/models/payee_event_all_of_spec.rb +40 -0
- data/spec/models/{inline_response400_errors_spec.rb → payee_event_spec.rb} +17 -18
- data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
- data/spec/models/payee_invitation_status_response_spec.rb +6 -13
- data/spec/models/payee_payor_ref_spec.rb +29 -12
- data/spec/models/payee_payor_ref_v3_spec.rb +17 -16
- data/spec/models/{language2_spec.rb → payee_type2_spec.rb} +8 -15
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
- data/spec/models/payment_audit_currency_spec.rb +28 -0
- data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
- data/spec/models/payment_channel_country_spec.rb +5 -12
- data/spec/models/payment_channel_rule_spec.rb +5 -12
- data/spec/models/payment_channel_rules_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_spec.rb +5 -12
- data/spec/models/payment_delta_response_v1_spec.rb +46 -0
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/payment_delta_v1_spec.rb +76 -0
- data/spec/models/payment_event_all_of_spec.rb +46 -0
- data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
- data/spec/models/payment_event_response_v3_spec.rb +6 -13
- data/spec/models/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
- data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
- data/spec/models/payment_rails_spec.rb +5 -12
- data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
- data/spec/models/payment_rejected_or_returned_spec.rb +82 -0
- data/spec/models/payment_response_v3_spec.rb +7 -14
- data/spec/models/payment_response_v4_payout_spec.rb +5 -12
- data/spec/models/payment_response_v4_spec.rb +67 -14
- data/spec/models/payment_status_changed_all_of_spec.rb +34 -0
- data/spec/models/payment_status_changed_spec.rb +70 -0
- data/spec/models/{user_response2_spec.rb → payment_v3_spec.rb} +24 -45
- data/spec/models/payor_address_spec.rb +5 -12
- data/spec/models/payor_address_v2_spec.rb +5 -12
- data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
- data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
- data/spec/models/payor_branding_response_spec.rb +5 -12
- data/spec/models/payor_create_api_key_request_spec.rb +6 -13
- data/spec/models/payor_create_api_key_response_spec.rb +5 -12
- data/spec/models/payor_create_application_request_spec.rb +5 -12
- data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
- data/spec/models/payor_links_response_links_spec.rb +6 -13
- data/spec/models/payor_links_response_payors_spec.rb +6 -13
- data/spec/models/payor_links_response_spec.rb +5 -12
- data/spec/models/payor_logo_request_spec.rb +5 -12
- data/spec/models/payor_v1_spec.rb +12 -13
- data/spec/models/payor_v2_spec.rb +36 -13
- data/spec/models/payout_company_v3_spec.rb +34 -0
- data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -15
- data/spec/models/payout_name_v3_spec.rb +40 -0
- data/spec/models/payout_payee_v3_spec.rb +46 -0
- data/spec/models/payout_payor_ids_spec.rb +46 -0
- data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
- data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
- data/spec/models/payout_schedule2_spec.rb +58 -0
- data/spec/models/{paged_payee_response2_summary_spec.rb → payout_schedule_spec.rb} +18 -19
- data/spec/models/payout_status_spec.rb +28 -0
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +20 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +20 -15
- data/spec/models/payout_type_spec.rb +28 -0
- data/spec/models/ping_response_spec.rb +40 -0
- data/spec/models/ping_spec.rb +46 -0
- data/spec/models/query_batch_response2_spec.rb +6 -13
- data/spec/models/query_batch_response_spec.rb +6 -13
- data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
- data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
- data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +94 -0
- data/spec/models/resend_token_request_spec.rb +6 -13
- data/spec/models/reset_password_request_spec.rb +5 -12
- data/spec/models/role_spec.rb +5 -12
- data/spec/models/role_update_request_spec.rb +5 -12
- data/spec/models/schedule_payout_request_spec.rb +40 -0
- data/spec/models/schedule_status2_spec.rb +28 -0
- data/spec/models/schedule_status_spec.rb +28 -0
- data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
- data/spec/models/self_update_password_request_spec.rb +5 -12
- data/spec/models/set_notifications_request_spec.rb +5 -12
- data/spec/models/source_account_response_spec.rb +12 -13
- data/spec/models/source_account_response_v2_spec.rb +12 -13
- data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
- data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
- data/spec/models/source_account_summary_v3_spec.rb +5 -12
- data/spec/models/source_account_type_spec.rb +28 -0
- data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
- data/spec/models/source_event_spec.rb +46 -0
- data/spec/models/supported_countries_response_spec.rb +5 -12
- data/spec/models/supported_countries_response_v2_spec.rb +34 -0
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
- data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
- data/spec/models/transfer_request2_spec.rb +46 -0
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +28 -0
- data/spec/models/transmission_types2_spec.rb +46 -0
- data/spec/models/transmission_types_spec.rb +46 -0
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request2_spec.rb} +20 -25
- data/spec/models/update_payee_details_request_spec.rb +70 -0
- data/spec/models/update_remote_id_request2_spec.rb +40 -0
- data/spec/models/update_remote_id_request_spec.rb +5 -12
- data/spec/models/update_webhook_request_spec.rb +52 -0
- data/spec/models/user_details_update_request_spec.rb +5 -12
- data/spec/models/user_info_spec.rb +5 -12
- data/spec/models/user_response_spec.rb +24 -15
- data/spec/models/user_status_spec.rb +5 -12
- data/spec/models/user_type2_spec.rb +5 -12
- data/spec/models/user_type_spec.rb +5 -12
- data/spec/models/validate_password_response_spec.rb +5 -12
- data/spec/models/watchlist_status2_spec.rb +28 -0
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +64 -0
- data/spec/models/webhooks_response_spec.rb +46 -0
- data/spec/models/withdraw_payment_request_spec.rb +34 -0
- data/spec/spec_helper.rb +2 -2
- data/specs/api/countries_api_spec.rb +48 -13
- data/specs/api/currencies_api_spec.rb +8 -6
- data/specs/api/funding_manager_api_spec.rb +197 -30
- data/specs/api/funding_manager_private_api_spec.rb +6 -6
- data/specs/api/login_api_spec.rb +6 -6
- data/specs/api/payee_invitation_api_spec.rb +45 -37
- data/specs/api/payees_api_spec.rb +53 -65
- data/specs/api/payment_audit_service_api_spec.rb +125 -74
- data/specs/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
- data/specs/api/payors_api_spec.rb +50 -17
- data/specs/api/payors_private_api_spec.rb +3 -3
- data/{spec/models/payee2_spec.rb → specs/api/payout_service_api_spec.rb} +72 -110
- data/specs/api/tokens_api_spec.rb +3 -3
- data/specs/api/users_api_spec.rb +70 -21
- data/specs/api/webhooks_api_spec.rb +96 -0
- data/velopayments.gemspec +3 -4
- metadata +466 -293
- data/docs/AcceptedPayment.md +0 -27
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateFundingAccountRequest.md +0 -23
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayoutRequest.md +0 -25
- data/docs/CurrencyType.md +0 -17
- data/docs/FxSummaryV4.md +0 -35
- data/docs/GetFundingsResponseAllOf.md +0 -17
- data/docs/GetPayoutApi.md +0 -61
- data/docs/GetPayoutsResponseV4.md +0 -21
- data/docs/IndividualResponse.md +0 -17
- data/docs/IndividualV1.md +0 -21
- data/docs/IndividualV1Name.md +0 -23
- data/docs/InlineResponse400Errors.md +0 -23
- data/docs/InlineResponse401Errors.md +0 -23
- data/docs/InlineResponse403Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InstructPayoutApi.md +0 -60
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- data/docs/ListPaymentsResponse.md +0 -21
- data/docs/ListPaymentsResponsePage.md +0 -25
- data/docs/LocationType.md +0 -16
- data/docs/MarketingOptIn.md +0 -19
- data/docs/OfacStatus2.md +0 -16
- data/docs/PagedPayeeResponse2Summary.md +0 -25
- data/docs/PagedResponse.md +0 -19
- data/docs/PagedResponsePage.md +0 -25
- data/docs/Payee.md +0 -55
- data/docs/Payee2.md +0 -57
- data/docs/PayeeInvitationStatus.md +0 -21
- data/docs/PayeePaymentChannel.md +0 -29
- data/docs/PayeePaymentChannel2.md +0 -29
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponse2.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeResponseV3.md +0 -71
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PaymentInstruction.md +0 -27
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayoutHistoryApi.md +0 -221
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -45
- data/docs/PayoutSummaryResponse.md +0 -33
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/QuoteFxSummary.md +0 -37
- data/docs/QuotePayoutApi.md +0 -61
- data/docs/QuoteResponse.md +0 -17
- data/docs/Region.md +0 -19
- data/docs/RejectedPayment.md +0 -33
- data/docs/SourceAccount.md +0 -23
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/docs/SubmitPayoutApi.md +0 -60
- data/docs/SupportedCountriesResponse2.md +0 -17
- data/docs/SupportedCountry2.md +0 -21
- data/docs/SupportedCurrency.md +0 -19
- data/docs/SupportedCurrencyResponse.md +0 -17
- data/docs/UserResponse2.md +0 -45
- data/docs/UserResponse2Roles.md +0 -17
- data/docs/WithdrawPayoutApi.md +0 -60
- data/lib/velopayments/api/get_payout_api.rb +0 -84
- data/lib/velopayments/api/instruct_payout_api.rb +0 -84
- data/lib/velopayments/api/payout_history_api.rb +0 -285
- data/lib/velopayments/api/quote_payout_api.rb +0 -84
- data/lib/velopayments/api/submit_payout_api.rb +0 -86
- data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
- data/lib/velopayments/models/inline_response403_errors.rb +0 -236
- data/lib/velopayments/models/language2.rb +0 -45
- data/lib/velopayments/models/payee2.rb +0 -456
- data/lib/velopayments/models/payee_response.rb +0 -388
- data/spec/api/get_payout_api_spec.rb +0 -47
- data/spec/api/instruct_payout_api_spec.rb +0 -47
- data/spec/api/quote_payout_api_spec.rb +0 -47
- data/spec/api/submit_payout_api_spec.rb +0 -47
- data/spec/api/withdraw_payout_api_spec.rb +0 -47
- data/spec/models/create_funding_account_request_spec.rb +0 -59
- data/spec/models/get_fundings_response_all_of_spec.rb +0 -41
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/invitation_status_response_spec.rb +0 -41
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
- data/spec/models/payout_status_v4_spec.rb +0 -35
- data/spec/models/payout_type_v4_spec.rb +0 -35
- data/spec/models/supported_countries_response2_spec.rb +0 -41
- data/specs/api/get_payout_api_spec.rb +0 -47
- data/specs/api/instruct_payout_api_spec.rb +0 -47
- data/specs/api/quote_payout_api_spec.rb +0 -47
- data/specs/api/submit_payout_api_spec.rb +0 -47
- data/specs/api/withdraw_payout_api_spec.rb +0 -47
|
@@ -3,14 +3,15 @@
|
|
|
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.29.128
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module VeloPayments
|
|
16
17
|
class CreatePayeeAddress2
|
|
@@ -67,6 +68,11 @@ module VeloPayments
|
|
|
67
68
|
}
|
|
68
69
|
end
|
|
69
70
|
|
|
71
|
+
# Returns all the JSON keys this model knows about
|
|
72
|
+
def self.acceptable_attributes
|
|
73
|
+
attribute_map.values
|
|
74
|
+
end
|
|
75
|
+
|
|
70
76
|
# Attribute type mapping.
|
|
71
77
|
def self.openapi_types
|
|
72
78
|
{
|
|
@@ -406,7 +412,9 @@ module VeloPayments
|
|
|
406
412
|
def build_from_hash(attributes)
|
|
407
413
|
return nil unless attributes.is_a?(Hash)
|
|
408
414
|
self.class.openapi_types.each_pair do |key, type|
|
|
409
|
-
if
|
|
415
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
416
|
+
self.send("#{key}=", nil)
|
|
417
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
410
418
|
# check to ensure the input is an array given that the attribute
|
|
411
419
|
# is documented as an array but the input is not
|
|
412
420
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
@@ -414,7 +422,7 @@ module VeloPayments
|
|
|
414
422
|
end
|
|
415
423
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
416
424
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
417
|
-
end
|
|
425
|
+
end
|
|
418
426
|
end
|
|
419
427
|
|
|
420
428
|
self
|
|
@@ -426,8 +434,8 @@ module VeloPayments
|
|
|
426
434
|
# @return [Object] Deserialized data
|
|
427
435
|
def _deserialize(type, value)
|
|
428
436
|
case type.to_sym
|
|
429
|
-
when :
|
|
430
|
-
|
|
437
|
+
when :Time
|
|
438
|
+
Time.parse(value)
|
|
431
439
|
when :Date
|
|
432
440
|
Date.parse(value)
|
|
433
441
|
when :String
|
|
@@ -457,7 +465,9 @@ module VeloPayments
|
|
|
457
465
|
end
|
|
458
466
|
end
|
|
459
467
|
else # model
|
|
460
|
-
|
|
468
|
+
# models (e.g. Pet) or oneOf
|
|
469
|
+
klass = VeloPayments.const_get(type)
|
|
470
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
461
471
|
end
|
|
462
472
|
end
|
|
463
473
|
|
|
@@ -483,7 +493,7 @@ module VeloPayments
|
|
|
483
493
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
484
494
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
485
495
|
end
|
|
486
|
-
|
|
496
|
+
|
|
487
497
|
hash[param] = _to_hash(value)
|
|
488
498
|
end
|
|
489
499
|
hash
|
|
@@ -506,5 +516,7 @@ module VeloPayments
|
|
|
506
516
|
value
|
|
507
517
|
end
|
|
508
518
|
end
|
|
519
|
+
|
|
509
520
|
end
|
|
521
|
+
|
|
510
522
|
end
|
|
@@ -3,14 +3,15 @@
|
|
|
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.29.128
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module VeloPayments
|
|
16
17
|
class CreatePayeesCSVRequest
|
|
@@ -34,7 +35,7 @@ module VeloPayments
|
|
|
34
35
|
|
|
35
36
|
attr_accessor :address_zip_or_postcode
|
|
36
37
|
|
|
37
|
-
#
|
|
38
|
+
# Must be a 2 character country code - per ISO 3166-1
|
|
38
39
|
attr_accessor :address_country
|
|
39
40
|
|
|
40
41
|
attr_accessor :individual_national_identification
|
|
@@ -52,7 +53,6 @@ module VeloPayments
|
|
|
52
53
|
|
|
53
54
|
attr_accessor :company_name
|
|
54
55
|
|
|
55
|
-
# Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```.
|
|
56
56
|
attr_accessor :company_ein
|
|
57
57
|
|
|
58
58
|
attr_accessor :company_operating_name
|
|
@@ -77,6 +77,7 @@ module VeloPayments
|
|
|
77
77
|
|
|
78
78
|
attr_accessor :challenge_value
|
|
79
79
|
|
|
80
|
+
# An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
|
|
80
81
|
attr_accessor :payee_language
|
|
81
82
|
|
|
82
83
|
class EnumAttributeValidator
|
|
@@ -136,10 +137,15 @@ module VeloPayments
|
|
|
136
137
|
}
|
|
137
138
|
end
|
|
138
139
|
|
|
140
|
+
# Returns all the JSON keys this model knows about
|
|
141
|
+
def self.acceptable_attributes
|
|
142
|
+
attribute_map.values
|
|
143
|
+
end
|
|
144
|
+
|
|
139
145
|
# Attribute type mapping.
|
|
140
146
|
def self.openapi_types
|
|
141
147
|
{
|
|
142
|
-
:'type' => :'
|
|
148
|
+
:'type' => :'PayeeType2',
|
|
143
149
|
:'remote_id' => :'String',
|
|
144
150
|
:'email' => :'String',
|
|
145
151
|
:'address_line1' => :'String',
|
|
@@ -413,8 +419,8 @@ module VeloPayments
|
|
|
413
419
|
invalid_properties.push('invalid value for "address_country", address_country cannot be nil.')
|
|
414
420
|
end
|
|
415
421
|
|
|
416
|
-
if @address_country.to_s.length >
|
|
417
|
-
invalid_properties.push('invalid value for "address_country", the character length must be smaller than or equal to
|
|
422
|
+
if @address_country.to_s.length > 2
|
|
423
|
+
invalid_properties.push('invalid value for "address_country", the character length must be smaller than or equal to 2.')
|
|
418
424
|
end
|
|
419
425
|
|
|
420
426
|
if @address_country.to_s.length < 2
|
|
@@ -469,9 +475,12 @@ module VeloPayments
|
|
|
469
475
|
invalid_properties.push('invalid value for "company_name", the character length must be great than or equal to 1.')
|
|
470
476
|
end
|
|
471
477
|
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
478
|
+
if !@company_ein.nil? && @company_ein.to_s.length > 30
|
|
479
|
+
invalid_properties.push('invalid value for "company_ein", the character length must be smaller than or equal to 30.')
|
|
480
|
+
end
|
|
481
|
+
|
|
482
|
+
if !@company_ein.nil? && @company_ein.to_s.length < 6
|
|
483
|
+
invalid_properties.push('invalid value for "company_ein", the character length must be great than or equal to 6.')
|
|
475
484
|
end
|
|
476
485
|
|
|
477
486
|
if !@company_operating_name.nil? && @company_operating_name.to_s.length > 100
|
|
@@ -566,7 +575,9 @@ module VeloPayments
|
|
|
566
575
|
return false if @address_zip_or_postcode.to_s.length > 60
|
|
567
576
|
return false if @address_zip_or_postcode.to_s.length < 1
|
|
568
577
|
return false if @address_country.nil?
|
|
569
|
-
|
|
578
|
+
address_country_validator = EnumAttributeValidator.new('String', ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "false", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"])
|
|
579
|
+
return false unless address_country_validator.valid?(@address_country)
|
|
580
|
+
return false if @address_country.to_s.length > 2
|
|
570
581
|
return false if @address_country.to_s.length < 2
|
|
571
582
|
return false if !@individual_national_identification.nil? && @individual_national_identification.to_s.length > 30
|
|
572
583
|
return false if !@individual_national_identification.nil? && @individual_national_identification.to_s.length < 6
|
|
@@ -580,7 +591,8 @@ module VeloPayments
|
|
|
580
591
|
return false if !@individual_last_name.nil? && @individual_last_name.to_s.length < 1
|
|
581
592
|
return false if !@company_name.nil? && @company_name.to_s.length > 40
|
|
582
593
|
return false if !@company_name.nil? && @company_name.to_s.length < 1
|
|
583
|
-
return false if !@company_ein.nil? && @company_ein
|
|
594
|
+
return false if !@company_ein.nil? && @company_ein.to_s.length > 30
|
|
595
|
+
return false if !@company_ein.nil? && @company_ein.to_s.length < 6
|
|
584
596
|
return false if !@company_operating_name.nil? && @company_operating_name.to_s.length > 100
|
|
585
597
|
return false if !@company_operating_name.nil? && @company_operating_name.to_s.length < 1
|
|
586
598
|
return false if !@payment_channel_account_number.nil? && @payment_channel_account_number.to_s.length > 17
|
|
@@ -600,8 +612,6 @@ module VeloPayments
|
|
|
600
612
|
return false if !@challenge_description.nil? && @challenge_description.to_s.length < 1
|
|
601
613
|
return false if !@challenge_value.nil? && @challenge_value.to_s.length > 20
|
|
602
614
|
return false if !@challenge_value.nil? && @challenge_value.to_s.length < 3
|
|
603
|
-
payee_language_validator = EnumAttributeValidator.new('String', ["AR", "EN", "ES", "FR", "HE", "HI", "JA", "PT", "RU", "UR", "ZH"])
|
|
604
|
-
return false unless payee_language_validator.valid?(@payee_language)
|
|
605
615
|
true
|
|
606
616
|
end
|
|
607
617
|
|
|
@@ -751,21 +761,13 @@ module VeloPayments
|
|
|
751
761
|
@address_zip_or_postcode = address_zip_or_postcode
|
|
752
762
|
end
|
|
753
763
|
|
|
754
|
-
# Custom attribute writer method
|
|
755
|
-
# @param [Object] address_country
|
|
764
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
765
|
+
# @param [Object] address_country Object to be assigned
|
|
756
766
|
def address_country=(address_country)
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
if address_country.to_s.length > 50
|
|
762
|
-
fail ArgumentError, 'invalid value for "address_country", the character length must be smaller than or equal to 50.'
|
|
763
|
-
end
|
|
764
|
-
|
|
765
|
-
if address_country.to_s.length < 2
|
|
766
|
-
fail ArgumentError, 'invalid value for "address_country", the character length must be great than or equal to 2.'
|
|
767
|
+
validator = EnumAttributeValidator.new('String', ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "false", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"])
|
|
768
|
+
unless validator.valid?(address_country)
|
|
769
|
+
fail ArgumentError, "invalid value for \"address_country\", must be one of #{validator.allowable_values}."
|
|
767
770
|
end
|
|
768
|
-
|
|
769
771
|
@address_country = address_country
|
|
770
772
|
end
|
|
771
773
|
|
|
@@ -856,9 +858,12 @@ module VeloPayments
|
|
|
856
858
|
# Custom attribute writer method with validation
|
|
857
859
|
# @param [Object] company_ein Value to be assigned
|
|
858
860
|
def company_ein=(company_ein)
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
861
|
+
if !company_ein.nil? && company_ein.to_s.length > 30
|
|
862
|
+
fail ArgumentError, 'invalid value for "company_ein", the character length must be smaller than or equal to 30.'
|
|
863
|
+
end
|
|
864
|
+
|
|
865
|
+
if !company_ein.nil? && company_ein.to_s.length < 6
|
|
866
|
+
fail ArgumentError, 'invalid value for "company_ein", the character length must be great than or equal to 6.'
|
|
862
867
|
end
|
|
863
868
|
|
|
864
869
|
@company_ein = company_ein
|
|
@@ -973,16 +978,6 @@ module VeloPayments
|
|
|
973
978
|
@challenge_value = challenge_value
|
|
974
979
|
end
|
|
975
980
|
|
|
976
|
-
# Custom attribute writer method checking allowed values (enum).
|
|
977
|
-
# @param [Object] payee_language Object to be assigned
|
|
978
|
-
def payee_language=(payee_language)
|
|
979
|
-
validator = EnumAttributeValidator.new('String', ["AR", "EN", "ES", "FR", "HE", "HI", "JA", "PT", "RU", "UR", "ZH"])
|
|
980
|
-
unless validator.valid?(payee_language)
|
|
981
|
-
fail ArgumentError, "invalid value for \"payee_language\", must be one of #{validator.allowable_values}."
|
|
982
|
-
end
|
|
983
|
-
@payee_language = payee_language
|
|
984
|
-
end
|
|
985
|
-
|
|
986
981
|
# Checks equality by comparing each attribute.
|
|
987
982
|
# @param [Object] Object to be compared
|
|
988
983
|
def ==(o)
|
|
@@ -1044,7 +1039,9 @@ module VeloPayments
|
|
|
1044
1039
|
def build_from_hash(attributes)
|
|
1045
1040
|
return nil unless attributes.is_a?(Hash)
|
|
1046
1041
|
self.class.openapi_types.each_pair do |key, type|
|
|
1047
|
-
if
|
|
1042
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
1043
|
+
self.send("#{key}=", nil)
|
|
1044
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
1048
1045
|
# check to ensure the input is an array given that the attribute
|
|
1049
1046
|
# is documented as an array but the input is not
|
|
1050
1047
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
@@ -1052,7 +1049,7 @@ module VeloPayments
|
|
|
1052
1049
|
end
|
|
1053
1050
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
1054
1051
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
1055
|
-
end
|
|
1052
|
+
end
|
|
1056
1053
|
end
|
|
1057
1054
|
|
|
1058
1055
|
self
|
|
@@ -1064,8 +1061,8 @@ module VeloPayments
|
|
|
1064
1061
|
# @return [Object] Deserialized data
|
|
1065
1062
|
def _deserialize(type, value)
|
|
1066
1063
|
case type.to_sym
|
|
1067
|
-
when :
|
|
1068
|
-
|
|
1064
|
+
when :Time
|
|
1065
|
+
Time.parse(value)
|
|
1069
1066
|
when :Date
|
|
1070
1067
|
Date.parse(value)
|
|
1071
1068
|
when :String
|
|
@@ -1095,7 +1092,9 @@ module VeloPayments
|
|
|
1095
1092
|
end
|
|
1096
1093
|
end
|
|
1097
1094
|
else # model
|
|
1098
|
-
|
|
1095
|
+
# models (e.g. Pet) or oneOf
|
|
1096
|
+
klass = VeloPayments.const_get(type)
|
|
1097
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
1099
1098
|
end
|
|
1100
1099
|
end
|
|
1101
1100
|
|
|
@@ -1121,7 +1120,7 @@ module VeloPayments
|
|
|
1121
1120
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
1122
1121
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
1123
1122
|
end
|
|
1124
|
-
|
|
1123
|
+
|
|
1125
1124
|
hash[param] = _to_hash(value)
|
|
1126
1125
|
end
|
|
1127
1126
|
hash
|
|
@@ -1144,5 +1143,7 @@ module VeloPayments
|
|
|
1144
1143
|
value
|
|
1145
1144
|
end
|
|
1146
1145
|
end
|
|
1146
|
+
|
|
1147
1147
|
end
|
|
1148
|
+
|
|
1148
1149
|
end
|
|
@@ -3,14 +3,15 @@
|
|
|
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.29.128
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module VeloPayments
|
|
16
17
|
class CreatePayeesCSVRequest2
|
|
@@ -76,6 +77,7 @@ module VeloPayments
|
|
|
76
77
|
|
|
77
78
|
attr_accessor :challenge_value
|
|
78
79
|
|
|
80
|
+
# An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
|
|
79
81
|
attr_accessor :payee_language
|
|
80
82
|
|
|
81
83
|
class EnumAttributeValidator
|
|
@@ -135,10 +137,15 @@ module VeloPayments
|
|
|
135
137
|
}
|
|
136
138
|
end
|
|
137
139
|
|
|
140
|
+
# Returns all the JSON keys this model knows about
|
|
141
|
+
def self.acceptable_attributes
|
|
142
|
+
attribute_map.values
|
|
143
|
+
end
|
|
144
|
+
|
|
138
145
|
# Attribute type mapping.
|
|
139
146
|
def self.openapi_types
|
|
140
147
|
{
|
|
141
|
-
:'type' => :'
|
|
148
|
+
:'type' => :'PayeeType2',
|
|
142
149
|
:'remote_id' => :'String',
|
|
143
150
|
:'email' => :'String',
|
|
144
151
|
:'address_line1' => :'String',
|
|
@@ -605,8 +612,6 @@ module VeloPayments
|
|
|
605
612
|
return false if !@challenge_description.nil? && @challenge_description.to_s.length < 1
|
|
606
613
|
return false if !@challenge_value.nil? && @challenge_value.to_s.length > 20
|
|
607
614
|
return false if !@challenge_value.nil? && @challenge_value.to_s.length < 3
|
|
608
|
-
payee_language_validator = EnumAttributeValidator.new('String', ["AR", "EN", "ES", "FR", "HE", "HI", "JA", "PT", "RU", "UR", "ZH"])
|
|
609
|
-
return false unless payee_language_validator.valid?(@payee_language)
|
|
610
615
|
true
|
|
611
616
|
end
|
|
612
617
|
|
|
@@ -973,16 +978,6 @@ module VeloPayments
|
|
|
973
978
|
@challenge_value = challenge_value
|
|
974
979
|
end
|
|
975
980
|
|
|
976
|
-
# Custom attribute writer method checking allowed values (enum).
|
|
977
|
-
# @param [Object] payee_language Object to be assigned
|
|
978
|
-
def payee_language=(payee_language)
|
|
979
|
-
validator = EnumAttributeValidator.new('String', ["AR", "EN", "ES", "FR", "HE", "HI", "JA", "PT", "RU", "UR", "ZH"])
|
|
980
|
-
unless validator.valid?(payee_language)
|
|
981
|
-
fail ArgumentError, "invalid value for \"payee_language\", must be one of #{validator.allowable_values}."
|
|
982
|
-
end
|
|
983
|
-
@payee_language = payee_language
|
|
984
|
-
end
|
|
985
|
-
|
|
986
981
|
# Checks equality by comparing each attribute.
|
|
987
982
|
# @param [Object] Object to be compared
|
|
988
983
|
def ==(o)
|
|
@@ -1044,7 +1039,9 @@ module VeloPayments
|
|
|
1044
1039
|
def build_from_hash(attributes)
|
|
1045
1040
|
return nil unless attributes.is_a?(Hash)
|
|
1046
1041
|
self.class.openapi_types.each_pair do |key, type|
|
|
1047
|
-
if
|
|
1042
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
1043
|
+
self.send("#{key}=", nil)
|
|
1044
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
1048
1045
|
# check to ensure the input is an array given that the attribute
|
|
1049
1046
|
# is documented as an array but the input is not
|
|
1050
1047
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
@@ -1052,7 +1049,7 @@ module VeloPayments
|
|
|
1052
1049
|
end
|
|
1053
1050
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
1054
1051
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
1055
|
-
end
|
|
1052
|
+
end
|
|
1056
1053
|
end
|
|
1057
1054
|
|
|
1058
1055
|
self
|
|
@@ -1064,8 +1061,8 @@ module VeloPayments
|
|
|
1064
1061
|
# @return [Object] Deserialized data
|
|
1065
1062
|
def _deserialize(type, value)
|
|
1066
1063
|
case type.to_sym
|
|
1067
|
-
when :
|
|
1068
|
-
|
|
1064
|
+
when :Time
|
|
1065
|
+
Time.parse(value)
|
|
1069
1066
|
when :Date
|
|
1070
1067
|
Date.parse(value)
|
|
1071
1068
|
when :String
|
|
@@ -1095,7 +1092,9 @@ module VeloPayments
|
|
|
1095
1092
|
end
|
|
1096
1093
|
end
|
|
1097
1094
|
else # model
|
|
1098
|
-
|
|
1095
|
+
# models (e.g. Pet) or oneOf
|
|
1096
|
+
klass = VeloPayments.const_get(type)
|
|
1097
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
1099
1098
|
end
|
|
1100
1099
|
end
|
|
1101
1100
|
|
|
@@ -1121,7 +1120,7 @@ module VeloPayments
|
|
|
1121
1120
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
1122
1121
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
1123
1122
|
end
|
|
1124
|
-
|
|
1123
|
+
|
|
1125
1124
|
hash[param] = _to_hash(value)
|
|
1126
1125
|
end
|
|
1127
1126
|
hash
|
|
@@ -1144,5 +1143,7 @@ module VeloPayments
|
|
|
1144
1143
|
value
|
|
1145
1144
|
end
|
|
1146
1145
|
end
|
|
1146
|
+
|
|
1147
1147
|
end
|
|
1148
|
+
|
|
1148
1149
|
end
|
|
@@ -3,14 +3,15 @@
|
|
|
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.29.128
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module VeloPayments
|
|
16
17
|
class CreatePayeesCSVResponse
|
|
@@ -26,6 +27,11 @@ module VeloPayments
|
|
|
26
27
|
}
|
|
27
28
|
end
|
|
28
29
|
|
|
30
|
+
# Returns all the JSON keys this model knows about
|
|
31
|
+
def self.acceptable_attributes
|
|
32
|
+
attribute_map.values
|
|
33
|
+
end
|
|
34
|
+
|
|
29
35
|
# Attribute type mapping.
|
|
30
36
|
def self.openapi_types
|
|
31
37
|
{
|
|
@@ -113,7 +119,9 @@ module VeloPayments
|
|
|
113
119
|
def build_from_hash(attributes)
|
|
114
120
|
return nil unless attributes.is_a?(Hash)
|
|
115
121
|
self.class.openapi_types.each_pair do |key, type|
|
|
116
|
-
if
|
|
122
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
123
|
+
self.send("#{key}=", nil)
|
|
124
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
117
125
|
# check to ensure the input is an array given that the attribute
|
|
118
126
|
# is documented as an array but the input is not
|
|
119
127
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
@@ -121,7 +129,7 @@ module VeloPayments
|
|
|
121
129
|
end
|
|
122
130
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
123
131
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
124
|
-
end
|
|
132
|
+
end
|
|
125
133
|
end
|
|
126
134
|
|
|
127
135
|
self
|
|
@@ -133,8 +141,8 @@ module VeloPayments
|
|
|
133
141
|
# @return [Object] Deserialized data
|
|
134
142
|
def _deserialize(type, value)
|
|
135
143
|
case type.to_sym
|
|
136
|
-
when :
|
|
137
|
-
|
|
144
|
+
when :Time
|
|
145
|
+
Time.parse(value)
|
|
138
146
|
when :Date
|
|
139
147
|
Date.parse(value)
|
|
140
148
|
when :String
|
|
@@ -164,7 +172,9 @@ module VeloPayments
|
|
|
164
172
|
end
|
|
165
173
|
end
|
|
166
174
|
else # model
|
|
167
|
-
|
|
175
|
+
# models (e.g. Pet) or oneOf
|
|
176
|
+
klass = VeloPayments.const_get(type)
|
|
177
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
168
178
|
end
|
|
169
179
|
end
|
|
170
180
|
|
|
@@ -190,7 +200,7 @@ module VeloPayments
|
|
|
190
200
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
191
201
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
192
202
|
end
|
|
193
|
-
|
|
203
|
+
|
|
194
204
|
hash[param] = _to_hash(value)
|
|
195
205
|
end
|
|
196
206
|
hash
|
|
@@ -213,5 +223,7 @@ module VeloPayments
|
|
|
213
223
|
value
|
|
214
224
|
end
|
|
215
225
|
end
|
|
226
|
+
|
|
216
227
|
end
|
|
228
|
+
|
|
217
229
|
end
|