Gini
GiniHealth is one of the main classes for interacting with the Gini Health SDK. It manages interaction with the Gini Health API.
documentFlow, paymentFlow, openBankState are used by the PaymentFragment to observe their state, but they are public so that they can be observed anywhere, the main purpose for this is to observe errors.
displayedScreen is a shared flow which forwards the DisplayedScreen that is currently visible in the PaymentFragment. It can be observed to update the activity title if needed.
trustMarkersFlow emits TrustMarkerResponse, containing the icons of two payment providers and how many other payment providers are integrating Gini. It can be observed to integrate the trust markers into custom UI.
Properties
A flow for exposing the DisplayedScreen currently visible. It always starts with DisplayedScreen.Nothing. It can be observed to update the UI, such as the toolbar title.
A flow for getting the Document set for review setDocumentForReview.
A flow that exposes the state of opening the bank. You can collect this flow to get information about the errors of this action.
A flow for getting extracted PaymentDetails for the document set for review (see setDocumentForReview).
A flow for getting information about trust markers.
Functions
Checks whether the invoice contains multiple documents by fetching the invoice and its extractions from the Gini Pay API and verifying whether it has multiple documents or not.
Checks whether the document is payable by fetching the document and its extractions from the Gini Pay API and verifying that the extraction's payment state is "Payable".
Deletes multiple documents in one go. If request was successful, it returns null. If request failed, it returns a DeleteDocumentErrorResponse, with more information about why the request failed.
This function deletes a payment request by its unique paymentRequestId. If the deletion is successful, it returns null. Otherwise, if an error occurs or the request is cancelled, it returns the corresponding error message or "Request cancelled".
Deletes multiple payment requests in one go. If request was successful, it returns null. If request failed, it returns a DeleteDocumentErrorResponse, with more information about why the request failed.
A flow for exposing the DisplayedScreen currently visible. It always starts with DisplayedScreen.Nothing. It can be observed to update the UI, such as the toolbar title.
A flow for getting the Document set for review setDocumentForReview.
A flow that exposes the state of opening the bank. You can collect this flow to get information about the errors of this action.
Fetches the payment details for the provided id.
A flow for getting extracted PaymentDetails for the document set for review (see setDocumentForReview).
Creates an instance of the PaymentFragment with the given documentId and configuration.
Creates an instance of PaymentFragment with the given payment details and configuration.
Returns the localization set for the app.
A flow for getting information about trust markers.
Manually load payment provider apps, in case there was an error when trying to load them automatically.
Sets a Document for review. Results can be collected from documentFlow and paymentFlow.
Sets a lifecycle observer to handle state restoration after the system kills the app.
Sets the app language to the desired one from the languages the SDK is supporting. If not set then defaults to the system's language locale.