```
public class GiniBank

                    
```
Api for interacting with Capture and Payment features.
The Capture feature is a layer of abstraction above Gini Capture SDK and the Return Assistant feature. Capture feature can be used with:
- the Screen API by calling startCaptureFlow or startCaptureFlowForIntent.
To use capture features, they need to be configured with setCaptureConfiguration.
To use the pay feature, first setGiniApi needs to be called. The flow for this feature would be:
- getRequestId to extract the id from the Intent
- getPaymentRequest to get payment details set by the business app.
- resolvePaymentRequest to mark the PaymentRequest as paid.
- returnToPaymentInitiatorApp to return to the app that started the flow.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GiniBank.CreateCaptureFlowFragmentForIntentResult`
`public final class`	`GiniBank.Internal`

Field Summary

Fields
Modifier and Type	Field	Description
`private DigitalInvoiceOnboardingNavigationBarBottomAdapter`	`digitalInvoiceOnboardingNavigationBarBottomAdapter`
`private DigitalInvoiceHelpNavigationBarBottomAdapter`	`digitalInvoiceHelpNavigationBarBottomAdapter`
`private OnboardingIllustrationAdapter`	`digitalInvoiceOnboardingIllustrationAdapter`
`private DigitalInvoiceNavigationBarBottomAdapter`	`digitalInvoiceNavigationBarBottomAdapter`
`private Boolean`	`enableReturnReasons`
`public final static GiniBank`	`INSTANCE`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`setCaptureConfiguration(CaptureConfiguration captureConfiguration)`	Sets configuration for Capture feature.
`final Unit`	`setCaptureConfiguration(Context context, CaptureConfiguration captureConfiguration)`	Sets configuration for Capture feature.
`final Unit`	`sendTransferSummary(String paymentRecipient, String paymentReference, String paymentPurpose, String iban, String bic, Amount amount)`	Provides transfer summary to Gini.
`final Unit`	`releaseCapture(Context context, String paymentRecipient, String paymentReference, String paymentPurpose, String iban, String bic, Amount amount)`	Frees up resources used by the capture flow.
`final Unit`	`releaseCapture(Context context)`	Frees up resources used by the capture flow.
`final RequirementsReport`	`checkCaptureRequirements(Context context)`	Checks hardware requirements for Capture feature.
`final Unit`	`startCaptureFlow(ActivityResultLauncher<Unit> resultLauncher)`	Screen API for starting the capture flow.
`final CaptureFlowFragment`	`createCaptureFlowFragment()`
`final CancellationToken`	`createCaptureFlowFragmentForIntent(Context context, Intent intent, Function1<GiniBank.CreateCaptureFlowFragmentForIntentResult, Unit> callback)`
`final CancellationToken`	`startCaptureFlowForIntent(ActivityResultLauncher<CaptureImportInput> resultLauncher, Context context, Intent intent)`	Screen API for starting the capture flow when a pdf or image document was shared from another app.
`final Unit`	`setGiniApi(GiniBankAPI giniApi)`	Set the GiniBankAPI instance to be used for the Pay feature.
`final Unit`	`releaseGiniApi()`	Clears the reference to giniApi set by setGiniApi.
`final PaymentRequest`	`getPaymentRequest(String id)`	Get the payment details for the request created by a business.
`final ResolvedPayment`	`resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)`	Marks the a PaymentRequest as paid.
`final Unit`	`returnToPaymentInitiatorApp(Context context, ResolvedPayment resolvedPayment)`	Starts the app that started the payment flow.
`final DigitalInvoiceOnboardingNavigationBarBottomAdapter`	`getDigitalInvoiceOnboardingNavigationBarBottomAdapter()`
`final Unit`	`setDigitalInvoiceOnboardingNavigationBarBottomAdapter(DigitalInvoiceOnboardingNavigationBarBottomAdapter digitalInvoiceOnboardingNavigationBarBottomAdapter)`
`final DigitalInvoiceHelpNavigationBarBottomAdapter`	`getDigitalInvoiceHelpNavigationBarBottomAdapter()`
`final Unit`	`setDigitalInvoiceHelpNavigationBarBottomAdapter(DigitalInvoiceHelpNavigationBarBottomAdapter digitalInvoiceHelpNavigationBarBottomAdapter)`
`final OnboardingIllustrationAdapter`	`getDigitalInvoiceOnboardingIllustrationAdapter()`
`final Unit`	`setDigitalInvoiceOnboardingIllustrationAdapter(OnboardingIllustrationAdapter digitalInvoiceOnboardingIllustrationAdapter)`
`final DigitalInvoiceNavigationBarBottomAdapter`	`getDigitalInvoiceNavigationBarBottomAdapter()`
`final Unit`	`setDigitalInvoiceNavigationBarBottomAdapter(DigitalInvoiceNavigationBarBottomAdapter digitalInvoiceNavigationBarBottomAdapter)`
`final Boolean`	`getEnableReturnReasons()`	Shows the return reasons dialog in the return assistant, if enabled.
`final Unit`	`setEnableReturnReasons(Boolean enableReturnReasons)`	Shows the return reasons dialog in the return assistant, if enabled.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setCaptureConfiguration
```
@Deprecated(message = Please use setCaptureConfiguration(context, captureConfiguration) which allows instance recreation without having to call releaseCapture(), replaceWith = @ReplaceWith(imports = {}, expression = setCaptureConfiguration(context, captureConfiguration))) final Unit setCaptureConfiguration(CaptureConfiguration captureConfiguration)
```
    Sets configuration for Capture feature. Note that configuration is immutable. releaseCapture needs to be called before passing a new configuration.
  - setCaptureConfiguration
```
 final Unit setCaptureConfiguration(Context context, CaptureConfiguration captureConfiguration)
```
    Sets configuration for Capture feature.
  - sendTransferSummary
```
 final Unit sendTransferSummary(String paymentRecipient, String paymentReference, String paymentPurpose, String iban, String bic, Amount amount)
```
    Provides transfer summary to Gini.
    Please provide the required transfer summary to improve the future extraction accuracy.
    Follow the recommendations below:
    Make sure to call this method before calling releaseCapture if the user has completed TAN verification.
    Provide values for all necessary fields, including those that were not extracted.
    Provide the final data approved by the user (and not the initially extracted only).
    Send the transfer summary after TAN verification and provide the extraction values the user has used.
    Parameters:
    
    paymentRecipient - payment receiver
    
    paymentReference - ID based on Client ID (Kundennummer) and invoice ID (Rechnungsnummer)
    
    paymentPurpose - statement what this payment is for
    
    iban - international bank account
    
    bic - bank identification code
    
    amount - accepts extracted amount and currency
  - releaseCapture
```
@Deprecated(message = Please use sendTransferSummary() to provide the required transfer summary first (if the user has completed TAN verification) and then releaseCapture() to let the SDK free up used resources., replaceWith = @ReplaceWith(imports = {}, expression = releaseCapture(context))) final Unit releaseCapture(Context context, String paymentRecipient, String paymentReference, String paymentPurpose, String iban, String bic, Amount amount)
```
    Frees up resources used by the capture flow.
    Please provide the required transfer summary to improve the future extraction accuracy. Follow the recommendations below:
    Provide values for all necessary fields, including those that were not extracted.</li>
    Provide the final data approved by the user (and not the initially extracted only).</li>
    Do cleanup after TAN verification.to clean up and provide the extraction values the user has used.</li>
    Parameters:
    
    context - Android context
    
    paymentRecipient - payment receiver
    
    paymentReference - ID based on Client ID (Kundennummer) and invoice ID (Rechnungsnummer)
    
    paymentPurpose - statement what this payment is for
    
    iban - international bank account
    
    bic - bank identification code
    
    amount - accepts extracted amount and currency
  - releaseCapture
```
 final Unit releaseCapture(Context context)
```
    Frees up resources used by the capture flow.
    
    Parameters:
    
    context - Android context
  - checkCaptureRequirements
```
@Deprecated(message = Checking the requirements is no longer necessary and this method will be removed in a future release.) final RequirementsReport checkCaptureRequirements(Context context)
```
    Checks hardware requirements for Capture feature. Requirements are not enforced, but are recommended to be checked before using.
  - startCaptureFlow
```
 final Unit startCaptureFlow(ActivityResultLauncher<Unit> resultLauncher)
```
    Screen API for starting the capture flow.
  - createCaptureFlowFragment
```
 final CaptureFlowFragment createCaptureFlowFragment()
```
  - createCaptureFlowFragmentForIntent
```
 final CancellationToken createCaptureFlowFragmentForIntent(Context context, Intent intent, Function1<GiniBank.CreateCaptureFlowFragmentForIntentResult, Unit> callback)
```
  - startCaptureFlowForIntent
```
 final CancellationToken startCaptureFlowForIntent(ActivityResultLauncher<CaptureImportInput> resultLauncher, Context context, Intent intent)
```
    Screen API for starting the capture flow when a pdf or image document was shared from another app.
  - setGiniApi
```
 final Unit setGiniApi(GiniBankAPI giniApi)
```
    Set the GiniBankAPI instance to be used for the Pay feature.
  - releaseGiniApi
```
 final Unit releaseGiniApi()
```
    Clears the reference to giniApi set by setGiniApi.
  - getPaymentRequest
```
 final PaymentRequest getPaymentRequest(String id)
```
    Get the payment details for the request created by a business. The id is sent in an Intent. Use getRequestId for extracting the id from the Intent.
    
    Parameters:
    
    id - The id sent by the business.
  - resolvePaymentRequest
```
 final ResolvedPayment resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)
```
    Marks the a PaymentRequest as paid.
    Important: The amount string in the ResolvePaymentInput must be convertible to a Double. For ex. "12.39" is valid, but "12.39 €" or "12,39" are not valid.
    
    Parameters:
    
    requestId - id of PaymentRequest to be resolved.
    
    resolvePaymentInput - the details used for the actual payment.
  - returnToPaymentInitiatorApp
```
 final Unit returnToPaymentInitiatorApp(Context context, ResolvedPayment resolvedPayment)
```
    Starts the app that started the payment flow.
    
    Parameters:
    
    context - used to call startActivity.
    
    resolvedPayment - the object returned by resolvePaymentRequest
  - getDigitalInvoiceOnboardingNavigationBarBottomAdapter
```
 final DigitalInvoiceOnboardingNavigationBarBottomAdapter getDigitalInvoiceOnboardingNavigationBarBottomAdapter()
```
  - setDigitalInvoiceOnboardingNavigationBarBottomAdapter
```
 final Unit setDigitalInvoiceOnboardingNavigationBarBottomAdapter(DigitalInvoiceOnboardingNavigationBarBottomAdapter digitalInvoiceOnboardingNavigationBarBottomAdapter)
```
  - getDigitalInvoiceHelpNavigationBarBottomAdapter
```
 final DigitalInvoiceHelpNavigationBarBottomAdapter getDigitalInvoiceHelpNavigationBarBottomAdapter()
```
  - setDigitalInvoiceHelpNavigationBarBottomAdapter
```
 final Unit setDigitalInvoiceHelpNavigationBarBottomAdapter(DigitalInvoiceHelpNavigationBarBottomAdapter digitalInvoiceHelpNavigationBarBottomAdapter)
```
  - getDigitalInvoiceOnboardingIllustrationAdapter
```
 final OnboardingIllustrationAdapter getDigitalInvoiceOnboardingIllustrationAdapter()
```
  - setDigitalInvoiceOnboardingIllustrationAdapter
```
 final Unit setDigitalInvoiceOnboardingIllustrationAdapter(OnboardingIllustrationAdapter digitalInvoiceOnboardingIllustrationAdapter)
```
  - getDigitalInvoiceNavigationBarBottomAdapter
```
 final DigitalInvoiceNavigationBarBottomAdapter getDigitalInvoiceNavigationBarBottomAdapter()
```
  - setDigitalInvoiceNavigationBarBottomAdapter
```
 final Unit setDigitalInvoiceNavigationBarBottomAdapter(DigitalInvoiceNavigationBarBottomAdapter digitalInvoiceNavigationBarBottomAdapter)
```
  - getEnableReturnReasons
```
 final Boolean getEnableReturnReasons()
```
    Shows the return reasons dialog in the return assistant, if enabled. Note that it is disabled by default.
  - setEnableReturnReasons
```
 final Unit setEnableReturnReasons(Boolean enableReturnReasons)
```
    Shows the return reasons dialog in the return assistant, if enabled. Note that it is disabled by default.

Object GiniBank

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setCaptureConfiguration

setCaptureConfiguration

sendTransferSummary

releaseCapture

releaseCapture

checkCaptureRequirements

startCaptureFlow

createCaptureFlowFragment

createCaptureFlowFragmentForIntent

startCaptureFlowForIntent

setGiniApi

releaseGiniApi

getPaymentRequest

resolvePaymentRequest

returnToPaymentInitiatorApp

getDigitalInvoiceOnboardingNavigationBarBottomAdapter

setDigitalInvoiceOnboardingNavigationBarBottomAdapter

getDigitalInvoiceHelpNavigationBarBottomAdapter

setDigitalInvoiceHelpNavigationBarBottomAdapter

getDigitalInvoiceOnboardingIllustrationAdapter

setDigitalInvoiceOnboardingIllustrationAdapter

getDigitalInvoiceNavigationBarBottomAdapter

setDigitalInvoiceNavigationBarBottomAdapter

getEnableReturnReasons

setEnableReturnReasons