Photo Payment

With Docutain's Photo Payment SDK you can integrate photo payment into your app within minutes. It includes ready-to-use UI components that can be altered to your needs and coprorate design.

photoPayment

Data Protection

Invoices contain lots of private information that need to be protected. By using the Docutain Photo Payment SDK, you have chosen the only available solution that provides 100% data protection.

This is because all functionality, especially analyzing the document content to find the relevant payment information happens on device, 100% offline. Meaning, no data at all is transfered to any external server or cloud service.

This eliminates any data protection risk and makes the Docutain SDK the first choice.

Reliability

We all know that even the most reliable servers experience outages from time to time, which directly result in the inability to process photo payments for your users.

Since the Docutain SDK runs offline on the respective device, without any server connection, the functionality is 100% available.

Photo Payment

Initialization

Follow the Getting started guide
Initialize the Docutain SDK as described here

Start Photo Payment

To start the photo payment process, you only have to launch an ActivityResultLauncher with our predefined PhotoPaymentResult contract and wait for it to return.

An instance of PhotoPaymentConfiguration is required to launch the process. It provides the possibility to change some behaviours and theming to adopt it to your needs. See Change default scan behaviour for possible custom settings.

Kotlin
Java

import de.docutain.sdk.ui.PhotoPaymentResult

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { data ->
    if(data != null){
        //data is a JSON string containing the information
        //extract the fields you need and pass it on to your payment sheet
    } else{
        //user canceled scan process
    }
}

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    photoPaymentResult.launch(paymentConfig)
}

import de.docutain.sdk.ui.PhotoPaymentResult

private ActivityResultLauncher<PhotoPaymentConfiguration> photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() {
        @Override
        public void onActivityResult(String data) {
            if(data != null){
                //data is a JSON string containing the information
                //extract the fields you need and pass it on to your payment sheet
            } else{
                //user canceled scan process
            }
        }
    });

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();       
        photoPaymentResult.launch(paymentConfig);
    }
});

Extract Payment Data

The payment data will be returned as JSON string. By default, it will have the following structure:

{
    "Address":
    {
        "Name1": "DB Fernverkehr AG",
        "Name2": "",
        "Name3": "",
        "Zipcode": "60643",
        "City": "Frankfurt am Main",
        "Street": "BahnCard-Service",
        "Phone": "0302970",
        "CustomerId": "",
        "Bank": [{"BIC": "PBNKDEFFXXX",
        "IBAN": "DE02100100100152517108"}]
    },
    "Date": "2024-10-14",
    "Amount": "244.00",
    "InvoiceId": "2023174086",
    "Reference": "RNr:2023174086 vom 14.10.2024",
    "SEPACreditor": "DB Vertrieb GmbH"
}

If you don't need it, you can disable reading the BIC:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.analyzeConfig.readBIC = false
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();  
        paymentConfig.getAnalyzeConfig().setReadBIC(false);     
        photoPaymentResult.launch(paymentConfig);
    }
});

Instead of a Bank element, the data will then only have an IBAN element:

{
    "Address":
    {
        "Name1": "DB Fernverkehr AG",
        "Name2": "",
        "Name3": "",
        "Zipcode": "60643",
        "City": "Frankfurt am Main",
        "Street": "BahnCard-Service",
        "Phone": "0302970",
        "CustomerId": "",
        "IBAN": ["DE76570928000208303503", "DE41510500150710030316"]
    },
    "Date": "2024-10-14",
    "Amount": "244.00",
    "InvoiceId": "2023174086",
    "Reference": "RNr:2023174086 vom 14.10.2024",
    "SEPACreditor": "DB Vertrieb GmbH"
}

Optionally, you can enable reading the payment state, telling you whether the invoice has already been marked as paid.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.analyzeConfig.readPaymentState = true
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();  
        paymentConfig.getAnalyzeConfig().setReadPaymentState(true);     
        photoPaymentResult.launch(paymentConfig);
    }
});

The payment data will then have an additional value PaymentState which contains either Paid or ToBePaid:

{
    "Address":
    {
        "Name1": "DB Fernverkehr AG",
        "Name2": "",
        "Name3": "",
        "Zipcode": "60643",
        "City": "Frankfurt am Main",
        "Street": "BahnCard-Service",
        "Phone": "0302970",
        "CustomerId": "",
        "Bank": [{"BIC": "PBNKDEFFXXX",
        "IBAN": "DE02100100100152517108"}]
    },
    "Date": "2024-10-14",
    "Amount": "244.00",
    "InvoiceId": "2023174086",
    "Reference": "RNr:2023174086 vom 14.10.2024",
    "PaymentState": "ToBePaid",
    "SEPACreditor": "DB Vertrieb GmbH"
}

Onboarding

The SDK provides 2 optional onboarding possibilities that will be shown to the user on first start with some default content. It can be disabled, if you do not want to use it. You can also alter the contents of the onboarding to adopt it to your needs. By default, both options are activated.

The first option provides a full screen view pager with swipable content that opens once before the camera starts.

onboardingDataProtection onboardingLightingConditions

The second option is a popup on the scanning screen.

onboardingScanHintPopup

Disable

If you don't want to use either of them, just set the onboarding property of the PhotoPaymentConfiguration to nil:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.onboarding = null
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.setOnboarding(null); 
        photoPaymentResult.launch(paymentConfig);
    }
});

If you want to use the swipable onboarding, but not the popup, set the scanHintPopup property to null.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.onboarding?.scanHintPopup = null
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getOnboarding().setScanHintPopup(null); 
        photoPaymentResult.launch(paymentConfig);
    }
});

If you want to use the popup, but not the swipable onboarding, set the items property to null.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.onboarding?.items = null
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getOnboarding().setItems(null); 
        photoPaymentResult.launch(paymentConfig);
    }
});

Customize

Button colors are configured by the global color configuration.

If you want to provide your own swipeable items instead of the default items, you can do that by providing your own list of DocutainListItem. Each item consists of an image, a title and a message.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    val items = listOf(
        DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
        DocutainListItem(R.drawable.image2, "Title 2", "Message 2"),
    );
    paymentConfig.onboarding?.items = items
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        List<DocutainListItem> items = Arrays.asList(
            new DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
            new DocutainListItem(R.drawable.image2, "Title 2", "Message 2")
        );
        paymentConfig.getOnboarding().setItems(items);
        photoPaymentResult.launch(paymentConfig);
    }
});

The following provides an overview of the currently available options to alter the onboarding:

Property	Type	Default Value	Description
`items`	`List<DocutainListItem>?`	`null`	The items you want to show within the onboarding. If you don't provide any items, some default items will be displayed.
`buttonNext`	`DocutainButton`	`DocutainButton()`	The button that goes to the next item.
`buttonFinish`	`DocutainButton`	`DocutainButton()`	The button that closes the onboarding on the last item.
`buttonSkip`	`DocutainButton`	`DocutainButton()`	The button to skip (close) the onboarding.
`buttonBack`	`DocutainButton?`	`null`	The button that goes to the previous item. It is disabled by default.
`scanHintPopup`	`ScanHintPopup?`	`ScanHintPopup()`	A popup that appears when scan is opened for the first time, explaining the user how to scan.

info

You can get the default items used by the SDK to use them for your own list.

Kotlin
Java

val defaultItems = Onboarding.defaultItems

List<DocutainListItem> defaultItems = Onboarding.getDefaultItems();

The following sample alters the buttonNext:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.onboarding?.buttonNext?.title = "Title"
    paymentConfig.onboarding?.buttonNext?.icon = R.drawable.icon
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getOnboarding().getButtonNext().setTitle("Title");
        paymentConfig.getOnboarding().getButtonNext().setIcon(R.drawable.icon);
        photoPaymentResult.launch(paymentConfig);
    }
});

The following provides an overview of the currently available options to alter the scanHintPopup:

Property	Type	Description
`title`	`String?`	The text to display as title.
`message`	`String?`	The text to display as message.
`closeButton`	`String?`	The text of the close button.
`imageSource`	`Int`	The image to display.

The following sample alters the imageSource:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.onboarding?.scanHintPopup?.imageSource = R.drawable.image
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getOnboarding().getScanHintPopup().setImageSource(R.drawable.icon);
        photoPaymentResult.launch(paymentConfig);
    }
});

Scan Tips

The SDK provides an optional toolbar item within the scanning screen, that when clicked, will open some tips on how to get the best scan result. By default it is activated and shows some default items. You can customize it according to your needs or disable it completely.

scanTips

Disable

To disable the scan tips, set the scanTips property of the PhotoPaymentConfiguration to null:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.scanTips = null
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.setScanTips(null); 
        photoPaymentResult.launch(paymentConfig);
    }
});

Customize

If you want to provide your own items instead of the default items, you can do that by providing your own list of DocutainListItem. Each item consists of an image, a title and a message.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    val scanTipsItems = listOf(
        DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
        DocutainListItem(R.drawable.image2, "Title 2", "Message 2"),
    );
    paymentConfig.scanTips?.items = scanTipsItems
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        List<DocutainListItem> scanTipsItems = Arrays.asList(
            new DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
            new DocutainListItem(R.drawable.image2, "Title 2", "Message 2")
        );
        paymentConfig.getScanTips().setItems(scanTipsItems);
        photoPaymentResult.launch(paymentConfig);
    }
});

The following provides an overview of the currently available options to alter the scanTips:

Property	Type	Default Value	Description
`items`	`List<DocutainListItem>?`	`null`	The items you want to show within the scan tips. If you don't provide any items, some default items will be displayed.
`toolbarItem`	`DocutainButton`	`DocutainButton()`	The toolbar item that will be shown allowing the user to open the scan tips.

info

You can get the default items used by the SDK to use them for your own list.

Kotlin
Java

val defaultItems = ScanTips.defaultItems

List<DocutainListItem> defaultItems = ScanTips.getDefaultItems();

The following sample alters the toolbarItem icon:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.scanTips?.toolbarItem?.icon = R.drawable.icon
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getScanTips().getToolbarItem().setIcon(R.drawable.icon);
        photoPaymentResult.launch(paymentConfig);
    }
});

Empty Result Screen

By default, when no payment data could be extracted (meaning, no IBAN, no SEPACreditor, no Amount), the SDK provides a screen with some tips and an option to cancel or to retry the scan. You can customize it according to your needs or disable it completely.

emptyResultScreen

Disable

To disable the empty result screen, set the emptyResultScreen property of the PhotoPaymentConfiguration to null:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.emptyResultScreen = null
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.setEmptyResultScreen(null); 
        photoPaymentResult.launch(paymentConfig);
    }
});

Customize

Button colors are configured by the global color configuration.

If you want to provide your own items instead of the default items, you can do that by providing your own list of DocutainListItem. Each item consists of an image, a title and a message.

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    val emptyResultItems = listOf(
        DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
        DocutainListItem(R.drawable.image2, "Title 2", "Message 2"),
    );
    paymentConfig.emptyResultScreen?.items = emptyResultItems
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        List<DocutainListItem> emptyResultItems = Arrays.asList(
            new DocutainListItem(R.drawable.image1, "Title 1", "Message 1"),
            new DocutainListItem(R.drawable.image2, "Title 2", "Message 2")
        );
        paymentConfig.getEmptyResultScreen().setItems(emptyResultItems);
        photoPaymentResult.launch(paymentConfig);
    }
});

The following provides an overview of the currently available options to alter the emptyResultScreen:

Property	Type	Default Value	Description
`items`	`List<DocutainListItem>?`	`null`	The items you want to show as scan tips. If you don't provide any items, some default items will be displayed.
`title`	`String?`		The title to be displayed in the top toolbar.
`repeatButton`	`DocutainButton`	`DocutainButton()`	The button that restarts the scan process.

info

You can get the default items used by the SDK to use them for your own list.

Kotlin
Java

val defaultItems = EmptyResultScreen.defaultItems

List<DocutainListItem> defaultItems = EmptyResultScreen.getDefaultItems();

The following sample alters the repeatButton:

Kotlin
Java

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.emptyResultScreen?.repeatButton?.title = "Title"
    paymentConfig.emptyResultScreen?.repeatButton?.icon = R.drawable.icon
    photoPaymentResult.launch(paymentConfig)
}

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();    
        paymentConfig.getEmptyResultScreen().getRepeatButton().setTitle("Title");
        paymentConfig.getEmptyResultScreen().getRepeatButton().setIcon(R.drawable.icon);
        photoPaymentResult.launch(paymentConfig);
    }
});

Change default scan behaviour

PhotoPaymentConfiguration

You can use the PhotoPaymentConfiguration to alter the default scan behaviour to your needs. Currently the following values can be set:

Property	Type	Default Value	Description
`allowCaptureModeSetting`	`Boolean`	`false`	If true, the document scanner toolbar will display an item that allows the user to switch between automatic and manual camera triggering.
`autoCapture`	`Boolean`	`true`	If true, the camera will capture the image automatically at the right moment.
`defaultScanFilter`	`ScanFilter`	`ILLUSTRATION`	The default scan filter that will be used after scan.
`pageEditConfig`	`PageEditConfiguration`	`PageEditConfiguration`	Configuration class used to alter the default page editing behaviour. See PageEditConfiguration for more details.
`source`	`Source`	`CAMERA_IMPORT`	The source of the Document Scanner.
`autoCrop`	`Boolean`	`false`	If true, image gets automatically cropped if document was detected. This applies only when importing images.
`multiPage`	`Boolean`	`true`	If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents.
`preCaptureFocus`	`Boolean`	`true`	If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer.
`theme`	`Int`	`R.style.DocutainSDK_Theme_Default`	Your custom theme if you like to change colors to match your branding. Please see ColorConfiguration for more details.
`textConfig`	`TextConfiguration`	`TextConfiguration`	Configuration class used to alter the default text behaviour. See TextConfiguration for more details.
`buttonConfig`	`ButtonConfiguration`	`ButtonConfiguration`	Configuration class used to alter the default buttons. See ButtonConfiguration for more details.
`confirmPages`	`Boolean`	`false`	If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished.
`allowPageEditing`	`Boolean`	`true`	If true, after the scan screen is finished, an editing screen with the captured images will be displayed. On the editing screen, the user can crop manually, rotate the page, filter the page and much more. The editing screen can be configured by accessing the `PageEditConfiguration`.
`statusBarAppearance`	`StatusBarAppearance`	`null`	Overrides the status bar appearance. By default, the system chooses the appearance based on the current UI Mode.
`navigationBarAppearance`	`NavigationBarAppearance`	`null`	Overrides the navigation bar appearance. By default, the system chooses the appearance based on the current UI Mode.
`onboarding`	`Onboarding?`	`Onboarding`	An optional onboarding when the user opens the scanner for the first time. See Onboarding for more details.
`scanTips`	`ScanTips?`	`ScanTips`	An optional toolbar item that shows scan tips when clicked. See ScanTips for more details.
`vibrateOnCapture`	`Boolean`	`true`	If true, when an image is captured, the device vibrates to signal successful capture.
`emptyResultScreen`	`EmptyResultScreen?`	`Empty Result Screen`	A screen that will be displayed if no payment information could be extracted. See Empty Result Screen for more details.

info

All parameters in PhotoPaymentConfiguration are optional.

The following sample shows how to disable page editing completely:

Kotlin
Java

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { result -> }

...

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.allowPageEditing = false
    photoPaymentResult.launch(paymentConfig)
}

private ActivityResultLauncher photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() { });

...

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();
        paymentConfig.setAllowPageEditing(false);
        photoPaymentResult.launch(paymentConfig);
    }
});

PageEditConfiguration

You can use the PageEditConfiguration to alter the default page editing behaviour of the document scanner to your needs. Currently the following values can be set:

Property	Type	Default Value	Description
`allowPageFilter`	`Boolean`	false	If false, the bottom toolbar will hide the filter page item.
`allowPageRotation`	`Boolean`	false	If false, the bottom toolbar will hide the rotate page item.
`allowPageArrangement`	`Boolean`	false	If false, the bottom toolbar will hide the arrange page item.
`allowPageCropping`	`Boolean`	true	If false, the bottom toolbar will hide the page cropping item.
`allowPageRetake`	`Boolean`	true	If true, the bottom toolbar will show a button allowing to retake the current page.
`allowPageAdd`	`Boolean`	true	If true, the bottom toolbar will show a button allowing to add a new page.
`allowPageDeletion`	`Boolean`	true	If true, the menu item for deleting pages will be displayed in the toolbar.
`pageArrangementShowDeleteButton`	`Boolean`	false	If true, each item of the page arrangement functionality will show a delete button.
`pageArrangementShowPageNumber`	`Boolean`	true	If true, each item of the page arrangement functionality will show it's page number.

info

All parameters in PageEditConfiguration are optional.

The following sample shows how to disable the page retake button:

Kotlin
Java

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { result -> }

...

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.pageEditConfig.allowPageRetake = false
    photoPaymentResult.launch(paymentConfig)
}

private ActivityResultLauncher photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() { });

...

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();
        paymentConfig.getPageEditConfig().setAllowPageRetake(false);
        photoPaymentResult.launch(paymentConfig);
    }
});

TextConfiguration

You can use the TextConfiguration to alter the default text behaviour of the document scanner to your needs. If a value does not get set explicitly, the default value provided by the SDK will be used. If you set a text value to null, it won't show any text. You can use this to remove predefined text. Currently the following values can be set:

Property	Type	Description
`textSizeBottomToolbar`	`Float?`	The text size of elements residing in the bottom toolbar.
`textSizeTopToolbar`	`Float?`	The text size of menu items residing in the top toolbar.
`textSizeScanButtons`	`Float?`	The text size of the buttons in the scan page, located at the lower part, like the torch button.
`textSizeTitle`	`Float?`	The text size of the title in the top toolbar. By default, auto shrinking down till 9.0 is enabled. If you define your custom size, automatic shrinking will be disabled.
`textTitleScanPage`	`String?`	The title to be displayed in the scan page top toolbar.
`textTitleEditPage`	`String?`	The title to be displayed in the edit page top toolbar.
`textTitleFilterPage`	`String?`	The title to be displayed in the filter page top toolbar.
`textTitleCroppingPage`	`String?`	The title to be displayed in the cropping page top toolbar.
`textTitleArrangementPage`	`String?`	The title to be displayed in the page arrangement page top toolbar.
`textTitleConfirmationPage`	`String?`	The title to be displayed in the confirmation page top toolbar.
`textDocumentTitle`	`String?`	The title to show in the top toolbar on all pages. It overwrites page specific titles, if any are set.
`textFocusHint`	`String?`	The text to show when camera is focusing after capture got triggered.
`textFirstPageHint`	`String?`	The text to show when user swipes to previous page but is already at the first page.
`textLastPageHint`	`String?`	The text to show when user swipes to next page but is already at the last page.
`textOnePageHint`	`String?`	The text to show when user swipes to next or previous page but only one page is available.
`textScanProgress`	`String?`	The text to show in the progress popup that is shown when user clicks the done button but some pages still need to be processed.
`textDeleteDialogCurrentPage`	`String`	The text to show for the option to delete the current page within the dialog that will be shown when clicking delete while multiple pages are available.
`textDeleteDialogAllPages`	`String`	The text to show for the option to delete all pages within the dialog that will be shown when clicking delete while multiple pages are available.
`textDeleteDialogCancel`	`String?`	The text to show for the option to cancel within the dialog that will be shown when clicking delete while multiple pages are available.

info

All parameters in TextConfiguration are optional.

The following sample shows how to set a document title:

Kotlin
Java

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { result -> }

...

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.textConfig.textDocumentTitle = "Custom Document Title"
    photoPaymentResult.launch(paymentConfig)
}

private ActivityResultLauncher photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() { });

...

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();
        paymentConfig.getTextConfig().setTextDocumentTitle("Custom Document Title");
        photoPaymentResult.launch(paymentConfig);
    }
});

ButtonConfiguration

You can use the ButtonConfiguration to alter the default buttons of the scanner. Each button is an object of DocutainButton and has a title and icon property. Buttons residing in the top toolbar can have either a title or an icon. If you define both, the icon will be displayed. Buttons residing in the bottom toolbar can have both title and icon at the same time. If you want a button to only display text, set the icon property to null and the title property to the text you want to display. If you want a button to only display an icon, set the title property to null and the icon property to the icon you want to display.

Currently the following buttons can be set:

Button	Default Value	Description
`buttonEditRotate`		The button that rotates the current page.
`buttonEditCrop`		The button that opens the cropping functionality.
`buttonEditFilter`		The button that opens the filter functionality.
`buttonEditArrange`		The button that opens the page arrangement functionality.
`buttonEditRetake`		The button that starts the process of replacing the current page with a new scan.
`buttonEditAddPage`		The button on the edit page that opens the scan screen to add a new page.
`buttonEditDelete`		The button that deletes the current page or opens a dialog with options if multiple pages are available.
`buttonEditFinish`		The button that finishes the scan process.
`buttonCropExpand`		The button within the cropping functionality that expands the current cropping rectangle to the whole page.
`buttonCropSnap`		The button within the cropping functionality that snaps the current cropping rectangle to the detected document.
`buttonCropFinish`		The button within the cropping functionality that finishes the manual cropping process according to the current cropping rectangle.
`buttonScanAutoCaptureOn`		The button within the scan functionality that is shown when automatic capture is activated.
`buttonScanAutoCaptureOff`		The button within the scan functionality that is shown when automatic capture is deactivated.
`buttonScanTorch`		The button within the scan functionality that toggles the torch.
`buttonScanCapture`		The button within the scan functionality that triggers a manual image capture.
`buttonScanFinish`		The button within the scan functionality that finishes the current scan process and leads to the editing page.
`buttonScanImport`		The button on the scan page that opens a file importer.
`buttonConfirmationFinish`		The button on the confirmation page that finishes the scan process.

info

All parameters in ButtonConfiguration are optional.

The following sample shows how to customize the buttonEditRetake:

Kotlin
Java

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { result -> }

...

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.buttonConfig.buttonEditRetake.title = "Custom Title"
    paymentConfig.buttonConfig.buttonEditRetake.icon = R.drawable.icon
    photoPaymentResult.launch(paymentConfig)
}

private ActivityResultLauncher photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() { });

...

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();
        paymentConfig.getButtonConfig().getButtonEditRetake().setTitle("Custom Title");
        paymentConfig.getButtonConfig().getButtonEditRetake().setIcon(R.drawable.icon);
        photoPaymentResult.launch(paymentConfig);
    }
});

ColorConfiguration

In order to fit the Docutain Photo Payment SDK into your corporate design, you have a bunch of options to alter the default color theming of the ready to use UI components.

Supported colors

The following is a list of all colors currently supported.

Color	Default Value	Description
`docutain_colorPrimary`	light: `#4CAF50` dark: `#4CAF50`	Used to tint progress indicators, the text color of secondary or dialog buttons and the background color of primary buttons.
`docutain_colorOnPrimary`	light: `#FFFFFF` dark: `#000000`	Used to tint elements that reside on `docutain_colorPrimary`, like the icon and text of primary buttons.
`docutain_colorSecondary`	light: `#4CAF50` dark: `#4CAF50`	Used to tint selectable controls and the capture button.
`docutain_colorOnSecondary`	light: `#FFFFFF` dark: `#000000`	Used to tint elements that reside on `docutain_colorSecondary`, like the icon of the capture button.
`docutain_colorScanButtonsLayoutBackground`	light: `#121212` dark: `#121212`	Used to tint the background of the scan buttons layout.
`docutain_colorScanButtonsForeground`	light: `#FFFFFF` dark: `#FFFFFF`	Used to tint the foreground of the scan buttons layout, like the torch button.
`docutain_colorScanPolygon`	light: `#4CAF50` dark: `#4CAF50`	Used to tint the polygon overlay which highlights the currently detected document.
`docutain_colorBottomBarBackground`	light: `#FFFFFF` dark: `#212121`	Used to tint the bottom toolbar background of the image editing page.
`docutain_colorBottomBarForeground`	light: `#323232` dark: `#BEBEBE`	Used to tint the buttons within the bottom toolbar of the image editing page.
`docutain_colorTopBarBackground`	light: `#4CAF50` dark: `#2a2a2a`	Used to tint the top toolbar background.
`docutain_colorTopBarForeground`	light: `#FFFFFF` dark: `#DEFFFFFF`	Used to tint the buttons contained in the top toolbar.
`docutain_colorTopBarTitle`	light: `#FFFFFF` dark: `#DEFFFFFF`	Used to tint the text of the top toolbar title.

Dark Mode

The Docutain SDK also supports dark mode theming. The process is the same, just define different colors for the night version of your theme. The SDK decides which color to use depending on the device's sytem setting and it will change at runtime, if the device's display mode changes.

theming_edit_bottombar theming_edit_bottombar_dark

Defining a custom theme

In order to alter at least one of the colors mentioned above, you need to define a custom theme which uses DocutainSDK.Theme.Default as parent.

The following is an example which alters all currently available colors.

<style name="DocutainSDKTestApp.DocutainSDKTheme" parent="DocutainSDK.Theme.Default">
    <item name="docutain_colorPrimary">@color/colorPrimary</item>
    <item name="docutain_colorOnPrimary">@color/colorOnPrimary</item>
    <item name="docutain_colorSecondary">@color/colorSecondary</item>
    <item name="docutain_colorOnSecondary">@color/colorOnSecondary</item>
    <item name="docutain_colorScanButtonsLayoutBackground">@color/colorScanButtonsLayoutBackground</item>
    <item name="docutain_colorScanButtonsForeground">@color/colorScanButtonsForeground</item>
    <item name="docutain_colorScanPolygon">@color/colorScanPolygon</item>
    <item name="docutain_colorBottomBarBackground">@color/colorBottomBarBackground</item>
    <item name="docutain_colorBottomBarForeground">@color/colorBottomBarForeground</item>
    <item name="docutain_colorTopBarBackground">@color/colorTopBarBackground</item>
    <item name="docutain_colorTopBarForeground">@color/colorTopBarForeground</item>
    <item name="docutain_colorTopBarTitle">@color/colorTopBarTitle</item>
</style>

To tell the SDK to use your custom theme, set the theme attribute of the PhotoPaymentConfiguration.

Kotlin
Java

val photoPaymentResult = registerForActivityResult(PhotoPaymentResult()) { result -> }

...

myButton.setOnClickListener {   
    val paymentConfig = PhotoPaymentConfiguration()
    paymentConfig.theme = R.style.your_custom_theme
    photoPaymentResult.launch(paymentConfig)
}

private ActivityResultLauncher photoPaymentResult = registerForActivityResult(new PhotoPaymentResult(),
    new ActivityResultCallback<String>() { });

...

myButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        PhotoPaymentConfiguration paymentConfig = new PhotoPaymentConfiguration();
        paymentConfig.setTheme(R.style.your_custom_theme);
        photoPaymentResult.launch(paymentConfig);
    }
});

Photo Payment

Data Protection​

Reliability​

Photo Payment​

Initialization​

Start Photo Payment​

Extract Payment Data​

Onboarding​

Disable​

Customize​

Scan Tips​

Disable​

Customize​

Empty Result Screen​

Disable​

Customize​

Change default scan behaviour​

PhotoPaymentConfiguration​

PageEditConfiguration​

TextConfiguration​

ButtonConfiguration​

ColorConfiguration​

Supported colors​

Dark Mode​

Defining a custom theme​

Data Protection

Reliability

Photo Payment

Initialization

Start Photo Payment

Extract Payment Data

Onboarding

Disable

Customize

Scan Tips

Disable

Customize

Empty Result Screen

Disable

Customize

Change default scan behaviour

PhotoPaymentConfiguration

PageEditConfiguration

TextConfiguration

ButtonConfiguration

ColorConfiguration

Supported colors

Dark Mode

Defining a custom theme