Skip to content

Configuration Options in Flutterwave iOS SDK

Rotimi Joshua edited this page Sep 10, 2023 · 3 revisions

Flutterwave Logo

Configuration Options in Flutterwave iOS SDK

Overview

This wiki page provides an overview of the configuration options and parameters available in the Flutterwave iOS SDK. Properly configuring these options is essential for integrating the SDK successfully into your iOS application. Below is a list of key configuration options:

Configuration Options

config.paymentOptionsToExclude

  • Summary: Customize displayed payment options based on currency and preferences.
  • Usage Example: config.paymentOptionsToExclude = [.barter, .bankAccount]
  • Description: This method allows you to exclude specific payment options for a given transaction, ensuring only desired payment methods are displayed to the user.
  • More Details

config.currencyCode

  • Summary: Set the currency code for the transaction.
  • Usage Example: config.currencyCode = "NGN"
  • Description: Use the currencyCode parameter to specify the currency in which the transaction will be charged.
  • More Details

config.country

  • Summary: Set the country code for the transaction.
  • Usage Example: config.country = "NG"
  • Description: Specify the country code for the transaction. It helps define the location and currency for the transaction.
  • More Details

config.email

  • Summary: Set the customer's email address.
  • Usage Example: config.email = "[email protected]"
  • Description: Configure the customer's email address for communication and transaction notifications.
  • More Details

config.isStaging

  • Summary: Toggle between staging and live environments.
  • Usage Example: config.isStaging = true
  • Description: Use this parameter to switch between staging and live environments for testing and production purposes.
  • More Details

config.phoneNumber

  • Summary: Set the customer's phone number.
  • Usage Example: config.phoneNumber = "08000000000"
  • Description: Configure the customer's phone number for transaction-related communications.
  • More Details

config.transcationRef

  • Summary: Set a unique transaction reference.
  • Usage Example: config.transcationRef = "SampleTransaction"
  • Description: Define a unique transaction reference for tracking and identification purposes.
  • More Details

config.firstName

  • Summary: Set the customer's first name.
  • Usage Example: config.firstName = "John"
  • Description: Configure the customer's first name for transaction-related purposes.
  • More Details

config.lastName

  • Summary: Set the customer's last name.
  • Usage Example: config.lastName = "Doe"
  • Description: Configure the customer's last name for transaction-related purposes.
  • More Details

config.meta

  • Summary: Set meta information for the transaction.
  • Usage Example: config.meta = [["metaname": "sdk", "metavalue": "ios"]]
  • Description: Use the meta parameter to provide additional metadata for the transaction.
  • More Details

config.narration

  • Summary: Set a narration for the transaction.
  • Usage Example: config.narration = "Simplifying payments for endless possibilities"
  • Description: Configure a narration or description for the transaction.
  • More Details

config.publicKey

  • Summary: Set the public key for authentication.
  • Usage Example: config.publicKey = "FLWPUBK_TEST-FLW275407301c90e7ebc458275407301-X"
  • Description: Configure the public key for authentication and transaction processing.
  • More Details

config.encryptionKey

  • Summary: Set the encryption key for secure communication.
  • Usage Example: config.encryptionKey = "FLWSECK_TESTFLW275407301"
  • Description: Configure the encryption key for secure data transmission.
  • More Details

config.isPreAuth

  • Summary: Set whether it's a preauthorized card transaction.
  • Usage Example: config.isPreAuth = false
  • Description: Configure whether the transaction is a preauthorized card transaction.
  • More Details

Detailed Documentation

For detailed documentation on each configuration option and its usage, please refer to the respective sections above.