1. Pay with Bank Transfer: This payment method allows your customers to make a payment to a dynamically generated account number for the transaction.
2. Pay with USSD: This payment method allows your customers to make a payment using USSD.
3. Pay with Card: This payment method allows your customers to make payments using their card.
4. Pay with Phone Number: This payment method allows your customers to make a payment using a phone number to initialize a session.

Response Object

When the transaction is completed, Monnify will return a response object to your onComplete function.

1{
2"amount": 100,
3"amountPaid": 100,
4"completed": true,
5"completedOn": "2022-03-31T10:53:50.000+0000",
6"createdOn": "2022-03-31T10:52:09.000+0000",
7"currencyCode": "NGN",
8"customerEmail": "[email protected]",
9"customerName": "Damilare Ogunnaike",
10"fee": 10.75,
11"metaData": {
12  "deviceType": "mobile",
13  "ipAddress": "127.0.0.1"
14},
15"payableAmount": 100,
16"paymentMethod": "CARD",
17"paymentReference": "MNFY|PAYREF|GENERATED|1648723909057299503",
18"paymentStatus": "PAID",
19"transactionReference": "MNFY|67|20220331115209|000063"
20}

It is recommended that you always make a get transaction status call whenever a transaction is completed (or canceled) before saving the transaction on your database. Monnify will also notify you via your webhook URL of the status of any transaction.

User Cancelled Response

If a user cancels, Monnify returns the following response to your onClose function

1{
2"authorizedAmount": 30,
3"paymentStatus": "USER_CANCELLED",
4"redirectUrl": null,
5"responseCode": "USER_CANCELLED",
6"responseMessage": "User cancelled Transaction"
7}

Note: By default, all payment methods are displayed. However, if you want to control the displayed payment methods, you can do so by setting paymentMethods field in the initialization request as seen below:

1 paymentMethods: [
2  "CARD",
3  "ACCOUNT_TRANSFER",
4  "USSD",
5  "PHONE_NUMBER"
6],
7onLoadStart: () => {
8  console.log("loading has started");
9}

If the paymentMethods property isn’t included, by default, all the available payment methods will be displayed to your customers. If the paymentMethods property is specified, the listed payment methods will be displayed to your customers, see the sample below:

1paymentMethods: [
2  "USSD",
3  "PHONE_NUMBER"
4],
5onComplete: function(response) {
6  console.log(response);
7}

1. Card Payment
2. Bank Transfer
3. USSD Payment
4. Payment by Phone Number

Steps to Implementation

1allprojects {
2  repositories {
3      google()
4mavenCentral()
5  }
6}

1dependencies {
2  // ...
3  implementation "com.monnify.android-sdk:monnify-android-sdk:1.1.7"
4}

1. Card Payment
2. Bank Transfer
3. USSD Payment
4. Payment by Phone Number

Steps to Implementation

1import 'package:monnify_payment_sdk/monnify_payment_sdk.dart';
2
3class _MyAppState extends State<MyApp> {
4
5@override
6void initState() {
7  super.initState();
8  MonnifyPaymentSdk.initialize(
9            'YOUR_API_KEY',
10            'CONTRACTCODE',
11            ApplicationMode.TEST
12  )
13}
14}

1Future<void> initPayment() async {
2  TransactionResponse transactionResponse =
3        await MonnifyPaymentSdk.initializePayment(Transaction(
4            2000,
5            "NGN",
6            "Customer Name",
7            "[email protected]",
8            "PAYMENT_REF",
9            "Description of payment",
10            metaData: {
11              "ip": "196.168.45.22",
12              "device": "mobile_flutter"
13              // any other info
14            },
15            paymentMethods: [PaymentMethod.CARD, PaymentMethod.ACCOUNT_TRANSFER],
16            incomeSplitConfig: [
17              SubAccountDetails("MFY_SUB_319452883968", 10.5, 500, true),
18              SubAccountDetails("MFY_SUB_259811283666", 10.5, 1000, false)]
19        )
20  );
21}

1. Card Payment
2. Bank Transfer
3. USSD Payment
4. Payment by Phone Number

How to Implementation

1. Adding the iOS SDK to your project via CocoaPodsMonnify iOS SDK is available through CocoaPods. To install it, simply add the following line to your Podfile:
Copy

1pod 'MonnifyiOSSDK'

2. Access an instance of the Monnify SDK Monnify iOS SDK is available through CocoaPods. To install it, simply add the following line to your Podfile:

Copy

1let monnify = Monnify.shared

3. Set your merchant API key and contract code. This should be done in your AppDelegate.swift file. This should only be done once in the entire application. This can be a TEST or LIVE. The TEST mode works on a sandbox environment and payment can be simulated here.

   
   

   Remember to switch to ApplicationMode.live when generating live builds for your application on production.

response.json

Copy

1let apiKey = "MK_PROD_XXXXXXXX"
2let contractCode = "1234567890"
3let mode = ApplicationMode.test
4
5monnify.setApplicationMode(applicationMode: mode)
6monnify.setApiKey(apiKey: apiKey)
7monnify.setContractCode(contractCode: contractCode)

4. Specify the transaction parameters as shown below:
   
response.json

Copy

1let amount = Decimal(100)
2let paymentRef = "ASDF123454321"
3
4let parameter = TransactionParameters(amount: amount,
5currencyCode: "NGN",
6paymentReference: paymentRef,
7customerEmail: "[email protected]",
8customerName: "John Doe" ,
9customerMobileNumber: "08000000000",
10paymentDescription: "Payment Description.",
11incomeSplitConfig: [],
12metaData: ["deviceType":"ios", "userId":"user314285714"],
13paymentMethods: ["PaymentMethod.Card", "PaymentMethod.accountTransfer"],
14tokeniseCard: false)

5. Launch the payment gateway, perhaps when the user clicks on a 'Pay' button.

Copy

1let amount = Decimal(100)
2let paymentRef = "ASDF123454321"
3
4let parameter = TransactionParameters(amount: amount,
5                                      currencyCode: "NGN",
6                                      paymentReference: paymentRef,
7                                      customerEmail: "[email protected]",
8                                      customerName: "John Doe" ,
9                                      customerMobileNumber: "08000000000",
10                                      paymentDescription: "Payment Description.",
11                                      incomeSplitConfig: [],
12								                        metaData: ["deviceType":"ios", "userId":"user314285714"],
13                                      paymentMethods: [PaymentMethod.card, PaymentMethod.accountTransfer],
14                                      tokeniseCard: false)

1. Pay with Bank Transfer:

   This endpoint

   allows you to retrieve the dynamic virtual account details for a transaction using the transactionReference of an

   initialized transaction.

   You will receive the virtual account your customer can make payments to. If a bankCode is specified, the response will also include a unique USSD code for that bank, enabling your customer to make a USSD payment for the transaction.

1. Charge Card: This endpoint allows you to directly charge your customer using their card information and the transactionReference of an initialized transaction. Test card details are provided in the API reference.

Sample Error Messages