ApiResponse<AuthorizationCaptured> |
AuthorizationsApi.captureAuthorizationWithHttpInfo(String authorizationId,
UpdateAuthorizationRequest updateAuthorizationRequest) |
Capture an Authorization
If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds.
|
ApiResponse<ApplePaySession> |
PaymentInstrumentsApi.createApplePaySessionWithHttpInfo(ApplePaySessionRequest applePaySessionRequest) |
Create an Apple Pay Session
Create an `apple_pay_session` to process Apple Pay transactions on the web.
|
ApiResponse<Identity> |
IdentitiesApi.createAssociatedIdentityWithHttpInfo(String identityId,
CreateAssociatedIdentityRequest createAssociatedIdentityRequest) |
Create an Associated Identity
Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant.
|
ApiResponse<Authorization> |
AuthorizationsApi.createAuthorizationWithHttpInfo(CreateAuthorizationRequest createAuthorizationRequest) |
Create an Authorization
Create an `Authorization` to process a transaction.
|
ApiResponse<BalanceTransfer> |
BalanceTransfersApi.createBalanceTransferWithHttpInfo(CreateBalanceTransferRequest createBalanceTransferRequest) |
Create a Balance Transfer
Create a `balance_transfer`.
|
ApiResponse<DisputeEvidence> |
DisputesApi.createDisputeEvidenceWithHttpInfo(String disputeId,
CreateDisputeEvidenceRequest createDisputeEvidenceRequest) |
Upload Dispute Evidence
Upload dispute evidence for a `Dispute`.
|
ApiResponse<ExternalLink> |
FilesApi.createExternalLinkWithHttpInfo(String fileId,
CreateExternalLinkRequest createExternalLinkRequest) |
Create an External Link
Create an `external_link` resource to share with users so they can upload files directly from their browser.
|
ApiResponse<FeeProfile> |
FeeProfilesApi.createFeeProfileWithHttpInfo(CreateFeeProfileRequest createFeeProfileRequest) |
Create a Fee Profile
Create a `fee_profile`.
|
ApiResponse<ModelFile> |
FilesApi.createFilesWithHttpInfo(CreateFileRequest createFileRequest) |
Create a File
Before uploading a file, you need to create a `File` resource.
|
ApiResponse<Settlement> |
SettlementsApi.createIdentitySettlementWithHttpInfo(String identityId,
CreateSettlementRequest createSettlementRequest) |
Close Current Active Settlement
Close the currently accruing `settlement`.
|
ApiResponse<Verification> |
IdentitiesApi.createIdentityVerificationWithHttpInfo(String identityId,
CreateVerificationRequest createVerificationRequest) |
Verify an Identity
Verify an `Identity`.
|
ApiResponse<Identity> |
IdentitiesApi.createIdentityWithHttpInfo(CreateIdentityRequest createIdentityRequest) |
Create an Identity
Create an `Identity` for your merchant or buyer.
|
ApiResponse<Device> |
DevicesApi.createMerchantDeviceWithHttpInfo(String merchantId,
CreateDevice createDevice) |
Create a Device
Create a `Device` under a `Merchant`.
|
ApiResponse<Verification> |
MerchantsApi.createMerchantVerificationWithHttpInfo(String merchantId,
CreateVerificationRequest createVerificationRequest) |
Verify a Merchant
If the `onboarding_state` for a `Merchant` returns **FAILED**, correct the `Identity` information saved for the `Merchant`.
|
ApiResponse<Merchant> |
MerchantsApi.createMerchantWithHttpInfo(String identityId,
CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest) |
Create a Merchant
Create a `Merchant` to start the underwriting (also called provisioning) process for your merchant.
|
ApiResponse<OnboardingFormLink> |
OnboardingFormsApi.createOnboardingFormLinkWithHttpInfo(String onboardingFormId,
CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest) |
Create an Onboarding Form Link
You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.
|
ApiResponse<OnboardingForm> |
OnboardingFormsApi.createOnboardingFormWithHttpInfo(CreateOnboardingFormRequest createOnboardingFormRequest) |
Create an Onboarding Form
Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form.
|
ApiResponse<InstrumentUpdate> |
InstrumentUpdatesApi.createPaymentInstrumentUpdateWithHttpInfo(CreateInstrumentUpdateRequest createInstrumentUpdateRequest) |
Create Instrument Updates
To update the card details of your customers, create an `instrument_updates` resource.
|
ApiResponse<PaymentInstrument> |
PaymentInstrumentsApi.createPaymentInstrumentWithHttpInfo(CreatePaymentInstrumentRequest createPaymentInstrumentRequest) |
Create a Payment Instrument
Create a `Payment Instrument` resource using a card or bank account.
|
ApiResponse<Transfer> |
TransfersApi.createTransferReversalWithHttpInfo(String transferId,
CreateReversalRequest createReversalRequest) |
Refund or Reverse a Transfer
Reverse a transfer with a `type` of **DEBIT**.
|
ApiResponse<Transfer> |
TransfersApi.createTransferWithHttpInfo(CreateTransferRequest createTransferRequest) |
Create a Transfer
Create a `Transfer`.
|
ApiResponse<Verification> |
VerificationsApi.createVerificationWithHttpInfo(CreateVerificationRequest createVerificationRequest) |
Create a Merchant Verification
Create a `Verification` to verify a merchant's `Identity`.
|
ApiResponse<Webhook> |
WebhooksApi.createWebhookWithHttpInfo(CreateWebhookRequest createWebhookRequest) |
Create a Webhook
Create a `Webhook` to specify an endpoint where Finix can send events.
|
ApiResponse<File> |
FilesApi.downloadFileWithHttpInfo(String fileId) |
Download a file
Download a file that was uploaded to a `File` resource.
|
ApiResponse<AuthorizationsList> |
AuthorizationsApi.APIlistAuthorizationsRequest.executeWithHttpInfo() |
Execute listAuthorizations request with HTTP info returned
|
ApiResponse<BalanceTransferList> |
BalanceTransfersApi.APIlistBalanceTransfersRequest.executeWithHttpInfo() |
Execute listBalanceTransfers request with HTTP info returned
|
ApiResponse<Device> |
DevicesApi.APIgetDeviceRequest.executeWithHttpInfo() |
Execute getDevice request with HTTP info returned
|
ApiResponse<DisputeEvidenceList> |
DisputesApi.APIlistDisputeEvidenceRequest.executeWithHttpInfo() |
Execute listDisputeEvidence request with HTTP info returned
|
ApiResponse<AdjustmentTransfersList> |
DisputesApi.APIlistDisputesAdjustmentsRequest.executeWithHttpInfo() |
Execute listDisputesAdjustments request with HTTP info returned
|
ApiResponse<DisputesList> |
DisputesApi.APIlistDisputesRequest.executeWithHttpInfo() |
Execute listDisputes request with HTTP info returned
|
ApiResponse<FeeProfilesList> |
FeeProfilesApi.APIlistFeeProfilesRequest.executeWithHttpInfo() |
Execute listFeeProfiles request with HTTP info returned
|
ApiResponse<ExternalLinksList> |
FilesApi.APIlistExternalLinksRequest.executeWithHttpInfo() |
Execute listExternalLinks request with HTTP info returned
|
ApiResponse<FilesList> |
FilesApi.APIlistFilesRequest.executeWithHttpInfo() |
Execute listFiles request with HTTP info returned
|
ApiResponse<IdentitiesList> |
IdentitiesApi.APIlistIdentitiesRequest.executeWithHttpInfo() |
Execute listIdentities request with HTTP info returned
|
ApiResponse<IdentitiesList> |
IdentitiesApi.APIlistIdentityAssociatedIdentitiesRequest.executeWithHttpInfo() |
Execute listIdentityAssociatedIdentities request with HTTP info returned
|
ApiResponse<File> |
InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest.executeWithHttpInfo() |
Execute downloadInstrumentUpdate request with HTTP info returned
|
ApiResponse<MerchantProfilesList> |
MerchantProfilesApi.APIlistMerchantProfilesRequest.executeWithHttpInfo() |
Execute listMerchantProfiles request with HTTP info returned
|
ApiResponse<MerchantsList> |
MerchantsApi.APIlistMerchantsRequest.executeWithHttpInfo() |
Execute listMerchants request with HTTP info returned
|
ApiResponse<PaymentInstrumentsList> |
PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest.executeWithHttpInfo() |
Execute listPaymentInstruments request with HTTP info returned
|
ApiResponse<PaymentInstrumentUpdatesList> |
PaymentInstrumentsApi.APIlistPaymentInstrumentUpdatesRequest.executeWithHttpInfo() |
Execute listPaymentInstrumentUpdates request with HTTP info returned
|
ApiResponse<TransfersList> |
SettlementsApi.APIlistSettlementFundingTransfersRequest.executeWithHttpInfo() |
Execute listSettlementFundingTransfers request with HTTP info returned
|
ApiResponse<SettlementsList> |
SettlementsApi.APIlistSettlementsRequest.executeWithHttpInfo() |
Execute listSettlements request with HTTP info returned
|
ApiResponse<TransfersList> |
SettlementsApi.APIlistSettlementTransfersRequest.executeWithHttpInfo() |
Execute listSettlementTransfers request with HTTP info returned
|
ApiResponse<TransfersList> |
TransfersApi.APIlistTransferReversalsRequest.executeWithHttpInfo() |
Execute listTransferReversals request with HTTP info returned
|
ApiResponse<TransfersList> |
TransfersApi.APIlistTransfersRequest.executeWithHttpInfo() |
Execute listTransfers request with HTTP info returned
|
ApiResponse<VerificationsList> |
VerificationsApi.APIlistMerchantVerificationsRequest.executeWithHttpInfo() |
Execute listMerchantVerifications request with HTTP info returned
|
ApiResponse<VerificationsList> |
VerificationsApi.APIlistPaymentInstrumentVerificationsRequest.executeWithHttpInfo() |
Execute listPaymentInstrumentVerifications request with HTTP info returned
|
ApiResponse<VerificationsList> |
VerificationsApi.APIlistVerificationsRequest.executeWithHttpInfo() |
Execute listVerifications request with HTTP info returned
|
ApiResponse<WebhooksList> |
WebhooksApi.APIlistWebhooksRequest.executeWithHttpInfo() |
Execute listWebhooks request with HTTP info returned
|
ApiResponse<Authorization> |
AuthorizationsApi.getAuthorizationWithHttpInfo(String authorizationId) |
Fetch an Authorization
Retrieve the details of a previously created `Authorization`.
|
ApiResponse<BalanceTransfer> |
BalanceTransfersApi.getBalanceTransfersWithHttpInfo(String balanceTransfersId) |
Fetch a Balance Transfer
Retrieve the details of a `balance_transfer`.
|
ApiResponse<ComplianceForm> |
ComplianceFormsApi.getComplianceFormsWithHttpInfo(String complianceFormsId) |
View Compliance Forms
A webhook notifies you when Finix creates a `compliance_form`.
|
ApiResponse<DisputeEvidence> |
DisputesApi.getDisputeEvidenceWithHttpInfo(String disputeId,
String evidenceId) |
Fetch Dispute Evidence
Fetch evidence uploaded for a `Dispute`.
|
ApiResponse<Dispute> |
DisputesApi.getDisputeWithHttpInfo(String disputeId) |
Fetch a Dispute
Retrieve the details of a previously created `Dispute`.
|
ApiResponse<ExternalLink> |
FilesApi.getExternalLinkWithHttpInfo(String fileId,
String externalLinkId) |
Fetch an External LInk
Fetch a previously created `external_link` resource.
|
ApiResponse<FeeProfile> |
FeeProfilesApi.getFeeProfileWithHttpInfo(String feeProfileId) |
Fetch a Fee Profile
Get a `fee_profile`.
|
ApiResponse<ModelFile> |
FilesApi.getFileWithHttpInfo(String fileId) |
Fetch a File
Retrieve the details of a `File` resource.
|
ApiResponse<Identity> |
IdentitiesApi.getIdentityWithHttpInfo(String identityId) |
Fetch an Identity
Retrieve the details of a previously created `Identity`.
|
ApiResponse<InstrumentUpdate> |
InstrumentUpdatesApi.getInstrumentUpdateWithHttpInfo(String instrumentUpdatesId) |
Fetch an Instrument Update
Fetch a specific `instrument_update` from an `instrument_updates` resource.
|
ApiResponse<MerchantProfile> |
MerchantProfilesApi.getMerchantProfileWithHttpInfo(String merchantProfileId) |
Fetch a Merchant Profile
Retrieve the details of a previosuly created `merchant_profile`.
|
ApiResponse<Merchant> |
MerchantsApi.getMerchantWithHttpInfo(String merchantId) |
Fetch a Merchant
Retrieve the details of a `Merchant`.
|
ApiResponse<OnboardingForm> |
DefaultApi.getOnboardingFormWithHttpInfo(String onboardingFormId) |
Fetch an Onboarding Form
Retrieve the details of an `onboarding_form`.
|
ApiResponse<OnboardingForm> |
OnboardingFormsApi.getOnboardingFormWithHttpInfo(String onboardingFormId) |
Fetch an Onboarding Form
Retrieve the details of an `onboarding_form`.
|
ApiResponse<PaymentInstrument> |
PaymentInstrumentsApi.getPaymentInstrumentWithHttpInfo(String paymentInstrumentId) |
Fetch a Payment Instrument
Retrieve the details of a `Payment Instrument`.
|
ApiResponse<Settlement> |
SettlementsApi.getSettlementWithHttpInfo(String settlementId) |
Fetch a Settlement
Retreive the details of a `Settlement`.
|
ApiResponse<Transfer> |
TransfersApi.getTransferWithHttpInfo(String transferId) |
Fetch a Transfer
Retrieve a `Transfer`.
|
ApiResponse<Verification> |
VerificationsApi.getVerificationWithHttpInfo(String verificationId) |
Fetch a Verification
Retrieve the details of a `Verification`.
|
ApiResponse<Webhook> |
WebhooksApi.getWebhookWithHttpInfo(String webhookId) |
Fetch a Webhook
Retrieve the details of a `Webhook`.
|
ApiResponse<Void> |
SettlementsApi.removeSettlementTransfersWithHttpInfo(String settlementId,
RemoveSettlementTransfer removeSettlementTransfer) |
Delete Settlement Transfers
Remove a `Transfer` that makes up a `Settlement`.
|
ApiResponse<ComplianceForm> |
ComplianceFormsApi.updateComplianceFormsWithHttpInfo(String complianceFormsId,
UpdateComplianceFormRequest updateComplianceFormRequest) |
Complete Compliance Forms
As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested.
|
ApiResponse<Device> |
DevicesApi.updateDeviceWithHttpInfo(String deviceId,
UpdateDeviceRequest updateDeviceRequest) |
Initiate Action on Device
Initiate an action on a `Device`.
|
ApiResponse<Identity> |
IdentitiesApi.updateIdentityWithHttpInfo(String identityId,
UpdateIdentityRequest updateIdentityRequest) |
Update an Identity
Update an existing `Identity`.
|
ApiResponse<MerchantProfile> |
MerchantProfilesApi.updateMerchantProfileWithHttpInfo(String merchantProfileId,
UpdateMerchantProfileRequest updateMerchantProfileRequest) |
Update a Merchant Profile
Update a `merchant_profile`.
|
ApiResponse<Merchant> |
MerchantsApi.updateMerchantWithHttpInfo(String merchantId,
UpdateMerchantRequest updateMerchantRequest) |
Update a Merchant
Update a `Merchant` to: - Change the `Identity` information saved with the underlying processor - Enable Level 2/3 processing - Enable [Buyer Chages](/guides/payments/buyer-charges/)
|
ApiResponse<PaymentInstrument> |
PaymentInstrumentsApi.updatePaymentInstrumentWithHttpInfo(String paymentInstrumentId,
UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest) |
Update a Payment Instrument
Update a `Payment Instrument`.
|
ApiResponse<Transfer> |
TransfersApi.updateTransferWithHttpInfo(String transferId,
UpdateTransferRequest updateTransferRequest) |
Update a Transfer
Update a `Transfer`.
|
ApiResponse<Webhook> |
WebhooksApi.updateWebhookWithHttpInfo(String webhookId,
UpdateWebhookRequest updateWebhookRequest) |
Update a Webhook
Update an existing `Webhook`.
|
ApiResponse<ModelFile> |
FilesApi.uploadFileWithHttpInfo(String fileId,
UploadFileRequest uploadFileRequest) |
Upload files Directly
Upload files directly with a `multipart/form-data` request.
|