Quick Start

    dependencies:
      flutter:
        sdk: flutter
      volume_sdk:
        git:
          url: https://<GIT_AUTHORIZATION>@github.com/getvolume/VolumePubDev.git
          ref: 5.0.0

import 'package:volume_sdk/volume_provider.dart';
 
void main() {
  const myApp = MyApp();
  VolumeProvider.init(
    VolumeSetup(
        applicationId: "", //provided by Volume
        volumeEnvironment: "sandbox",
        ),
        myApp
  );
  runApp(myApp);
}

import 'package:volume_sdk/volume_provider.dart';
 
void main() {
  const myApp = MyApp();
  VolumeProvider.init(
    VolumeSetup(
        applicationId: "", //provided by Volume
        volumeEnvironment: "sandbox",
        showSandboxBanks: true,
        maxPaymentAmount: "15000",
        minPaymentAmount: "1"),
        buttonCustomisation: const ButtonCustomization(),
        translations: {
          "en": const VolumeTranslations(
              accountHolderNameText: "Name and Surname"),
          "de": const VolumeTranslations(
              accountHolderNameText: "Name und Nachname"),
        },
        language: "en"),
        myApp
  );
  VolumeProvider.setLanguage("de") // Optional, Use this to change language in runtime
 
  runApp(myApp);
}

 
var merchantPaymentId = generateMerchantPaymentId();
 
  @override
  void initState() {
    super.initState();
    _volumeButtonEventListener = VolumeButtonEventListener((value) {
      setState(() {
        merchantPaymentId = value;
      });
    });
  }
 
VolumePaymentButtonWidget(
  merchantPaymentId: merchantPaymentId, // Generate new value each time navigateToPaymentConsent event is emitted
  reference: "Example Reference", // Generate new reference value each time navigateToPaymentConsent event is emitted
  amount: 50.0,
  isEnabled: true,
  currency: "GBP",
  country: "GB",
  volumeEventListener: volumeButtonEventListener,
  merchantProvidedPayerDetails: 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,
  ),
  metadata: <String, dynamic>{
      "type": "shirt",
      "color": "black",
      "owner": {
        "position": "CTO",
        "description": "Very handsome man",
        "details": {
          "name": "John",
          "surname": "Doe",
        },
        "relatedItems": [
          { "itemName": "trousers", "color": "blue" },
          { "itemName": "shoes", "color": "white" },
        ],
      },
    },
)
 
String generateMerchantPaymentId()  {
  return "This should be unique value"; //TODO Get merchant Payment Id value from backend
}
 
class VolumeButtonEventListener implements VolumeEventListener {
  final void Function(dynamic value) onNavigateToPaymentConsent;
  const VolumeButtonEventListener(this.onNavigateToPaymentConsent );
 
  @override
  onEvent(VolumeEvent event) {
    switch (event.runtimeType) {
      case NavigateToPaymentConsent:
        onNavigateToPaymentConsent(generateMerchantPaymentId());
        return;
    }
  }
}

class VolumePaymentIdentifiersProvider extends PaymentIdentifiersProvider {
  @override
  Future<PaymentIdentifiers> providePaymentIdentifiers(PaymentIdentifiersRequest request) async {
    try {
      // The current amount and currency (e.g. "12.32", "GBP") are available here in case
      // they need to be sent to the backend, e.g. to reconcile them with the values used
      // when creating the merchant payment id.
      var merchantPaymentIdFromBackend = "123"; // Get merchant Payment Id from backend
      var referenceFromBackend = "ref123"; // Get reference from backend
      var generatedPaymentIdentifiers = PaymentIdentifiers(merchantPaymentId: merchantPaymentIdFromBackend, reference: referenceFromBackend);
      return generatedPaymentIdentifiers;
    } catch (e) {
      // 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
      return PaymentIdentifiers(merchantPaymentId: "", reference: "", errorMessage: e.toString());
    }
  }
}
 
// Usage in the VolumePaymentButtonWidget
VolumePaymentButtonWidget(
  merchantPaymentId: merchantPaymentId,
  reference: reference,
  amount: amount,
  currency: currency,
  country: country,
  isEnabled: isEnabled,
  volumeEventListener: _volumeButtonEventListener,
  paymentIdentifiersProvider: VolumePaymentIdentifiersProvider(),
  metadata: const <String, dynamic>{
    // ... metadata
  },
)

double amount = 0.01;
 
void _applyPrice(double price) {
  setState(() {
    amount = price; // rebuilds VolumePaymentButtonWidget with the new amount
  });
}
 
// In build():
VolumePaymentButtonWidget(
  amount: amount,
  // ... other parameters
)

StreamSubscription<double>? _priceSubscription;
 
@override
void initState() {
  super.initState();
  // priceStream is your backend's price feed, e.g. a WebSocket stream
  _priceSubscription = priceStream.listen(_applyPrice);
}
 
@override
void dispose() {
  _priceSubscription?.cancel();
  super.dispose();
}

Timer? _priceTimer;
 
@override
void initState() {
  super.initState();
  _priceTimer = Timer.periodic(const Duration(seconds: 10), (_) async {
    final price = await fetchPriceFromBackend(); // e.g. GET /current-price
    if (_priceTimer != null) _applyPrice(price); // ignore responses arriving after dispose
  });
}
 
@override
void dispose() {
  _priceTimer?.cancel();
  _priceTimer = null;
  super.dispose();
}

VolumePaymentButtonWidget(
  // ... other parameters
  merchantProvidedPayerDetails: 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 D.",
  iban: "DE89370400440532013000",
  accountNumber: null,
  sortCode: null,
)

PayerAccount(
  holderName: "John D.",
  accountNumber: "12345678",
  sortCode: "123456",
  iban: null,
)

<key>LSApplicationQueriesSchemes</key>
	<array>
		<string>BMBGB</string>
		<string>revolut</string>
		<string>natwestbank</string>
		<string>monzo</string>
		<string>santanderretail</string>
		<string>rbs</string>
		<string>lloyds-retail</string>
		<string>ukcomhsbcmobilebanking</string>
		<string>zappcfi437759</string>
		<string>hsbc-pwnwguti5z</string>
		<string>zapp</string>
		<string>launchAIB</string>
		<string>ie.aib.mobilebanking</string>
		<string>BOIOneAPP</string>
		<string>halifax-retail</string>
		<string>starlingbank</string>
		<string>tescobank</string>
		<string>tsbmobile</string>
		<string>sparda-app</string>
		<string>bankingappspardaproduktion</string>
		<string>secureappspardaproduktion</string>
		<string>sapp-pushtan</string>
		<string>sapp-invest</string>
		<string>de.sparda.securego</string>
		<string>bos-retail</string>
		<string>launchbca</string>
		<string>comfirstdirectbankingonthego</string>
		<string>cs-com.virginmoney.uk.mobile.ios</string>
		<string>transferwise</string>
		<string>ybssavings</string>
		<string>chase-international</string>
	</array>