Package model
package model
-
ClassDescriptionAbstract class for oneOf,anyOf schemas defined in OpenAPI specThe additional information about the purchase.AdditionalPurchaseDataItemDataInnerAdditionalPurchaseDataOrderDatePrincipal's personal home address.AdjustmentTransfersListAdjustmentTransfersListEmbeddedApplePaySessionApplePaySessionRequestApplicationFor your convenience, every response includes several URLs which link to resources relevant to the request.ApplicationLinksApplicationProfileLink to the resource that was used in the request.ApplicationProfileFor your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Application` the resource was created under.ApplicationProfilesListApplicationProfilesListEmbeddedFor your convenience, every response includes several URLs which link to resources relevant to the request.ApplicationsListEmbeddedA charge authorizationThe state of the `Authorization`.AuthorizationExternalResponsesInnerFor your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Device` the request was made under.Link to the `Identity` the `Merchant` was created under and the `Transfer` was submitted with.Link to the `Transfers` realted to the `Authorization`.AuthorizationsListAuthorizationsListEmbeddedA `balance_transfer` object.The `state` of the `balance_transfer`.List of `balance_transfer` resources.List of `balance_transfer` objects.Details needed to process card present transactions.Encrypted card data used to process the transaction.Details the `Payment Instrument` that the `Transfer` debits or credits.Gets or Sets availableAccountTypeThe type of `Payment Instrument`.Configure the details of the activated device.ConfigurationDetailsCashbackOptionsConfigurationDetailsCashbackOptionsManualEntryConfigurationDetailsTipOptionsThe sender’s country.CreateApplicationRequestCreate an `Authorization` resource.Name of the transaction processor.The 3D secure information for an authorization.Create a `balance_transfer` resource.Choose the value that best applies to the account where funds will get credited.Choose the value that best applies to the account where funds will get debited.Include one of the following values to let Finix know the type of device that's being used.CreateDisputeEvidenceRequestCreateExternalLinkRequest<ul><li>Set to <strong>UPLOAD</strong> to create a link that can be used to upload files to Finix.<li>Set to <strong>DOWNLOAD</strong> to create a link where the uploaded file can be downloaded from.<li>Set to <strong>VIEW</strong> to create a link that displays the file in browser.CreateFeeProfileRequestGets or Sets roundingModeCreateFeeRequestSubtype of the fee.The type of entity the fee is linked to (**null** by default).CreateFileRequestThe type of document.Additional underwriting data that's required to verify the identity of the merchant.Include the value that best applies to the merchant's refund policy.The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.Merchant's distribution of credit card volume by business type.The underwriting details required to verify the `Identity` of the `Merchant`.Include the value that best applies to the merchant.Avalible values include: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.The primary address for the legal entity.The control owner's date of birth.The date the company was founded and registered with the US.The home address of the merchant's principal control owner.CreateInstrumentUpdateRequestCreateInstrumentUpdatesRequestCreateMerchantUnderwritingRequestName of the gateway that processes the `Merchant's` transaction.CreatePaymentInstrumentBankAccountThe type of bank account.Type of `Payment Instrument`.CreatePaymentInstrumentCardType of `Payment Instrument`.CreatePaymentInstrumentRequestThe type of bank account.Type of `Payment Instrument`.The address of the bank account or card owner.CreatePaymentInstrumentTokenType of `Payment Instrument`.CreateProcessorRequestConfigCreateReversalRequestCreateSettlementRequestThe amount and currency of this `Subsciption Amount`.Subscription Schedule type.Specify the type of schedule: - **FIXED\\_TIME\\_INTERVAL**: Charges a Merchant on a fixed hourly interval.Specifies when the Fee is chargedSpecifies when the Fee is charged.Create a `transfer`.Name of the gateway that processed this `transfer`.Details how the card details were entered.Details the operation that'll be performed in the transaction.CreateVerificationRequestCreateWebhookRequestISO 4217 3 letter currency code.`Device` resource.Information used to configure how the `Device` handles transactions.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Merhcant` resource that was used in the request.A `Dispute` objected created for a chargeback or customer disputes.The system-defined reason for the `Dispute`.The current state of the `Dispute`.DisputeEvidenceResult of the evidence uploaded.For your convenience, every response includes several URLs which link to resources relevant to the request.DisputeEvidenceListDisputeEvidenceListEmbeddedDetails the page that's returned.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Transfers` realted to the `Dispute`.DisputesListDisputesListEmbeddedDownloadInstrumentUpdateQueryParamsDownloadInstrumentUpdatesQueryParamsError401UnauthorizedError401UnauthorizedEmbeddedError401UnauthorizedEmbeddedErrorsInnerGets or Sets codeError401UnauthorizedEmbeddedErrorsInnerLinksError402PaymentRequiredError402PaymentRequiredEmbeddedError402PaymentRequiredEmbeddedErrorsInnerGets or Sets codeGets or Sets messageError402PaymentRequiredEmbeddedErrorsInnerLinksError403ForbiddenListEmbeddedError403ForbiddenListEmbeddedErrorsInnerGets or Sets codeError404NotFoundListError404NotFoundListEmbeddedError404NotFoundListEmbeddedErrorsInnerGets or Sets codeError406NotAcceptableInvalid fieldError422InvalidFieldListEmbeddedError422InvalidFieldListEmbeddedErrorsInnerGets or Sets codeErrorGenericExternalLinkExternalLinksList`external_links` resources.An out of flow `fee` that is added to a `settlement`.Subtype of the `fee`.The type of `fee`.The type of entity the `fee` is linked (**null** by default).For your convenience, every response includes several URLs which link to resources relevant to the request.FeeProfileGets or Sets roundingModeFor your convenience, every response includes several URLs which link to resources relevant to the request.FeeProfilesListFeeProfilesListEmbeddedFeesListFeesListEmbeddedGets or Sets FeeTypeFilesListThe number of items to skip before starting to collect the result set.GetInstrumentUpdatesQueryParamsGetSubscriptionEnrollmentQueryParamsIdentitiesListList of `Identity` resources.Additional underwriting data that's required to verify the `Identity` of the `Merchant`.Include the value that best applies to the merchant's refund policy.The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.Merchant's distribution of credit card volume by business type.The underwriting details required to verify the `Identity` of the `Merchant`.Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.The primary address for the legal entity.The control owner's date of birth.Information needed to verify the identity of the entity.Include the value that applies the best.Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.Primary address for the legal entity.3-Letter Country code.Principal's date of birth.Date company was founded.The date the company was founded and registered with the US.The home address of the merchant's principal control owner.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Application` the request was made under.Link to any other `Identites` associated with the request.Link to the `Authorization` the request was made under.Link to the `Dispute` the request was made under.Link to the `Merchant` the request was made under.Link to the `Payment Instrume` the request was made under.Link to the resource that was used in the request.Link to the `Settlement` the request was made under.Link to the `Transfer` the request was made under.Link to the `Verification` the request was made under.InputDetailsInstrumentUpdateInstrumentUpdate1The status of the `instrument_updates` resource and update request.InstrumentUpdate1LinksInstrumentUpdateLinksInstrumentUpdatesListApplicationAuthorizationsQueryParamsListApplicationProfilesQueryParamsListApplicationsQueryParamsListAuthorizationsQueryParamsListBalanceTransfersQueryParamsListDisputeEvidenceQueryParamsListDisputesAdjustmentsQueryParamsListDisputesQueryParamsListExternalLinksQueryParamsListFeeProfilesQueryParamsListFeesQueryParamsListFilesQueryParamsListIdentitiesQueryParamsListIdentityAssociatedIdentitiesQueryParamsFor your convenience, every response includes several URLs which link to resources relevant to the request.Link to the first entry that was returned.Link to the previous page of entries that were returned.ListMerchantProfilesQueryParamsListMerchantsQueryParamsListMerchantVerificationsQueryParamsListPaymentInstrumentsQueryParamsListPaymentInstrumentUpdatesQueryParamsListSettlementFundingTransfersQueryParamsListSettlementsQueryParamsListSettlementTransfersQueryParamsListSubscriptionAmountQueryParamsListSubscriptionSchedulesQueryParamsListTransferReversalsQueryParamsListTransfersQueryParamsListUsersQueryParamsListVerificationsQueryParamsListWebhooksQueryParamsLogRefMerchantDetails the state of the `Merchant's` onboarding.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Application` the request was made under.Link to the `Identity` the request was made under.Link to the `merchant_profile` the request was made under.Link to the `Verification` that was used to verify the `Identity` that the request was made under.Link to the `Verification` that was used to verify the `Merchant` that the request was made under.Additional details specific to the processor.MerchantProfileFor your convenience, every response includes several URLs which link to resources relevant to the request.MerchantProfilesListMerchantProfilesListEmbeddedMerchantProfilesListEmbeddedMerchantProfilesInnerMerchantProfilesListEmbeddedMerchantProfilesInnerLinksMerchantsListList of `Merchant` objects.ModelFileNamePaymentInstrumentDetails what kind of **BANK_ACCOUNT** is being used.Additional address information that’s required to verify the identity of the merchant.The `brand` of the card saved in the `Payment Instrument`.The type of card saved in the `Payment Instrument`.The type of `Payment Instrument`.Gets or Sets payloadTypeDetails the results of the Card Verification Code check.Type of `Payment Instrument`.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Authorizations` created under the resource.Link to the `Transfers` created under the resource.PaymentInstrumentsListPaymentInstrumentsListEmbeddedPaymentInstrumentTokenGets or Sets instrumentTypeGets or Sets payloadTypeGets or Sets typeFor your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Verification` the request was made under.PaymentInstrumentUpdatesListPaymentInstrumentUpdatesListEmbeddedDetails that configure how the `Processor` handles transactions.Gets or Sets allowedBusinessApplicationIdsThe Merchant Category Code of the `Merchan.Identifies the level of security used in an electronic commerce transaction (only applies to card-present transactions).A 2-digit code that identifies the method used to enter the cardholder account number and card expiration date (only applies to card-present transactions).Contains a code identifying transaction conditions at the point of sale or point of service (only applies to card-present transactions).ProcessorApplicationConfigConfigurationTemplatesFor your convenience, every response includes several URLs which link to resources relevant to the request.ProcessorsListProcessorsListEmbeddedDetails that configure how the `Processor` handles transactions with the processor.The 3 letter ISO 4217 country code for the country transactions are originating from.Field used by processor to communicate with Finix.Specific code that reflects the use case (e.g.ProcessorSystemConfigConfigurationTemplatesRemoveSettlementTransferReserveProfileReserveProfilesListReserveProfilesListEmbeddedReserveProfilesListEmbeddedReserveProfilesInnerReserveProfilesListEmbeddedReserveProfilesInnerLinksGets or Sets entityTypeGets or Sets outcomeGets or Sets processorTypeGets or Sets reviewTypeFor your convenience, every response includes several URLs which link to resources relevant to the request.ReviewQueueItemsListReviewQueueItemsListEmbeddedReviewQueueItemsListEmbeddedReviewQueueItemsInnerGets or Sets entityTypeGets or Sets outcomeGets or Sets processorTypeGets or Sets reviewTypeReviewQueueItemsListEmbeddedReviewQueueItemsInnerLinksRiskProfileFor your convenience, every response includes several URLs which link to resources relevant to the request.RiskProfileRuleRiskProfileRulesListRiskProfileRulesListEmbeddedRiskProfileRulesListEmbeddedRiskProfileRulesInnerRiskProfileRulesListEmbeddedRiskProfileRulesInnerLinksRiskProfilesListRiskProfilesListEmbeddedRootFor your convenience, every response includes several URLs which link to resources relevant to the request.The status of the `Settlement`.Type of `Settlement`.SettlementEngineSettlementGets or Sets scheduleTypeGets or Sets statusSettlementEngineSettlementLinksSettlementEngineSettlementsListSettlementEngineSettlementsListEmbeddedSettlementEngineSettlementsListEmbeddedSettlementsInnerGets or Sets scheduleTypeGets or Sets statusFor your convenience, every response includes several URLs which link to resources relevant to the request.SettlementsListEmbedded`Subscription Amount` type.The amount and currency of this `Subsciption Amount`.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `subscription_schedules` realted to the request.SubscriptionAmountListSubscriptionAmountListEmbeddedFor your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `subscription_amounts` used in the request.Link to the `Merhcant` resource that was used in the request.Link to the `subscription_schedules` used in the request.SubscriptionEnrollmentListSubscriptionEnrollmentListEmbedded`Subscription Schedule` type.`Subscription Schedule` type.Specifies when the `Fee` is charged.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `subscription_amounts` related to the request.Specifies when the `Fee` is charged.`Subscription Schedule` resource.SubscriptionSchedulesListEmbeddedFor your convenience, every response includes several URLs which link to resources relevant to the request.The stauts of the `Transfer`.Additional information describing the `payment_type`.Type of `Transfer`.For your convenience, every response includes several URLs which link to resources relevant to the request.Link to the `Payment Instrument` where funds are getting sent.Link to the `Dispute` the request was made under.Link to the `fee_profile` the request was made under.Link to the `fees` the request is associated with.Link to the `Payment Instrument` associated with the Transfer.Link to the `reversals` associated with the `Transfer`.Link to the `Payment Instrument` the `Transfer` was created under.TransferReversalsListTransferReversalsListEmbeddedTransfersListEmbeddedUpdateApplicationProfileRequestUpdateAuthorizationRequestUpdateIdentityRequestAdditional underwriting data that's required to verify the identity of the merchant.Include the value that best applies to the merchant's refund policy.The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.Merchant's distribution of credit card volume by business type.Underwriting data that's required to verify the identity of the merchant.Include the value that best applies to the merchant.The primary address for the legal entity.The control owner's date of birth.UpdateMerchantRequestThe type of bank account.Type of `Payment Instrument`.UpdateSettlementRequestThe ID of the `Subscription Amount`.ID of the `subscription_enrollment`.UpdateSubscriptionScheduleRequestUpdateTransferRequestUpdateUserRequestUpdateWebhookRequestUploadFileRequestUserDetails the level of access the [`User`](#tag/Users) has available.For your convenience, every response includes several URLs which link to resources relevant to the request.UsersListUsersListEmbeddedVerificationThe status of the `Verification` request.VerificationsListList of `Verifications`.Webhook`Webhook` resource.WebhooksListEmbedded