GiniPayBank

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.
the Component API by building everything around the provided fragments. See example apps for more details about usage of Screen and Component APIs.

To use capture features, they need to be configured with setCaptureConfiguration. Note that configuration is immutable. releaseCapture needs to be called before passing a new configuration.

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.
returnToBusiness to return to the business app that started the flow.

Functions

checkCaptureRequirements

final RequirementsReport checkCaptureRequirements(Context context)

Checks hardware requirements for Capture feature.

createDocumentForImportedFiles

final Unit createDocumentForImportedFiles(Intent intent, Context context, AsyncCallback<Document, ImportedFileValidationException> callback)

Component APICreates an Document for a pdf or image that was shared from another app.

getPaymentRequest

final PaymentRequest getPaymentRequest(String id)

Get the payment details for the request created by a business.

releaseCapture

final Unit releaseCapture(Context context)

Frees up resources used by Capture.

releaseGiniApi

final Unit releaseGiniApi()

Clears the reference to giniApi set by setGiniApi.

resolvePaymentRequest

final ResolvedPayment resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)

Marks the a PaymentRequest as paid.

returnToBusiness

final Unit returnToBusiness(Context context, ResolvedPayment resolvedPayment)

Starts the Business app that started the payment flow.

setCaptureConfiguration

final Unit setCaptureConfiguration(CaptureConfiguration captureConfiguration)

Sets configuration for Capture feature.

setGiniApi

final Unit setGiniApi(Gini giniApi)

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

startCaptureFlow

final Unit startCaptureFlow(ActivityResultLauncher<Unit> resultLauncher)

Screen API for starting the capture flow.

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.

Properties

INSTANCE

public final static GiniPayBank INSTANCE