All Classes and Interfaces
Class
Description
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
The additional information about the purchase.
AdditionalPurchaseDataItemDataInner
AdditionalPurchaseDataOrderDate
Principal's personal home address.
AdjustmentTransfersList
AdjustmentTransfersListEmbedded
Callback for asynchronous API call.
ApiException class.
API response returned by API call.
ApplePaySession
ApplePaySessionRequest
Application
For your convenience, every response includes several URLs which link to resources relevant to the request.
ApplicationLinksApplicationProfile
Link to the resource that was used in the request.
ApplicationProfile
For your convenience, every response includes several URLs which link to resources relevant to the request.
Link to the `Application` the resource was created under.
ApplicationProfilesList
ApplicationProfilesListEmbedded
For your convenience, every response includes several URLs which link to resources relevant to the request.
ApplicationsListEmbedded
A charge authorization
The state of the `Authorization`.
AuthorizationExternalResponsesInner
For 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`.
AuthorizationsList
AuthorizationsListEmbedded
A `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 availableAccountType
The type of `Payment Instrument`.
Configure the details of the activated device.
ConfigurationDetailsCashbackOptions
ConfigurationDetailsCashbackOptionsManualEntry
ConfigurationDetailsTipOptions
The sender’s country.
CreateApplicationRequest
Create 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.
CreateDisputeEvidenceRequest
CreateExternalLinkRequest
<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.
CreateFeeProfileRequest
Gets or Sets roundingMode
CreateFeeRequest
Subtype of the fee.
The type of entity the fee is linked to (**null** by default).
CreateFileRequest
The 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.
CreateInstrumentUpdateRequest
CreateInstrumentUpdatesRequest
CreateMerchantUnderwritingRequest
Name of the gateway that processes the `Merchant's` transaction.
CreatePaymentInstrumentBankAccount
The type of bank account.
Type of `Payment Instrument`.
CreatePaymentInstrumentCard
Type of `Payment Instrument`.
CreatePaymentInstrumentRequest
The type of bank account.
Type of `Payment Instrument`.
The address of the bank account or card owner.
CreatePaymentInstrumentToken
Type of `Payment Instrument`.
CreateProcessorRequestConfig
CreateReversalRequest
CreateSettlementRequest
The 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 charged
Specifies 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.
CreateVerificationRequest
CreateWebhookRequest
ISO 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`.
DisputeEvidence
Result of the evidence uploaded.
For your convenience, every response includes several URLs which link to resources relevant to the request.
DisputeEvidenceList
DisputeEvidenceListEmbedded
Details 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`.
DisputesList
DisputesListEmbedded
DownloadInstrumentUpdateQueryParams
DownloadInstrumentUpdatesQueryParams
Error401Unauthorized
Error401UnauthorizedEmbedded
Error401UnauthorizedEmbeddedErrorsInner
Gets or Sets code
Error401UnauthorizedEmbeddedErrorsInnerLinks
Error402PaymentRequired
Error402PaymentRequiredEmbedded
Error402PaymentRequiredEmbeddedErrorsInner
Gets or Sets code
Gets or Sets message
Error402PaymentRequiredEmbeddedErrorsInnerLinks
Error403ForbiddenListEmbedded
Error403ForbiddenListEmbeddedErrorsInner
Gets or Sets code
Error404NotFoundList
Error404NotFoundListEmbedded
Error404NotFoundListEmbeddedErrorsInner
Gets or Sets code
Error406NotAcceptable
Invalid field
Error422InvalidFieldListEmbedded
Error422InvalidFieldListEmbeddedErrorsInner
Gets or Sets code
ErrorGeneric
ExternalLink
ExternalLinksList
`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.
FeeProfile
Gets or Sets roundingMode
For your convenience, every response includes several URLs which link to resources relevant to the request.
FeeProfilesList
FeeProfilesListEmbedded
FeesList
FeesListEmbedded
Gets or Sets FeeType
FilesList
The number of items to skip before starting to collect the result set.
FinixClient class.
GetInstrumentUpdatesQueryParams
GetSubscriptionEnrollmentQueryParams
IdentitiesList
List 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.
InputDetails
InstrumentUpdate
InstrumentUpdate1
The status of the `instrument_updates` resource and update request.
InstrumentUpdate1Links
InstrumentUpdateLinks
InstrumentUpdates
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, ISO8601Utils will be used.
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
ListApplicationAuthorizationsQueryParams
ListApplicationProfilesQueryParams
ListApplicationsQueryParams
ListAuthorizationsQueryParams
ListBalanceTransfersQueryParams
ListDisputeEvidenceQueryParams
ListDisputesAdjustmentsQueryParams
ListDisputesQueryParams
ListExternalLinksQueryParams
ListFeeProfilesQueryParams
ListFeesQueryParams
ListFilesQueryParams
ListIdentitiesQueryParams
ListIdentityAssociatedIdentitiesQueryParams
For 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.
ListMerchantProfilesQueryParams
ListMerchantsQueryParams
ListMerchantVerificationsQueryParams
ListPaymentInstrumentsQueryParams
ListPaymentInstrumentUpdatesQueryParams
ListSettlementFundingTransfersQueryParams
ListSettlementsQueryParams
ListSettlementTransfersQueryParams
ListSubscriptionAmountQueryParams
ListSubscriptionSchedulesQueryParams
ListTransferReversalsQueryParams
ListTransfersQueryParams
ListUsersQueryParams
ListVerificationsQueryParams
ListWebhooksQueryParams
LogRef
Merchant
Details 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.
MerchantProfile
For your convenience, every response includes several URLs which link to resources relevant to the request.
MerchantProfilesList
MerchantProfilesListEmbedded
MerchantProfilesListEmbeddedMerchantProfilesInner
MerchantProfilesListEmbeddedMerchantProfilesInnerLinks
MerchantsList
List of `Merchant` objects.
ModelFile
Name
PaymentInstrument
Details 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 payloadType
Details 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.
PaymentInstrumentsList
PaymentInstrumentsListEmbedded
PaymentInstrumentToken
Gets or Sets instrumentType
Gets or Sets payloadType
Gets or Sets type
For your convenience, every response includes several URLs which link to resources relevant to the request.
Link to the `Verification` the request was made under.
PaymentInstrumentUpdatesList
PaymentInstrumentUpdatesListEmbedded
Details that configure how the `Processor` handles transactions.
Gets or Sets allowedBusinessApplicationIds
The 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).
ProcessorApplicationConfigConfigurationTemplates
For your convenience, every response includes several URLs which link to resources relevant to the request.
ProcessorsList
ProcessorsListEmbedded
Details 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.
ProcessorSystemConfigConfigurationTemplates
RemoveSettlementTransfer
ReserveProfile
ReserveProfilesList
ReserveProfilesListEmbedded
ReserveProfilesListEmbeddedReserveProfilesInner
ReserveProfilesListEmbeddedReserveProfilesInnerLinks
Gets or Sets entityType
Gets or Sets outcome
Gets or Sets processorType
Gets or Sets reviewType
For your convenience, every response includes several URLs which link to resources relevant to the request.
ReviewQueueItemsList
ReviewQueueItemsListEmbedded
ReviewQueueItemsListEmbeddedReviewQueueItemsInner
Gets or Sets entityType
Gets or Sets outcome
Gets or Sets processorType
Gets or Sets reviewType
ReviewQueueItemsListEmbeddedReviewQueueItemsInnerLinks
RiskProfile
For your convenience, every response includes several URLs which link to resources relevant to the request.
RiskProfileRule
RiskProfileRulesList
RiskProfileRulesListEmbedded
RiskProfileRulesListEmbeddedRiskProfileRulesInner
RiskProfileRulesListEmbeddedRiskProfileRulesInnerLinks
RiskProfilesList
RiskProfilesListEmbedded
Root
For your convenience, every response includes several URLs which link to resources relevant to the request.
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
The status of the `Settlement`.
Type of `Settlement`.
SettlementEngineSettlement
Gets or Sets scheduleType
Gets or Sets status
SettlementEngineSettlementLinks
SettlementEngineSettlementsList
SettlementEngineSettlementsListEmbedded
SettlementEngineSettlementsListEmbeddedSettlementsInner
Gets or Sets scheduleType
Gets or Sets status
For 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.
SubscriptionAmountList
SubscriptionAmountListEmbedded
For 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.
SubscriptionEnrollmentList
SubscriptionEnrollmentListEmbedded
`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.
SubscriptionSchedulesListEmbedded
For 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.
TransferReversalsList
TransferReversalsListEmbedded
TransfersListEmbedded
UpdateApplicationProfileRequest
UpdateAuthorizationRequest
UpdateIdentityRequest
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.
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.
UpdateMerchantRequest
The type of bank account.
Type of `Payment Instrument`.
UpdateSettlementRequest
The ID of the `Subscription Amount`.
ID of the `subscription_enrollment`.
UpdateSubscriptionScheduleRequest
UpdateTransferRequest
UpdateUserRequest
UpdateWebhookRequest
UploadFileRequest
User
Details 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.
UsersList
UsersListEmbedded
Verification
The status of the `Verification` request.
VerificationsList
List of `Verifications`.
Webhook
`Webhook` resource.
WebhooksListEmbedded