velopayments 2.23.78.beta1 → 2.26.124.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/Makefile +2 -3
- data/README.md +61 -71
- data/docs/AcceptedPaymentV3.md +22 -17
- 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 +14 -13
- data/docs/Category.md +15 -0
- data/docs/Challenge.md +10 -9
- data/docs/Challenge2.md +10 -9
- data/docs/Company.md +12 -11
- data/docs/Company2.md +12 -11
- data/docs/CountriesApi.md +74 -21
- data/docs/CreateFundingAccountRequestV2.md +20 -19
- 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/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 +14 -15
- data/docs/CreateWebhookRequest.md +16 -13
- data/docs/CurrenciesApi.md +26 -9
- 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 -25
- data/docs/FundingAccountResponse2.md +26 -25
- data/docs/FundingAccountType.md +4 -5
- data/docs/FundingAudit.md +24 -23
- data/docs/FundingEvent.md +14 -13
- data/docs/FundingEventType.md +4 -5
- data/docs/FundingManagerApi.md +549 -259
- data/docs/FundingManagerPrivateApi.md +98 -13
- data/docs/FundingPayorStatusAuditResponse.md +14 -13
- data/docs/FundingRequestV1.md +8 -7
- data/docs/FundingRequestV2.md +8 -7
- data/docs/FundingRequestV3.md +10 -9
- data/docs/FxSummary.md +36 -0
- data/docs/FxSummaryV3.md +26 -25
- data/docs/GetFundingsResponse.md +12 -11
- data/docs/GetFundingsResponseLinks.md +10 -9
- data/docs/GetPayeeListResponse.md +40 -39
- data/docs/GetPayeeListResponse2.md +50 -0
- data/docs/GetPayeeListResponseCompany.md +10 -9
- data/docs/GetPayeeListResponseCompany2.md +20 -0
- data/docs/GetPayeeListResponseIndividual.md +8 -7
- 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 +44 -43
- 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 +12 -9
- data/docs/InlineResponse409.md +12 -9
- data/docs/InlineResponse412.md +12 -9
- data/docs/InvitationStatus.md +4 -5
- data/docs/InvitationStatus2.md +4 -5
- data/docs/InvitePayeeRequest.md +8 -7
- data/docs/InvitePayeeRequest2.md +8 -7
- data/docs/InviteUserRequest.md +26 -25
- data/docs/KycState.md +4 -5
- data/docs/LinkForResponse.md +10 -9
- data/docs/ListFundingAccountsResponse.md +12 -11
- data/docs/ListFundingAccountsResponse2.md +12 -11
- data/docs/ListPaymentsResponseV3.md +12 -11
- data/docs/ListPaymentsResponseV3Page.md +16 -15
- 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 +10 -9
- data/docs/ListSourceAccountResponseV3.md +12 -11
- data/docs/ListSourceAccountResponseV3Links.md +10 -9
- data/docs/LocalisationDetails.md +20 -0
- data/docs/LoginApi.md +109 -41
- data/docs/MFADetails.md +10 -9
- data/docs/MFAType.md +4 -5
- data/docs/Name.md +14 -13
- data/docs/Name2.md +24 -0
- data/docs/Notification.md +26 -0
- data/docs/Notifications.md +8 -7
- data/docs/Notifications2.md +8 -7
- 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 +12 -11
- 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 +64 -63
- data/docs/PayeeDetailResponse2.md +64 -63
- 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 +216 -359
- 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/PayeeUserSelfUpdateRequest.md +18 -17
- data/docs/PayeesApi.md +346 -499
- data/docs/PaymentAuditCurrency.md +15 -0
- data/docs/PaymentAuditCurrencyV3.md +4 -5
- data/docs/PaymentAuditServiceApi.md +242 -631
- 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 +24 -19
- 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 +96 -85
- data/docs/PaymentResponseV4Payout.md +12 -11
- data/docs/PaymentStatusChanged.md +30 -0
- data/docs/PaymentStatusChangedAllOf.md +18 -0
- data/docs/PaymentV3.md +32 -27
- 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/PayorV1.md +50 -49
- data/docs/PayorV2.md +52 -49
- data/docs/PayorsApi.md +236 -101
- data/docs/PayorsPrivateApi.md +29 -13
- data/docs/PayoutCompanyV3.md +8 -7
- data/docs/PayoutIndividualV3.md +8 -7
- data/docs/PayoutNameV3.md +10 -9
- data/docs/PayoutPayeeV3.md +12 -11
- data/docs/PayoutPayor.md +26 -0
- data/docs/PayoutPayorIds.md +22 -0
- data/docs/PayoutPrincipal.md +20 -0
- data/docs/PayoutServiceApi.md +208 -88
- data/docs/PayoutStatus.md +15 -0
- data/docs/PayoutStatusV3.md +4 -5
- data/docs/PayoutSummaryAudit.md +48 -0
- data/docs/PayoutSummaryAuditV3.md +30 -29
- data/docs/PayoutSummaryResponseV3.md +26 -25
- data/docs/PayoutType.md +15 -0
- data/docs/Ping.md +22 -0
- data/docs/QueryBatchResponse.md +14 -13
- data/docs/QueryBatchResponse2.md +14 -13
- data/docs/QuoteFxSummaryV3.md +28 -27
- data/docs/QuoteResponseV3.md +8 -7
- data/docs/RegionV2.md +10 -9
- data/docs/RegisterSmsRequest.md +8 -7
- data/docs/RejectedPaymentV3.md +28 -23
- 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/SelfMFATypeUnregisterRequest.md +8 -7
- data/docs/SelfUpdatePasswordRequest.md +10 -9
- data/docs/SetNotificationsRequest.md +8 -7
- data/docs/SourceAccountResponse.md +34 -33
- data/docs/SourceAccountResponseV2.md +38 -37
- data/docs/SourceAccountResponseV3.md +42 -37
- data/docs/SourceAccountSummary.md +22 -0
- data/docs/SourceAccountSummaryV3.md +12 -11
- data/docs/SourceAccountType.md +4 -5
- data/docs/SourceAccountV3.md +14 -13
- data/docs/SourceEvent.md +22 -0
- data/docs/SupportedCountriesResponse.md +8 -7
- data/docs/SupportedCountriesResponseV2.md +8 -7
- data/docs/SupportedCountry.md +10 -9
- data/docs/SupportedCountryV2.md +12 -11
- data/docs/SupportedCurrencyResponseV2.md +8 -7
- data/docs/SupportedCurrencyV2.md +10 -9
- data/docs/TokensApi.md +31 -15
- data/docs/TransferRequest.md +12 -11
- data/docs/TransferRequest2.md +12 -11
- data/docs/TransmissionType.md +4 -5
- data/docs/TransmissionTypes.md +12 -11
- data/docs/TransmissionTypes2.md +12 -11
- data/docs/UnregisterMFARequest.md +10 -9
- data/docs/UpdatePayeeDetailsRequest.md +20 -19
- data/docs/UpdatePayeeDetailsRequest2.md +20 -19
- data/docs/UpdateRemoteIdRequest.md +10 -9
- data/docs/UpdateRemoteIdRequest2.md +20 -0
- data/docs/UpdateWebhookRequest.md +14 -11
- data/docs/UserDetailsUpdateRequest.md +22 -21
- data/docs/UserInfo.md +12 -11
- data/docs/UserResponse.md +34 -33
- data/docs/UserStatus.md +4 -5
- data/docs/UserType.md +4 -5
- data/docs/UserType2.md +4 -5
- data/docs/UsersApi.md +478 -189
- data/docs/ValidatePasswordResponse.md +14 -13
- data/docs/WatchlistStatus.md +4 -5
- data/docs/WatchlistStatus2.md +4 -5
- data/docs/WebhookResponse.md +18 -15
- data/docs/WebhooksApi.md +109 -92
- data/docs/WebhooksResponse.md +12 -11
- data/docs/WithdrawPaymentRequest.md +8 -7
- data/lib/velopayments.rb +50 -48
- data/lib/velopayments/api/countries_api.rb +2 -2
- data/lib/velopayments/api/currencies_api.rb +2 -2
- data/lib/velopayments/api/funding_manager_api.rb +5 -2
- data/lib/velopayments/api/funding_manager_private_api.rb +65 -2
- data/lib/velopayments/api/login_api.rb +2 -2
- data/lib/velopayments/api/payee_invitation_api.rb +25 -358
- data/lib/velopayments/api/payees_api.rb +28 -468
- data/lib/velopayments/api/payment_audit_service_api.rb +61 -733
- data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
- data/lib/velopayments/api/payors_api.rb +2 -2
- data/lib/velopayments/api/payors_private_api.rb +2 -2
- data/lib/velopayments/api/payout_service_api.rb +9 -2
- data/lib/velopayments/api/tokens_api.rb +2 -2
- data/lib/velopayments/api/users_api.rb +2 -2
- data/lib/velopayments/api/webhooks_api.rb +2 -61
- data/lib/velopayments/api_client.rb +6 -5
- data/lib/velopayments/api_error.rb +2 -2
- data/lib/velopayments/configuration.rb +9 -7
- data/lib/velopayments/models/accepted_payment_v3.rb +34 -8
- data/lib/velopayments/models/access_token_response.rb +12 -4
- data/lib/velopayments/models/access_token_validation_request.rb +12 -4
- data/lib/velopayments/models/auth_response.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config.rb +12 -4
- data/lib/velopayments/models/auto_top_up_config2.rb +12 -4
- data/lib/velopayments/models/{payee_type2.rb → category.rb} +8 -7
- data/lib/velopayments/models/challenge.rb +12 -4
- data/lib/velopayments/models/challenge2.rb +12 -4
- data/lib/velopayments/models/company.rb +12 -4
- data/lib/velopayments/models/company2.rb +12 -4
- data/lib/velopayments/models/create_funding_account_request_v2.rb +12 -4
- data/lib/velopayments/models/create_individual.rb +13 -5
- data/lib/velopayments/models/create_individual2.rb +13 -5
- data/lib/velopayments/models/{individual_v1_name.rb → create_individual_name.rb} +15 -7
- data/lib/velopayments/models/create_payee.rb +16 -7
- data/lib/velopayments/models/create_payee2.rb +15 -6
- data/lib/velopayments/models/create_payee_address.rb +45 -21
- data/lib/velopayments/models/create_payee_address2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response2.rb +12 -4
- data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +12 -4
- data/lib/velopayments/models/create_payees_request.rb +12 -4
- data/lib/velopayments/models/create_payees_request2.rb +12 -4
- data/lib/velopayments/models/create_payment_channel.rb +12 -4
- data/lib/velopayments/models/create_payment_channel2.rb +12 -4
- data/lib/velopayments/models/create_payor_link_request.rb +12 -4
- data/lib/velopayments/models/create_payout_request_v3.rb +44 -18
- data/lib/velopayments/models/create_webhook_request.rb +31 -8
- data/lib/velopayments/models/debit_event.rb +278 -0
- data/lib/velopayments/models/{invitation_status_response.rb → debit_event_all_of.rb} +26 -19
- data/lib/velopayments/models/debit_status_changed.rb +293 -0
- data/lib/velopayments/models/{marketing_opt_in.rb → debit_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/error.rb +46 -10
- data/lib/velopayments/models/error_data.rb +229 -0
- data/lib/velopayments/models/error_response.rb +41 -10
- data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +96 -65
- data/lib/velopayments/models/failed_payee2.rb +313 -0
- data/lib/velopayments/models/failed_submission.rb +13 -5
- data/lib/velopayments/models/failed_submission2.rb +13 -5
- data/lib/velopayments/models/funding_account_response.rb +12 -4
- data/lib/velopayments/models/funding_account_response2.rb +12 -4
- data/lib/velopayments/models/funding_account_type.rb +2 -2
- data/lib/velopayments/models/funding_audit.rb +12 -4
- data/lib/velopayments/models/funding_event.rb +12 -4
- data/lib/velopayments/models/funding_event_type.rb +2 -2
- data/lib/velopayments/models/funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/funding_request_v1.rb +12 -4
- data/lib/velopayments/models/funding_request_v2.rb +12 -4
- data/lib/velopayments/models/funding_request_v3.rb +12 -4
- data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +17 -9
- data/lib/velopayments/models/fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/get_fundings_response.rb +12 -4
- data/lib/velopayments/models/get_fundings_response_links.rb +12 -4
- data/lib/velopayments/models/get_payee_list_response.rb +14 -5
- data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +89 -112
- data/lib/velopayments/models/get_payee_list_response_company.rb +12 -4
- data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company2.rb} +21 -22
- data/lib/velopayments/models/get_payee_list_response_individual.rb +12 -4
- data/lib/velopayments/models/{individual_response.rb → get_payee_list_response_individual2.rb} +16 -13
- data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +12 -4
- data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +20 -47
- data/lib/velopayments/models/get_payout_statistics.rb +12 -4
- data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +16 -8
- data/lib/velopayments/models/get_payouts_response_v3.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_links.rb +12 -4
- data/lib/velopayments/models/get_payouts_response_v3_page.rb +12 -4
- data/lib/velopayments/models/individual.rb +13 -5
- data/lib/velopayments/models/individual2.rb +13 -5
- data/lib/velopayments/models/{create_individual2_name.rb → individual_name.rb} +15 -7
- data/lib/velopayments/models/inline_response400.rb +43 -10
- data/lib/velopayments/models/inline_response401.rb +43 -10
- data/lib/velopayments/models/inline_response403.rb +43 -10
- data/lib/velopayments/models/inline_response404.rb +43 -10
- data/lib/velopayments/models/inline_response409.rb +43 -10
- data/lib/velopayments/models/inline_response412.rb +43 -10
- data/lib/velopayments/models/invitation_status.rb +2 -2
- data/lib/velopayments/models/invitation_status2.rb +2 -2
- data/lib/velopayments/models/invite_payee_request.rb +12 -4
- data/lib/velopayments/models/invite_payee_request2.rb +12 -4
- data/lib/velopayments/models/invite_user_request.rb +12 -4
- data/lib/velopayments/models/kyc_state.rb +2 -2
- data/lib/velopayments/models/link_for_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response.rb +12 -4
- data/lib/velopayments/models/list_funding_accounts_response2.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v3_page.rb +12 -4
- data/lib/velopayments/models/list_payments_response_v4.rb +12 -4
- data/lib/velopayments/models/list_source_account_response.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_page.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v2_links.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3.rb +12 -4
- data/lib/velopayments/models/list_source_account_response_v3_links.rb +12 -4
- data/lib/velopayments/models/localisation_details.rb +231 -0
- data/lib/velopayments/models/mfa_details.rb +12 -4
- data/lib/velopayments/models/mfa_type.rb +2 -2
- data/lib/velopayments/models/name.rb +12 -4
- data/lib/velopayments/models/name2.rb +341 -0
- data/lib/velopayments/models/{individual_v1.rb → notification.rb} +69 -54
- data/lib/velopayments/models/notifications.rb +12 -4
- data/lib/velopayments/models/notifications2.rb +12 -4
- data/lib/velopayments/models/ofac_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status.rb +2 -2
- data/lib/velopayments/models/onboarded_status2.rb +2 -2
- data/lib/velopayments/models/{inline_response404_errors.rb → onboarding_status_changed.rb} +84 -35
- data/lib/velopayments/models/page_for_response.rb +12 -4
- data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response.rb +13 -5
- data/lib/velopayments/models/paged_payee_response2.rb +14 -6
- data/lib/velopayments/models/paged_payee_response_links.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_page.rb +12 -4
- data/lib/velopayments/models/paged_payee_response_summary.rb +19 -11
- data/lib/velopayments/models/paged_payments_response_v3.rb +12 -4
- data/lib/velopayments/models/paged_user_response.rb +12 -4
- data/lib/velopayments/models/paged_user_response_links.rb +12 -4
- data/lib/velopayments/models/paged_user_response_page.rb +12 -4
- data/lib/velopayments/models/password_request.rb +12 -4
- 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 +12 -4
- data/lib/velopayments/models/payee_address2.rb +12 -4
- data/lib/velopayments/models/payee_delta.rb +13 -5
- data/lib/velopayments/models/payee_delta2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2.rb +12 -4
- data/lib/velopayments/models/payee_delta_response2_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_links.rb +12 -4
- data/lib/velopayments/models/payee_delta_response_page.rb +12 -4
- data/lib/velopayments/models/payee_detail_response.rb +18 -9
- data/lib/velopayments/models/payee_detail_response2.rb +16 -7
- data/lib/velopayments/models/payee_details_changed.rb +289 -0
- data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +78 -60
- 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 +12 -4
- data/lib/velopayments/models/payee_invitation_status_response2.rb +12 -4
- data/lib/velopayments/models/payee_payor_ref.rb +58 -8
- data/lib/velopayments/models/payee_payor_ref_v3.rb +38 -8
- data/lib/velopayments/models/payee_type.rb +2 -2
- data/lib/velopayments/models/payee_user_self_update_request.rb +12 -4
- data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +5 -5
- data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
- data/lib/velopayments/models/payment_channel_country.rb +12 -4
- data/lib/velopayments/models/payment_channel_rule.rb +12 -4
- data/lib/velopayments/models/payment_channel_rules_response.rb +12 -4
- data/lib/velopayments/models/payment_delta.rb +12 -4
- data/lib/velopayments/models/payment_delta_response.rb +12 -4
- data/lib/velopayments/models/{payment_delta_response_v4.rb → payment_delta_response_v1.rb} +16 -8
- data/lib/velopayments/models/{payment_delta_v4.rb → payment_delta_v1.rb} +15 -7
- data/lib/velopayments/models/payment_event.rb +297 -0
- data/lib/velopayments/models/payment_event_all_of.rb +243 -0
- data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +19 -11
- data/lib/velopayments/models/payment_event_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_instruction_v3.rb +87 -8
- data/lib/velopayments/models/payment_rails.rb +2 -2
- data/lib/velopayments/models/{company_v1.rb → payment_rejected_or_returned.rb} +126 -89
- data/lib/velopayments/models/{inline_response400_errors.rb → payment_rejected_or_returned_all_of.rb} +40 -41
- data/lib/velopayments/models/payment_response_v3.rb +12 -4
- data/lib/velopayments/models/payment_response_v4.rb +65 -8
- data/lib/velopayments/models/payment_response_v4_payout.rb +14 -6
- data/lib/velopayments/models/payment_status_changed.rb +312 -0
- data/lib/velopayments/models/{ping_response.rb → payment_status_changed_all_of.rb} +28 -23
- data/lib/velopayments/models/payment_v3.rb +34 -8
- data/lib/velopayments/models/payor_address.rb +12 -4
- data/lib/velopayments/models/payor_address_v2.rb +12 -4
- data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +16 -17
- data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -32
- data/lib/velopayments/models/payor_branding_response.rb +12 -4
- data/lib/velopayments/models/payor_create_api_key_request.rb +22 -4
- data/lib/velopayments/models/payor_create_api_key_response.rb +12 -4
- data/lib/velopayments/models/payor_create_application_request.rb +12 -4
- data/lib/velopayments/models/payor_email_opt_out_request.rb +12 -4
- data/lib/velopayments/models/payor_links_response.rb +12 -4
- data/lib/velopayments/models/payor_links_response_links.rb +12 -4
- data/lib/velopayments/models/payor_links_response_payors.rb +12 -4
- data/lib/velopayments/models/payor_v1.rb +12 -4
- data/lib/velopayments/models/payor_v2.rb +28 -8
- data/lib/velopayments/models/payout_company_v3.rb +12 -4
- data/lib/velopayments/models/payout_individual_v3.rb +12 -4
- data/lib/velopayments/models/payout_name_v3.rb +12 -4
- data/lib/velopayments/models/payout_payee_v3.rb +12 -4
- data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +15 -7
- data/lib/velopayments/models/payout_payor_ids.rb +255 -0
- data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +15 -7
- data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +5 -5
- data/lib/velopayments/models/payout_status_v3.rb +2 -2
- data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +19 -11
- data/lib/velopayments/models/payout_summary_audit_v3.rb +12 -4
- data/lib/velopayments/models/payout_summary_response_v3.rb +12 -4
- data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +5 -5
- data/lib/velopayments/models/{paged_payee_response2_summary.rb → ping.rb} +60 -44
- data/lib/velopayments/models/query_batch_response.rb +12 -4
- data/lib/velopayments/models/query_batch_response2.rb +12 -4
- data/lib/velopayments/models/quote_fx_summary_v3.rb +12 -4
- data/lib/velopayments/models/quote_response_v3.rb +12 -4
- data/lib/velopayments/models/region_v2.rb +12 -4
- data/lib/velopayments/models/register_sms_request.rb +12 -4
- data/lib/velopayments/models/rejected_payment_v3.rb +31 -5
- data/lib/velopayments/models/resend_token_request.rb +12 -4
- data/lib/velopayments/models/reset_password_request.rb +12 -4
- data/lib/velopayments/models/role.rb +12 -4
- data/lib/velopayments/models/role_update_request.rb +12 -4
- data/lib/velopayments/models/self_mfa_type_unregister_request.rb +12 -4
- data/lib/velopayments/models/self_update_password_request.rb +12 -4
- data/lib/velopayments/models/set_notifications_request.rb +12 -4
- data/lib/velopayments/models/source_account_response.rb +12 -4
- data/lib/velopayments/models/source_account_response_v2.rb +12 -4
- data/lib/velopayments/models/source_account_response_v3.rb +40 -12
- data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +16 -8
- data/lib/velopayments/models/source_account_summary_v3.rb +12 -4
- data/lib/velopayments/models/source_account_type.rb +2 -2
- data/lib/velopayments/models/source_account_v3.rb +12 -4
- data/lib/velopayments/models/{inline_response403_errors.rb → source_event.rb} +53 -38
- data/lib/velopayments/models/supported_countries_response.rb +12 -4
- data/lib/velopayments/models/supported_countries_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_country.rb +12 -4
- data/lib/velopayments/models/supported_country_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_response_v2.rb +12 -4
- data/lib/velopayments/models/supported_currency_v2.rb +12 -4
- data/lib/velopayments/models/transfer_request.rb +12 -4
- data/lib/velopayments/models/transfer_request2.rb +12 -4
- data/lib/velopayments/models/transmission_type.rb +2 -2
- data/lib/velopayments/models/transmission_types.rb +12 -4
- data/lib/velopayments/models/transmission_types2.rb +12 -4
- data/lib/velopayments/models/unregister_mfa_request.rb +12 -4
- data/lib/velopayments/models/update_payee_details_request.rb +19 -10
- data/lib/velopayments/models/update_payee_details_request2.rb +15 -6
- data/lib/velopayments/models/update_remote_id_request.rb +12 -4
- data/lib/velopayments/models/{payee_payor_ref2.rb → update_remote_id_request2.rb} +56 -39
- data/lib/velopayments/models/update_webhook_request.rb +32 -8
- data/lib/velopayments/models/user_details_update_request.rb +12 -4
- data/lib/velopayments/models/user_info.rb +12 -4
- data/lib/velopayments/models/user_response.rb +27 -4
- data/lib/velopayments/models/user_status.rb +2 -2
- data/lib/velopayments/models/user_type.rb +2 -2
- data/lib/velopayments/models/user_type2.rb +2 -2
- data/lib/velopayments/models/validate_password_response.rb +12 -4
- data/lib/velopayments/models/watchlist_status.rb +2 -2
- data/lib/velopayments/models/watchlist_status2.rb +2 -2
- data/lib/velopayments/models/webhook_response.rb +27 -8
- data/lib/velopayments/models/webhooks_response.rb +12 -4
- data/lib/velopayments/models/withdraw_payment_request.rb +12 -4
- data/lib/velopayments/version.rb +3 -3
- data/oa3-config.json +1 -1
- data/spec/api/countries_api_spec.rb +2 -2
- data/spec/api/currencies_api_spec.rb +2 -2
- data/spec/api/funding_manager_api_spec.rb +3 -2
- data/spec/api/funding_manager_private_api_spec.rb +14 -2
- data/spec/api/login_api_spec.rb +2 -2
- data/spec/api/payee_invitation_api_spec.rb +10 -75
- data/spec/api/payees_api_spec.rb +11 -99
- data/spec/api/payment_audit_service_api_spec.rb +9 -147
- data/spec/api/payment_audit_service_deprecated_api_spec.rb +177 -0
- data/spec/api/payors_api_spec.rb +2 -2
- data/spec/api/payors_private_api_spec.rb +2 -2
- data/spec/api/payout_service_api_spec.rb +3 -2
- data/spec/api/tokens_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +2 -12
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/accepted_payment_v3_spec.rb +17 -12
- 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/auto_top_up_config2_spec.rb +5 -12
- 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/challenge2_spec.rb +5 -12
- 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/create_funding_account_request_v2_spec.rb +6 -13
- 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_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_v3_spec.rb +5 -18
- data/spec/models/create_webhook_request_spec.rb +11 -12
- data/spec/models/debit_event_all_of_spec.rb +34 -0
- data/spec/models/{inline_response400_errors_spec.rb → debit_event_spec.rb} +12 -19
- data/spec/models/{payor_logo_request_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/debit_status_changed_spec.rb +58 -0
- data/spec/models/{ping_response_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 +5 -12
- data/spec/models/funding_account_response_spec.rb +5 -12
- data/spec/models/funding_account_type_spec.rb +5 -12
- data/spec/models/funding_audit_spec.rb +8 -15
- 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 +5 -12
- 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 +5 -12
- data/spec/models/get_fundings_response_spec.rb +5 -12
- data/spec/models/{payee_spec.rb → get_payee_list_response2_spec.rb} +21 -46
- data/spec/models/{company_response_spec.rb → get_payee_list_response_company2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_company_spec.rb +5 -12
- data/spec/models/{individual_response_spec.rb → get_payee_list_response_individual2_spec.rb} +8 -15
- data/spec/models/get_payee_list_response_individual_spec.rb +5 -12
- data/spec/models/get_payee_list_response_spec.rb +5 -12
- 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 +5 -16
- data/spec/models/get_payout_statistics_spec.rb +5 -12
- data/spec/models/{get_payouts_response_v4_spec.rb → get_payouts_response_spec.rb} +8 -15
- 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/inline_response404_spec.rb +11 -12
- data/spec/models/inline_response409_spec.rb +11 -12
- data/spec/models/inline_response412_spec.rb +11 -12
- data/spec/models/invitation_status2_spec.rb +5 -12
- 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 +6 -13
- data/spec/models/kyc_state_spec.rb +5 -12
- data/spec/models/link_for_response_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response2_spec.rb +5 -12
- data/spec/models/list_funding_accounts_response_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_page_spec.rb +5 -12
- data/spec/models/list_payments_response_v3_spec.rb +5 -12
- 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 +5 -12
- data/spec/models/list_source_account_response_v2_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_links_spec.rb +5 -12
- data/spec/models/list_source_account_response_v3_spec.rb +5 -12
- data/spec/models/{marketing_opt_in_spec.rb → localisation_details_spec.rb} +10 -17
- 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 +5 -12
- data/spec/models/notification_spec.rb +58 -0
- data/spec/models/notifications2_spec.rb +5 -12
- 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/{payee_payor_ref2_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/paged_payments_response_v3_spec.rb +5 -12
- 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_detail_response2_spec.rb +5 -12
- data/spec/models/payee_detail_response_spec.rb +5 -12
- 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_response401_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 -12
- data/spec/models/payee_type_spec.rb +5 -12
- data/spec/models/payee_user_self_update_request_spec.rb +5 -12
- data/spec/models/{language2_spec.rb → payment_audit_currency_spec.rb} +8 -15
- 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_v4_spec.rb → payment_delta_response_v1_spec.rb} +8 -15
- data/spec/models/payment_delta_spec.rb +5 -12
- data/spec/models/{payment_delta_v4_spec.rb → payment_delta_v1_spec.rb} +8 -15
- data/spec/models/{company_v1_spec.rb → payment_event_all_of_spec.rb} +11 -18
- 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/{paged_payee_response2_summary_spec.rb → payment_event_spec.rb} +18 -19
- data/spec/models/payment_instruction_v3_spec.rb +17 -12
- 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/{payee_payment_channel2_spec.rb → payment_rejected_or_returned_spec.rb} +25 -24
- 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 +37 -14
- data/spec/models/{invitation_status_response_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
- data/spec/models/{payee_payment_channel_spec.rb → payment_status_changed_spec.rb} +15 -26
- data/spec/models/payment_v3_spec.rb +18 -13
- 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_v1_spec.rb +6 -13
- data/spec/models/payor_v2_spec.rb +12 -13
- data/spec/models/payout_company_v3_spec.rb +5 -12
- data/spec/models/payout_individual_v3_spec.rb +5 -12
- data/spec/models/payout_name_v3_spec.rb +5 -12
- data/spec/models/payout_payee_v3_spec.rb +5 -12
- data/spec/models/{individual_v1_spec.rb → payout_payor_ids_spec.rb} +11 -18
- 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/{payee_type2_spec.rb → payout_status_spec.rb} +8 -15
- data/spec/models/payout_status_v3_spec.rb +5 -12
- data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +8 -15
- data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
- data/spec/models/payout_summary_response_v3_spec.rb +5 -12
- data/spec/models/{ofac_status2_spec.rb → payout_type_spec.rb} +8 -15
- 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_v3_spec.rb +7 -14
- data/spec/models/quote_response_v3_spec.rb +5 -12
- data/spec/models/region_v2_spec.rb +5 -12
- data/spec/models/register_sms_request_spec.rb +5 -12
- data/spec/models/rejected_payment_v3_spec.rb +17 -12
- 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/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 +6 -13
- data/spec/models/source_account_response_v2_spec.rb +6 -13
- data/spec/models/source_account_response_v3_spec.rb +19 -14
- 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 +5 -12
- data/spec/models/source_account_v3_spec.rb +5 -12
- 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 +5 -12
- data/spec/models/supported_country_spec.rb +5 -12
- data/spec/models/supported_country_v2_spec.rb +5 -12
- data/spec/models/supported_currency_response_v2_spec.rb +5 -12
- data/spec/models/supported_currency_v2_spec.rb +5 -12
- data/spec/models/transfer_request2_spec.rb +5 -12
- data/spec/models/transfer_request_spec.rb +5 -12
- data/spec/models/transmission_type_spec.rb +5 -12
- data/spec/models/transmission_types2_spec.rb +5 -12
- data/spec/models/transmission_types_spec.rb +5 -12
- data/spec/models/unregister_mfa_request_spec.rb +6 -13
- data/spec/models/update_payee_details_request2_spec.rb +5 -12
- data/spec/models/update_payee_details_request_spec.rb +5 -12
- 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 +11 -12
- 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 +8 -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 +5 -12
- data/spec/models/watchlist_status_spec.rb +5 -12
- data/spec/models/webhook_response_spec.rb +11 -12
- data/spec/models/webhooks_response_spec.rb +5 -12
- data/spec/models/withdraw_payment_request_spec.rb +5 -12
- data/spec/spec_helper.rb +2 -2
- data/specs/api/payee_invitation_api_spec.rb +0 -42
- data/specs/api/payees_api_spec.rb +0 -99
- data/specs/api/payment_audit_service_api_spec.rb +0 -150
- data/velopayments.gemspec +2 -2
- metadata +194 -186
- data/docs/CompanyResponse.md +0 -19
- data/docs/CompanyV1.md +0 -21
- data/docs/CreateIndividual2Name.md +0 -23
- data/docs/CreatePayeesCSVRequest.md +0 -73
- data/docs/CreatePayeesCSVRequest2.md +0 -73
- data/docs/FxSummaryV4.md +0 -35
- 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/InlineResponse404Errors.md +0 -23
- data/docs/InlineResponse409Errors.md +0 -23
- data/docs/InlineResponse412Errors.md +0 -23
- data/docs/InvitationStatusResponse.md +0 -17
- data/docs/Language.md +0 -16
- data/docs/Language2.md +0 -16
- 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/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/PayeePayorRef2.md +0 -25
- data/docs/PayeePayorRefV2.md +0 -25
- data/docs/PayeeResponse.md +0 -55
- data/docs/PayeeResponseV2.md +0 -73
- data/docs/PayeeType2.md +0 -16
- data/docs/PaymentAuditCurrencyV4.md +0 -16
- data/docs/PaymentDeltaResponseV4.md +0 -21
- data/docs/PaymentDeltaV4.md +0 -31
- data/docs/PaymentEventResponseV4.md +0 -39
- data/docs/PayorAmlTransactionV4.md +0 -71
- data/docs/PayorLogoRequest.md +0 -17
- data/docs/PayoutPayorV4.md +0 -25
- data/docs/PayoutPrincipalV4.md +0 -19
- data/docs/PayoutStatusV4.md +0 -16
- data/docs/PayoutSummaryAuditV4.md +0 -47
- data/docs/PayoutTypeV4.md +0 -16
- data/docs/PingResponse.md +0 -19
- data/docs/SourceAccountSummaryV4.md +0 -21
- data/lib/velopayments/models/create_payees_csv_request.rb +0 -1152
- data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1152
- data/lib/velopayments/models/inline_response401_errors.rb +0 -240
- data/lib/velopayments/models/inline_response409_errors.rb +0 -240
- data/lib/velopayments/models/inline_response412_errors.rb +0 -240
- data/lib/velopayments/models/language.rb +0 -46
- data/lib/velopayments/models/language2.rb +0 -46
- data/lib/velopayments/models/location_type.rb +0 -40
- data/lib/velopayments/models/ofac_status2.rb +0 -38
- data/lib/velopayments/models/payee2.rb +0 -460
- data/lib/velopayments/models/payee_payment_channel.rb +0 -455
- data/lib/velopayments/models/payee_payment_channel2.rb +0 -455
- data/lib/velopayments/models/payee_response.rb +0 -392
- data/lib/velopayments/models/payee_response_v2.rb +0 -475
- data/lib/velopayments/models/payor_logo_request.rb +0 -210
- data/spec/models/create_payees_csv_request2_spec.rb +0 -225
- data/spec/models/create_payees_csv_request_spec.rb +0 -221
- data/spec/models/inline_response403_errors_spec.rb +0 -59
- data/spec/models/inline_response404_errors_spec.rb +0 -59
- data/spec/models/inline_response409_errors_spec.rb +0 -59
- data/spec/models/inline_response412_errors_spec.rb +0 -59
- data/spec/models/location_type_spec.rb +0 -35
- data/spec/models/payee2_spec.rb +0 -165
- data/spec/models/payee_invitation_status_spec.rb +0 -57
- data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
- data/spec/models/payee_response_spec.rb +0 -155
- data/spec/models/payee_response_v2_spec.rb +0 -209
- 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
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -90,6 +90,7 @@ module VeloPayments
|
|
90
90
|
# @option opts [String] :remote_id The remote id of the payees.
|
91
91
|
# @option opts [String] :payor_payment_id Payor's Id of the Payment
|
92
92
|
# @option opts [String] :source_account_name Physical Account Name
|
93
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
93
94
|
# @option opts [String] :payment_memo Payment Memo of the Payment
|
94
95
|
# @option opts [Integer] :page_size The number of results to return in a page (default to 25)
|
95
96
|
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
|
@@ -107,6 +108,7 @@ module VeloPayments
|
|
107
108
|
# @option opts [String] :remote_id The remote id of the payees.
|
108
109
|
# @option opts [String] :payor_payment_id Payor's Id of the Payment
|
109
110
|
# @option opts [String] :source_account_name Physical Account Name
|
111
|
+
# @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE
|
110
112
|
# @option opts [String] :payment_memo Payment Memo of the Payment
|
111
113
|
# @option opts [Integer] :page_size The number of results to return in a page
|
112
114
|
# @option opts [Integer] :page Page number. Default is 1.
|
@@ -123,6 +125,10 @@ module VeloPayments
|
|
123
125
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
124
126
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
125
127
|
end
|
128
|
+
allowable_values = ["ACH", "SAME_DAY_ACH", "WIRE"]
|
129
|
+
if @api_client.config.client_side_validation && opts[:'transmission_type'] && !allowable_values.include?(opts[:'transmission_type'])
|
130
|
+
fail ArgumentError, "invalid value for \"transmission_type\", must be one of #{allowable_values}"
|
131
|
+
end
|
126
132
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
127
133
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PayoutServiceApi.get_payments_for_payout_v3, must be smaller than or equal to 100.'
|
128
134
|
end
|
@@ -140,6 +146,7 @@ module VeloPayments
|
|
140
146
|
query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
141
147
|
query_params[:'payorPaymentId'] = opts[:'payor_payment_id'] if !opts[:'payor_payment_id'].nil?
|
142
148
|
query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].nil?
|
149
|
+
query_params[:'transmissionType'] = opts[:'transmission_type'] if !opts[:'transmission_type'].nil?
|
143
150
|
query_params[:'paymentMemo'] = opts[:'payment_memo'] if !opts[:'payment_memo'].nil?
|
144
151
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
145
152
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -221,65 +221,6 @@ module VeloPayments
|
|
221
221
|
return data, status_code, headers
|
222
222
|
end
|
223
223
|
|
224
|
-
# @param webhook_id [String] Webhook id
|
225
|
-
# @param [Hash] opts the optional parameters
|
226
|
-
# @return [PingResponse]
|
227
|
-
def ping_webhook_v1(webhook_id, opts = {})
|
228
|
-
data, _status_code, _headers = ping_webhook_v1_with_http_info(webhook_id, opts)
|
229
|
-
data
|
230
|
-
end
|
231
|
-
|
232
|
-
# @param webhook_id [String] Webhook id
|
233
|
-
# @param [Hash] opts the optional parameters
|
234
|
-
# @return [Array<(PingResponse, Integer, Hash)>] PingResponse data, response status code and response headers
|
235
|
-
def ping_webhook_v1_with_http_info(webhook_id, opts = {})
|
236
|
-
if @api_client.config.debugging
|
237
|
-
@api_client.config.logger.debug 'Calling API: WebhooksApi.ping_webhook_v1 ...'
|
238
|
-
end
|
239
|
-
# verify the required parameter 'webhook_id' is set
|
240
|
-
if @api_client.config.client_side_validation && webhook_id.nil?
|
241
|
-
fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.ping_webhook_v1"
|
242
|
-
end
|
243
|
-
# resource path
|
244
|
-
local_var_path = '/v1/webhooks/{webhookId}/ping'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_id.to_s))
|
245
|
-
|
246
|
-
# query parameters
|
247
|
-
query_params = opts[:query_params] || {}
|
248
|
-
|
249
|
-
# header parameters
|
250
|
-
header_params = opts[:header_params] || {}
|
251
|
-
# HTTP header 'Accept' (if needed)
|
252
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
253
|
-
|
254
|
-
# form parameters
|
255
|
-
form_params = opts[:form_params] || {}
|
256
|
-
|
257
|
-
# http body (model)
|
258
|
-
post_body = opts[:debug_body]
|
259
|
-
|
260
|
-
# return_type
|
261
|
-
return_type = opts[:debug_return_type] || 'PingResponse'
|
262
|
-
|
263
|
-
# auth_names
|
264
|
-
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
265
|
-
|
266
|
-
new_options = opts.merge(
|
267
|
-
:operation => :"WebhooksApi.ping_webhook_v1",
|
268
|
-
:header_params => header_params,
|
269
|
-
:query_params => query_params,
|
270
|
-
:form_params => form_params,
|
271
|
-
:body => post_body,
|
272
|
-
:auth_names => auth_names,
|
273
|
-
:return_type => return_type
|
274
|
-
)
|
275
|
-
|
276
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
277
|
-
if @api_client.config.debugging
|
278
|
-
@api_client.config.logger.debug "API called: WebhooksApi#ping_webhook_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
279
|
-
end
|
280
|
-
return data, status_code, headers
|
281
|
-
end
|
282
|
-
|
283
224
|
# Update Webhook
|
284
225
|
# Update Webhook
|
285
226
|
# @param webhook_id [String] Webhook id
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -275,8 +275,9 @@ module VeloPayments
|
|
275
275
|
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
276
276
|
end
|
277
277
|
else
|
278
|
-
# models
|
279
|
-
VeloPayments.const_get(return_type)
|
278
|
+
# models (e.g. Pet) or oneOf
|
279
|
+
klass = VeloPayments.const_get(return_type)
|
280
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
280
281
|
end
|
281
282
|
end
|
282
283
|
|
@@ -307,7 +308,7 @@ module VeloPayments
|
|
307
308
|
case auth_setting[:in]
|
308
309
|
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
309
310
|
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
310
|
-
else fail ArgumentError, 'Authentication token must be in `query`
|
311
|
+
else fail ArgumentError, 'Authentication token must be in `query` or `header`'
|
311
312
|
end
|
312
313
|
end
|
313
314
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -139,7 +139,7 @@ module VeloPayments
|
|
139
139
|
|
140
140
|
def initialize
|
141
141
|
@scheme = 'https'
|
142
|
-
@host = 'api.sandbox.velopayments.com
|
142
|
+
@host = 'api.sandbox.velopayments.com'
|
143
143
|
@base_path = ''
|
144
144
|
@server_index = 0
|
145
145
|
@server_operation_index = {}
|
@@ -197,11 +197,13 @@ module VeloPayments
|
|
197
197
|
|
198
198
|
# Gets API key (with prefix if set).
|
199
199
|
# @param [String] param_name the parameter name of API key auth
|
200
|
-
def api_key_with_prefix(param_name)
|
200
|
+
def api_key_with_prefix(param_name, param_alias = nil)
|
201
|
+
key = @api_key[param_name]
|
202
|
+
key = @api_key.fetch(param_alias, key) unless param_alias.nil?
|
201
203
|
if @api_key_prefix[param_name]
|
202
|
-
"#{@api_key_prefix[param_name]} #{
|
204
|
+
"#{@api_key_prefix[param_name]} #{key}"
|
203
205
|
else
|
204
|
-
|
206
|
+
key
|
205
207
|
end
|
206
208
|
end
|
207
209
|
|
@@ -241,7 +243,7 @@ module VeloPayments
|
|
241
243
|
def server_settings
|
242
244
|
[
|
243
245
|
{
|
244
|
-
url: "https://api.sandbox.velopayments.com
|
246
|
+
url: "https://api.sandbox.velopayments.com",
|
245
247
|
description: "Velo Payments Sandbox for testing",
|
246
248
|
},
|
247
249
|
{
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -28,6 +28,10 @@ module VeloPayments
|
|
28
28
|
|
29
29
|
attr_accessor :payment_memo
|
30
30
|
|
31
|
+
attr_accessor :remote_system_id
|
32
|
+
|
33
|
+
attr_accessor :payment_metadata
|
34
|
+
|
31
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
32
36
|
def self.attribute_map
|
33
37
|
{
|
@@ -36,10 +40,17 @@ module VeloPayments
|
|
36
40
|
:'amount' => :'amount',
|
37
41
|
:'source_account_name' => :'sourceAccountName',
|
38
42
|
:'payor_payment_id' => :'payorPaymentId',
|
39
|
-
:'payment_memo' => :'paymentMemo'
|
43
|
+
:'payment_memo' => :'paymentMemo',
|
44
|
+
:'remote_system_id' => :'remoteSystemId',
|
45
|
+
:'payment_metadata' => :'paymentMetadata'
|
40
46
|
}
|
41
47
|
end
|
42
48
|
|
49
|
+
# Returns all the JSON keys this model knows about
|
50
|
+
def self.acceptable_attributes
|
51
|
+
attribute_map.values
|
52
|
+
end
|
53
|
+
|
43
54
|
# Attribute type mapping.
|
44
55
|
def self.openapi_types
|
45
56
|
{
|
@@ -48,7 +59,9 @@ module VeloPayments
|
|
48
59
|
:'amount' => :'Integer',
|
49
60
|
:'source_account_name' => :'String',
|
50
61
|
:'payor_payment_id' => :'String',
|
51
|
-
:'payment_memo' => :'String'
|
62
|
+
:'payment_memo' => :'String',
|
63
|
+
:'remote_system_id' => :'String',
|
64
|
+
:'payment_metadata' => :'String'
|
52
65
|
}
|
53
66
|
end
|
54
67
|
|
@@ -96,6 +109,14 @@ module VeloPayments
|
|
96
109
|
if attributes.key?(:'payment_memo')
|
97
110
|
self.payment_memo = attributes[:'payment_memo']
|
98
111
|
end
|
112
|
+
|
113
|
+
if attributes.key?(:'remote_system_id')
|
114
|
+
self.remote_system_id = attributes[:'remote_system_id']
|
115
|
+
end
|
116
|
+
|
117
|
+
if attributes.key?(:'payment_metadata')
|
118
|
+
self.payment_metadata = attributes[:'payment_metadata']
|
119
|
+
end
|
99
120
|
end
|
100
121
|
|
101
122
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -185,7 +206,9 @@ module VeloPayments
|
|
185
206
|
amount == o.amount &&
|
186
207
|
source_account_name == o.source_account_name &&
|
187
208
|
payor_payment_id == o.payor_payment_id &&
|
188
|
-
payment_memo == o.payment_memo
|
209
|
+
payment_memo == o.payment_memo &&
|
210
|
+
remote_system_id == o.remote_system_id &&
|
211
|
+
payment_metadata == o.payment_metadata
|
189
212
|
end
|
190
213
|
|
191
214
|
# @see the `==` method
|
@@ -197,7 +220,7 @@ module VeloPayments
|
|
197
220
|
# Calculates hash code according to all attributes.
|
198
221
|
# @return [Integer] Hash code
|
199
222
|
def hash
|
200
|
-
[remote_id, currency_type, amount, source_account_name, payor_payment_id, payment_memo].hash
|
223
|
+
[remote_id, currency_type, amount, source_account_name, payor_payment_id, payment_memo, remote_system_id, payment_metadata].hash
|
201
224
|
end
|
202
225
|
|
203
226
|
# Builds the object from hash
|
@@ -266,7 +289,9 @@ module VeloPayments
|
|
266
289
|
end
|
267
290
|
end
|
268
291
|
else # model
|
269
|
-
|
292
|
+
# models (e.g. Pet) or oneOf
|
293
|
+
klass = VeloPayments.const_get(type)
|
294
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
270
295
|
end
|
271
296
|
end
|
272
297
|
|
@@ -292,7 +317,7 @@ module VeloPayments
|
|
292
317
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
293
318
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
294
319
|
end
|
295
|
-
|
320
|
+
|
296
321
|
hash[param] = _to_hash(value)
|
297
322
|
end
|
298
323
|
hash
|
@@ -317,4 +342,5 @@ module VeloPayments
|
|
317
342
|
end
|
318
343
|
|
319
344
|
end
|
345
|
+
|
320
346
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -48,6 +48,11 @@ module VeloPayments
|
|
48
48
|
}
|
49
49
|
end
|
50
50
|
|
51
|
+
# Returns all the JSON keys this model knows about
|
52
|
+
def self.acceptable_attributes
|
53
|
+
attribute_map.values
|
54
|
+
end
|
55
|
+
|
51
56
|
# Attribute type mapping.
|
52
57
|
def self.openapi_types
|
53
58
|
{
|
@@ -220,7 +225,9 @@ module VeloPayments
|
|
220
225
|
end
|
221
226
|
end
|
222
227
|
else # model
|
223
|
-
|
228
|
+
# models (e.g. Pet) or oneOf
|
229
|
+
klass = VeloPayments.const_get(type)
|
230
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
224
231
|
end
|
225
232
|
end
|
226
233
|
|
@@ -246,7 +253,7 @@ module VeloPayments
|
|
246
253
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
247
254
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
248
255
|
end
|
249
|
-
|
256
|
+
|
250
257
|
hash[param] = _to_hash(value)
|
251
258
|
end
|
252
259
|
hash
|
@@ -271,4 +278,5 @@ module VeloPayments
|
|
271
278
|
end
|
272
279
|
|
273
280
|
end
|
281
|
+
|
274
282
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.26.124
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.2.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -25,6 +25,11 @@ module VeloPayments
|
|
25
25
|
}
|
26
26
|
end
|
27
27
|
|
28
|
+
# Returns all the JSON keys this model knows about
|
29
|
+
def self.acceptable_attributes
|
30
|
+
attribute_map.values
|
31
|
+
end
|
32
|
+
|
28
33
|
# Attribute type mapping.
|
29
34
|
def self.openapi_types
|
30
35
|
{
|
@@ -190,7 +195,9 @@ module VeloPayments
|
|
190
195
|
end
|
191
196
|
end
|
192
197
|
else # model
|
193
|
-
|
198
|
+
# models (e.g. Pet) or oneOf
|
199
|
+
klass = VeloPayments.const_get(type)
|
200
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
194
201
|
end
|
195
202
|
end
|
196
203
|
|
@@ -216,7 +223,7 @@ module VeloPayments
|
|
216
223
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
217
224
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
218
225
|
end
|
219
|
-
|
226
|
+
|
220
227
|
hash[param] = _to_hash(value)
|
221
228
|
end
|
222
229
|
hash
|
@@ -241,4 +248,5 @@ module VeloPayments
|
|
241
248
|
end
|
242
249
|
|
243
250
|
end
|
251
|
+
|
244
252
|
end
|