Capture Flow

In order to launch Gini Capture SDK, follow these steps:

Request camera access.
Configure a new instance of GiniCapture.
Launch CameraActivity.
Handle the extraction results.
Send the final transfer summary values to Gini by calling GiniCapture.sendTransferSummary()method which will be used to improve the future extraction accuracy
Clean up the SDK by calling GiniCapture.cleanup() which will release the resources used by SDK.

Follow these recommendations:

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 transfer summary only after TAN verification.

You don’t need to implement any extra steps.

The diagram shows the interaction between your app and the SDK:

Check out an example app to see how an integration can look like.

The CameraActivity returns one of the following results:

Activity.RESULT_OK

A document was analyzed and the extractions are available in the EXTRA_OUT_EXTRACTIONS result extra. It contains a Bundle with the extraction labels as keys and GiniCaptureSpecificExtraction parcelables as values.

Activity.RESULT_CANCELED

The user canceled Gini Capture SDK.

CameraActivity.RESULT_ERROR

An error occurred and the details are available in the EXTRA_OUT_ERROR result extra. It contains a parseable extra of type GiniCaptureError detailing what went wrong.

CameraActivity.RESULT_ENTER_MANUALLY

The document analysis finished with no results or an error and the user clicked the Enter manually button on either the No Results Screen or the Error Screen. To enable manual entry of payment information, let your app prompt users for manual input.

Learn how to launch Gini Capture SDK and handle the results from the example:

void startGiniCaptureSDK() {
    // Make sure camera permission has been already granted at this point.

    // Instantiate the networking implementations.
    GiniCaptureNetworkService networkService = ...

    // Configure GiniCapture and create a new singleton instance.
    GiniCapture.newInstance()
            .setGiniCaptureNetworkService(networkService)
            ...
            .build();

    // Launch the CameraActivity and wait for the result.
    Intent intent = new Intent(this, CameraActivity.class);
    startActivityForResult(intent, GINI_CAPTURE_REQUEST);
}

@Override
protected void onActivityResult(final int requestCode, final int resultCode,
        final Intent data) {
    super.onActivityResult(requestCode, resultCode, data);

    if (requestCode == GINI_CAPTURE_REQUEST) {
        switch (resultCode) {
            case Activity.RESULT_CANCELED:
                GiniCapture.cleanup(this);
                break;

            case Activity.RESULT_OK:
                // Retrieve the extractions
                Bundle extractionsBundle = data.getBundleExtra(
                        CameraActivity.EXTRA_OUT_EXTRACTIONS);

                // Retrieve the extractions from the extractionsBundle
                Map<String, GiniCaptureSpecificExtraction> extractions = new HashMap<>();
                for (String extractionLabel : extractionsBundle.keySet()) {
                    GiniCaptureSpecificExtraction extraction = extractionsBundle.getParcelable(extractionLabel);
                    extractions.put(extractionLabel, extraction);
                }
                showExtractions(extractions);

                break;

            case CameraActivity.RESULT_ERROR:
                // Something went wrong, retrieve and handle the error
                final GiniCaptureError error = data.getParcelableExtra(
                        CameraActivity.EXTRA_OUT_ERROR);
                if (error != null) {
                    handleError(error);
                }
                GiniCapture.cleanup(this);
                break;

            case CameraActivity.RESULT_ENTER_MANUALLY:
                handleEnterManually();
                GiniCapture.cleanup(this);
                break;
        }
    }
}

void stopGiniCaptureSDKWithTransferSummary(String paymentRecipient, 
                                           String paymentReference, 
                                           String paymentPurpose,
                                           String iban,
                                           String bic,
                                           Amount amount
  ) {
    // After the user has seen and potentially corrected the extractions, send the final
    // transfer summary values to Gini which will be used to improve the future extraction accuracy:
    GiniCapture.sendTransferSummary(
            paymentRecipient,
            paymentReference,
            paymentPurpose,
            iban,
            bic,
            amount
            )
            
    // cleanup the capture SDK after sending the transfer summary
    GiniCapture.cleanup(this)
}