Quick Start

    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/getvolume/volume-android-sdk")
            credentials {
                username volume-public
                password // Token provided by Volume
            }
        }
    }

dependencies {
    implementation "com.volume.sdk:volume-android-sdk:2.5.0"
}

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
 
        VolumeProvider.init(
            volumeSetup = VolumeSetup(
                applicationId = "", // Provided by Volume
                volumeEnvironment = "sandbox",
                onEvent = { Timber.v("[Sample App Volume] On Event: $it") }, // Your own event listener
                logger = logger, // Your own logger implementation
                showSandboxBanks = true,
                maxPaymentAmount = 150.toBigDecimal(),
                minPaymentAmount = 0.01.toBigDecimal(),
                buttonCustomisation = ButtonCustomisation(),
                translations = mapOf(
                    "en" to VolumeTranslations(accountHolderNameText = "Name and Surname"),
                    "de" to VolumeTranslations(
                        accountHolderNameText = "Name und Nachname",
                        headingText = "Bezahlen mit",
                        selectBankButtonText = "Zur Zahlung Bank-App auswählen",
                    )
                ),
                language = "en",
            ),
            app = this
        )
        VolumeProvider.setLanguage("de") // Use this to change language in runtime
    }
}

    <com.volume.sdk.payment.VolumePaymentButtonView
        android:id="@+id/volumePaymentView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="16dp"
        app:layout_constraintTop_toBottomOf="@id/volume_toggle" />

        binding.volumePaymentView.setAmount("1".toBigDecimal())
        binding.volumePaymentView.setReference("Example Reference") // Generate new reference value each time navigateToPaymentConsent event is emitted
        generateAndSetMerchantPaymentId()
        binding.volumePaymentView.setCurrency("GBP")
        binding.volumePaymentView.setCountry("GB")
        binding.contentMain.volumePaymentView.setOnButtonEvent {
            when (it) {
                is VolumeEvent.NavigateToPaymentConsent -> {
                    generateAndSetMerchantPaymentId()
                }
                else -> {}
            }
        }
 
        binding.contentMain.volumePaymentView.setMetadata(
            mapOf(
                "type" to "shirt",
                "color" to "black",
                "owner" to mapOf(
                    "position" to "CTO",
                    "description" to "A tall guy",
                    "details" to mapOf(
                        "name" to "John",
                        "surname" to "Doe",
                    ),
                    "relatedItems" to listOf(
                        mapOf(
                            "itemName" to "trousers",
                            "color" to "blue",
                        ),
                        mapOf(
                            "itemName" to "shoes",
                            "color" to "white",
                        ),
                    )
                ),
            )
        )
 
        binding.contentMain.volumePaymentView.setMerchantProvidedPayerDetails(
            MerchantProvidedPayerDetails(
                email = "john.doe@example.com",
                name = "John Doe",
                phone = "+44 20 7946 0958",
                account = PayerAccount(
                    holderName = "John Doe",
                    accountNumber = "12345678",
                    sortCode = "123456",
                    iban = "DE89370400440532013000",
                ),
                address = PayerAddress(
                    addressLine1 = "123 Main Street",
                    addressLine2 = "Apt 4B",
                    countryCode = "GB",
                    town = "London",
                    postCode = "SW1A 1AA",
                ),
                useForUxFlowOptimisation = true,
            )
        )
 
        private fun generateAndSetMerchantPaymentId() {
            val merchantPaymentId = "This should be unique value" //TODO Get merchant Payment Id value from backend
 
            binding.contentMain.merchantPaymentId.setText(merchantPaymentId)
        }

class VolumePaymentIdentifiersProvider : PaymentIdentifiersProvider {
    override suspend fun providePaymentIdentifiers(): PaymentIdentifiers {
        return try {
            val merchantPaymentIdFromBackend = "123" // Get merchant Payment Id from backend
            val referenceFromBackend = "ref123" // Get reference from backend
            val generatedPaymentIdentifiers = PaymentIdentifiers(
                merchantPaymentId = merchantPaymentIdFromBackend,
                reference = referenceFromBackend
            )
            generatedPaymentIdentifiers
        } catch (e: Exception) {
            // Return result with error message in case of exception
            // If errorMessage is not null then it will be displayed to the user as an error message
            PaymentIdentifiers(
                merchantPaymentId = "",
                reference = "",
                errorMessage = e.message
            )
        }
    }
}
 
// Usage in the VolumePaymentButtonView
binding.contentMain.volumePaymentView.setPaymentIdentifiersProvider(VolumePaymentIdentifiersProvider())

binding.contentMain.volumePaymentView.setMerchantProvidedPayerDetails(
    MerchantProvidedPayerDetails(
        email = "john.doe@example.com",
        name = "John Doe",
        phone = "+44 20 7946 0958",
        account = PayerAccount(
            holderName = "John Doe",
            accountNumber = "12345678",
            sortCode = "123456",
            iban = "DE89370400440532013000",
        ),
        address = PayerAddress(
            addressLine1 = "123 Main Street",
            addressLine2 = "Apt 4B",
            countryCode = "GB",
            town = "London",
            postCode = "SW1A 1AA",
        ),
        useForUxFlowOptimisation = true,
    )
)

PayerAccount(
    holderName = "John Doe",
    accountNumber = null,
    sortCode = null,
    iban = "DE89370400440532013000",
)

PayerAccount(
    holderName = "John Doe",
    accountNumber = "12345678",
    sortCode = "123456",
    iban = null,
)