Gini Bank SDK for Android/net.gini.android.bank.sdk/GiniBank

GiniBank

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.

Functions

checkCaptureRequirements

public final RequirementsReport checkCaptureRequirements(Context context)

Checks hardware requirements for Capture feature. Requirements are not enforced, but are recommended to be checked before using.

getDigitalInvoiceHelpNavigationBarBottomAdapter

public final DigitalInvoiceHelpNavigationBarBottomAdapter getDigitalInvoiceHelpNavigationBarBottomAdapter()

getDigitalInvoiceNavigationBarBottomAdapter

public final DigitalInvoiceNavigationBarBottomAdapter getDigitalInvoiceNavigationBarBottomAdapter()

getDigitalInvoiceOnboardingIllustrationAdapter

public final OnboardingIllustrationAdapter getDigitalInvoiceOnboardingIllustrationAdapter()

getDigitalInvoiceOnboardingNavigationBarBottomAdapter

public final DigitalInvoiceOnboardingNavigationBarBottomAdapter getDigitalInvoiceOnboardingNavigationBarBottomAdapter()

getEnableReturnReasons

public final Boolean getEnableReturnReasons()

Shows the return reasons dialog in the return assistant, if enabled.

getPaymentRequest

public 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.

releaseCapture

public 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.

releaseGiniApi

public final Unit releaseGiniApi()

Clears the reference to giniApi set by setGiniApi.

resolvePaymentRequest

public final ResolvedPayment resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)

Marks the a PaymentRequest as paid.

returnToPaymentInitiatorApp

public final Unit returnToPaymentInitiatorApp(Context context, ResolvedPayment resolvedPayment)

Starts the app that started the payment flow.

setCaptureConfiguration

@Deprecated(message = "Please use setCaptureConfiguration(context, captureConfiguration) which allows instance recreation without having to call releaseCapture()", replaceWith = @ReplaceWith(imports = {}, expression = "setCaptureConfiguration(context, captureConfiguration)"))

public 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.

public final Unit setCaptureConfiguration(Context context, CaptureConfiguration captureConfiguration)

Sets configuration for Capture feature.

setDigitalInvoiceHelpNavigationBarBottomAdapter

public final Unit setDigitalInvoiceHelpNavigationBarBottomAdapter(DigitalInvoiceHelpNavigationBarBottomAdapter digitalInvoiceHelpNavigationBarBottomAdapter)

setDigitalInvoiceNavigationBarBottomAdapter

public final Unit setDigitalInvoiceNavigationBarBottomAdapter(DigitalInvoiceNavigationBarBottomAdapter digitalInvoiceNavigationBarBottomAdapter)

setDigitalInvoiceOnboardingIllustrationAdapter

public final Unit setDigitalInvoiceOnboardingIllustrationAdapter(OnboardingIllustrationAdapter digitalInvoiceOnboardingIllustrationAdapter)

setDigitalInvoiceOnboardingNavigationBarBottomAdapter

public final Unit setDigitalInvoiceOnboardingNavigationBarBottomAdapter(DigitalInvoiceOnboardingNavigationBarBottomAdapter digitalInvoiceOnboardingNavigationBarBottomAdapter)

setEnableReturnReasons

public final Unit setEnableReturnReasons(Boolean enableReturnReasons)

Shows the return reasons dialog in the return assistant, if enabled.

setGiniApi

public final Unit setGiniApi(GiniBankAPI giniApi)

Set the GiniBankAPI instance to be used for the Pay feature.

startCaptureFlow

public final Unit startCaptureFlow(ActivityResultLauncher<Unit> resultLauncher)

Screen API for starting the capture flow.

startCaptureFlowForIntent

public 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.

Properties

digitalInvoiceHelpNavigationBarBottomAdapter

private DigitalInvoiceHelpNavigationBarBottomAdapter digitalInvoiceHelpNavigationBarBottomAdapter

digitalInvoiceNavigationBarBottomAdapter

private DigitalInvoiceNavigationBarBottomAdapter digitalInvoiceNavigationBarBottomAdapter

digitalInvoiceOnboardingIllustrationAdapter

private OnboardingIllustrationAdapter digitalInvoiceOnboardingIllustrationAdapter

digitalInvoiceOnboardingNavigationBarBottomAdapter

private DigitalInvoiceOnboardingNavigationBarBottomAdapter digitalInvoiceOnboardingNavigationBarBottomAdapter

enableReturnReasons

private Boolean enableReturnReasons

Shows the return reasons dialog in the return assistant, if enabled.

INSTANCE

public final static GiniBank INSTANCE