Flutterwave

Overview

Flutterwave—payment method to perform payments via online banking. This method allows you to process purchases by using Payment Page and Gate, payouts and refunds are processed by using Gate.

General information

Payment method type Online banking
Countries and regions All countries
Payment currencies GHS, KES, NGN, TZS, UGX, USD, ZAR
Currency conversion On the provider side
Purchases +
Payouts +
Stored credentials payments
Full refunds +
Partial refunds +
Chargebacks
Notes
  • Fast Track realisation
  • PCI DSS certificate is required to perform payments via Gate
Onboarding and access fee Refer to your ECommPay Key Account Manager

Interaction diagram

Payment processing by using the Flutterwave payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as provider's the technical facilities. In the Flutterwave method, you perform purchases through Payment Page or Gate while payouts and refunds are processed by using Gate.

Operations support

  Interfaces Amounts, NGN (or equivalent) Times
Payment Page CMS Plugins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + 1.00 500,000.00 up to 10 minutes *
Payouts + 100.00 1,000.00 up to 10 minutes *
Full refunds + up to 10 minutes *
Partial refunds + up to 10 minutes *
Note:

* For more information refer to your ECommPay Key Account Manager.

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the Flutterwave method, purchases, refunds, and payouts follow different processing procedures. To perform a purchase operation, you need to redirect customer to the Flutterwave service, while to initiate a refund or payout, you need to notify customer via merchant's web service.

Figure: Payment by using Payment Page

Figure: Payment by using Gate

Figure: Refund by using Gate

Figure: Payout by using Gate

Supported banks

Payments through the Flutterwave method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate payouts by using Gate. The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay Key Account Manager.

Table 1. The list of banks
Bank ID
ACCESS BANK Ghana 269
ACCESS BANK NIGERIA 193
ACCESS MOBILE 194
AFRIBANK NIGERIA PLC 195
African Banking Corp. Bank Ltd 235
Aso Savings and Loans 196
Barclays Bank of Kenya 257
CAL BANK 265
CAPITAL BANK 274
Central Bank of Kenya 256
CFC Stanbic Bank Kenya Limited 234
Chase Bank Limited 233
Citibank N.A. 229
Commercial Bank of Africa Limited 254
Consolidated Bank of Kenya Limited 231
Co-operative Bank of Kenya Limited 226
Coronation Merchant Bank 222
Development Bank of Kenya Limited 247
DIAMOND BANK PLC 197
Diamond Trust Bank Limited 249
ECOBANK Ghana 264
ECO Bank Limited Kenya 239
Ecobank Mobile Nigeria 198
ECOBANK NIGERIA LIMITED 199
ENERGY BANK 270
ENTERPRISE BANK LIMITED 200
Equatorial Commercial Bank Limited 240
Equity Bank Limited 251
Family Bank Ltd 243
FBN MOBILE 201
Fidelity Bank Ghana 275
FIDELITY BANK PLC Nigeria 202
FIRST ALLIED SAVINGS AND LOANS 273
FIRST BANK PLC 203
FIRST CITY MONUMENT BANK PLC 204
FIRST NATIONAL BANK 272
GCB BANK LTD 259
Giro Commercial Bank Limited 238
GTBank Mobile Money 205
GTBANK PLC 206
GUARANTY TRUST BANK 267
Guardian Bank Limited 245
Habib Bank Limited 255
HERITAGE BANK 207
HFC BANK 262
Housing Finance Bank 248
Imperial Bank Limited 236
Investments n Mortgages Bank Limited 246
Jamii Bora Bank 242
Kenya Commercial Bank Limited 253
KEYSTONE BANK PLC 208
K-Rep Bank Limited 250
Middle East Bank Kenya Limited 230
National Bank of Kenya Limited 227
NATIONAL INVESTMENT BANK 260
NIC Bank Limited 237
Oriental Commercial Bank Limited 228
Paramount Universal Bank Limited 241
Parkway 209
PARRALEX BANK 224
PAYCOM 210
Prime Bank Limited 225
Providus Bank 223
ROYAL BANK 271
SKYE BANK PLC 211
STANBIC BANK 266
STANBIC IBTC BANK PLC 212
Stanbic Mobile 213
STANDARD CHARTERED BANK Ghana 258
STANDARD CHARTERED BANK NIGERIA LIMITED 214
STERLING BANK PLC 215
Trans-National Bank Limited 232
UBA Kenya Bank Ltd 252
UNION BANK OF NIGERIA PLC 216
UNITED BANK FOR AFRICA Ghana 268
UNITED BANK FOR AFRICA PLC Nigeria 217
UNITY BANK PLC 218
UNIVERSAL MERCHANT BANK 261
Victoria Commercial Bank Limited 244
WEMA BANK PLC 219
ZENITH BANK Ghana 263
ZENITH BANK PLC Nigeria 220
ZENITH Mobile Nigeria 221

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase via Payment Page

General information

In the Flutterwave method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Flutterwave method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.

Figure: Purchase sequence when using Payment Page

  1. Customer initiates payment by using the web service.
  2. The merchant web service sends to the specified ECommPay URL the payment request for processing the payment by using Payment Page.
  3. The payment platform receives the request for processing the payment by using Payment Page.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. The requested payment form is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. The payment form is displayed to the customer.
  7. The customer selects the Flutterwave payment method and agrees to use the method.
  8. The payment platform receives the payment request for payment processing in the Flutterwave service.
  9. The payment platform performs the internal payment request processing and sends it to the Flutterwave service.
  10. The payment request is processed on the Flutterwave side.
  11. The Flutterwave service generates the data for redirecting the customer to the Flutterwave form and sends it to the payment platform.
  12. The payment platform sends to Payment Page the data for redirecting the customer to the Flutterwave form.
  13. The customer is redirected to the Flutterwave form.
  14. The customer completes all the required steps.
  15. The payment is processed on the Flutterwave side.
  16. Flutterwave service sends the payment result notification to the payment platform.
  17. The payment platform sends the callback to the web service.
  18. The payment platform sends payment results to Payment Page.
  19. A page with the payment result information is displayed to the customer.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Flutterwave payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Flutterwave method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  2. The currency of payment can only be one of the following currencies: GHS, KES, NGN, TZS, UGX, USD, ZAR.
  3. There is one more mandatory parameter—payment_description.
  4. To preselect Flutterwave as the payment method on Payment Page for customers, pass the code flutterwave in the force_payment_method parameter in the request for opening.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Flutterwave method must include project, customer and payment IDs, payment description, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { project_id: 102, 
      customer_id: '123',
      payment_id: 'X03936', 
      payment_amount: 5000, 
      payment_currency: 'NGN', 
      payment_description: 'test PP sale', 
      signature: "kUi7x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Flutterwave method, see Payment Page invocation parameters.

Callback format

The Flutterwave method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Figure: Example of a successful purchase callback

{
        "project_id": 258,
        "payment": {
            "id": "TEST_155",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-14T13:39:53+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 200,
                "currency": "NGN"
            },
            "description": ""
        },
        "account": {
            "number": "521178******9110"
        },
        "customer": {
            "id": "667"
        },
        "operation": {
            "id": 14376000003171,
            "type": "sale",
            "status": "success",
            "date": "2019-02-14T13:39:53+0000",
            "created_date": "2019-02-14T13:35:18+0000",
            "request_id": "e851ad352570d8d42e92e72becf792120bbc7339-37d3aebe73b4d05fd42fbbb0b5e4da0ead53180f",
            "sum_initial": {
                "amount": 200,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": "FLW119179586",
                "date": "2019-02-14T13:39:07+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "aqzhui5DMRWHsD9k7xGSdOZmQwWsILG9VR7JhvXeRGn3s3eqzsNStqR8no8bdeDvpXEQj6ef5XxTX5v3bQuR2w=="
    }

Here is an example of callback with an information about successful 2.00 NGN purchase made by the 667 customer in the 258 project.

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase via Gate

General information

In the Flutterwave method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform redirecting customer to the Flutterwave service.
  3. Get the callback with the payment result from the payment platform.

Figure: Purchase sequence when using Gate

  1. Customer initiates payment on the merchant web service by using the Flutterwave method.
  2. The web service sends the request for processing the payment by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the payment by using Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends to the web service response with request receipt confirmation and correctness check result.
  6. The payment platform performs the internal payment request processing and sends it to the Flutterwave service.
  7. The payment request is processed on the Flutterwave side.
  8. The Flutterwave service generates the data for redirecting the customer to the Flutterwave service and sends it to the payment platform.
  9. The payment platform sends to the web service the callback that delivers the data for redirecting the customer to the Flutterwave form.
  10. The customer is redirected to the Flutterwave service.
  11. The customer completes required steps.
  12. The payment is processed on the Flutterwave side.
  13. The Flutterwave service sends the payment result notification to the payment platform.
  14. The payment platform sends the callback to the web service.
  15. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Flutterwave payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Flutterwave method:
  1. You send purchase requests by sending the v2/payment/flutterwave/sale request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object that contains general purchase information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • payment—object that contains purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
  3. The currency of purchase can only be one of the following currencies: GHS, KES, NGN, TZS, UGX, USD, ZAR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Flutterwave method must include project, customer and payment IDs, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example

{
  "general": {
    "project_id": 258,
    "payment_id": "TEST_155",
    "signature": "i97Z0qDJGmCr0YzucLO2q+KgQtWxG8bBQcAzr74S2VJLrThxL4fwOUcZhdOULQWfwa7kf/yaaxH7V46k/Ho5Ag=="
  },
  "customer": {
    "id": "667",
    "ip_address": "87.245.207.226",
    "browser": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
    "device_type": "Desktop",
    "screen_res": "1920x1080",
    "session_id": "bsht6c8pd94v9r8gr41b31vhu7"
  },
  "payment": {
    "amount": 200,
    "currency": "NGN"
  }
}

Callback format

The Flutterwave method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Figure: Example of a successful purchase callback

{
        "project_id": 258,
        "payment": {
            "id": "TEST_155",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-14T13:39:53+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 200,
                "currency": "NGN"
            },
            "description": ""
        },
        "account": {
            "number": "521178******9110"
        },
        "customer": {
            "id": "667"
        },
        "operation": {
            "id": 14376000003171,
            "type": "sale",
            "status": "success",
            "date": "2019-02-14T13:39:53+0000",
            "created_date": "2019-02-14T13:35:18+0000",
            "request_id": "e851ad352570d8d42e92e72becf792120bbc7339-37d3aebe73b4d05fd42fbbb0b5e4da0ead53180f",
            "sum_initial": {
                "amount": 200,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": "FLW119179586",
                "date": "2019-02-14T13:39:07+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "aqzhui5DMRWHsD9k7xGSdOZmQwWsILG9VR7JhvXeRGn3s3eqzsNStqR8no8bdeDvpXEQj6ef5XxTX5v3bQuR2w=="
    }

Here is an example of callback with an information about successful 2.00 NGN purchase made by the 667 customer in the 258 project.

Related topics

The following topics might be useful when implementing payments through Gate:

Refund via Gate

General information

Flutterwave supports full and partial refunds processing. In the Flutterwave method, to perform a refund by using Gate: merchant's web service sends a request with all the required parameters and signature to ECommPay URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.

Figure: Refund sequence by using Gate

  1. Customer orders a refund on the bank account.
  2. Merchant's web service sends to the appropriate ECommPay URL the refund request for processing by using Gate.
  3. The payment platform receives the request for the refund processing by using Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends to the web service response with request receipt confirmation and correctness check result.
  6. Processed request is sent to the Flutterwave service.
  7. The refund is processed on the Flutterwave side.
  8. The Flutterwave service sends the result notification to the ECommPay payment platform.
  9. The ECommPay payment platform sends a callback to the web service.
  10. The customer receives the refund processing results in the form specific to the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Flutterwave payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the Flutterwave method:
  1. You perform refunds by sending the v2/payment/flutterwave/refund request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object that contains general purchase information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object payment—refund information:
      • description—comment or description
      • amount—refund amount in minor units (mandatory for partial refund only)
      • currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refund only)
  3. The currency of refund can only be one of the following currencies: GHS, KES, NGN, TZS, UGX, USD, ZAR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the Flutterwave method must include project and payment IDs, signature, as shown in the following example:

Figure: Refund request example

{
  "general": {
    "project_id": 257,
    "payment_id": "TEST_155",
    "signature": "EVUbhYJ7CjhJlawmfCaNXSPsPPU2XvVMOnDjEyfEdeeVt6u...==",
  },
  "payment": {
    "amount": 50000,
    "currency": "NGN",
    "description": "TEST_155"
  }
}

Callback format

The Flutterwave method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

Figure: Example of a successful refund callback

{
        "project_id": 257,
        "payment": {
            "id": "TEST_155",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2019-02-18T06:18:01+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 40000,
                "currency": "NGN"
            },
            "description": "TEST_155"
        },
        "operation": {
            "id": 258000003219,
            "type": "refund",
            "status": "success",
            "date": "2019-02-18T06:18:01+0000",
            "created_date": "2019-02-18T06:17:52+0000",
            "request_id": "dda6eb029059832eb1",
            "sum_initial": {
                "amount": 10000,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": "25960166",
                "date": "2019-02-18T06:18:00+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "L3DDG4SK3dukjBjT8ZZfOL4X/jE1/BgKp5LI2+putJA/U4DxogWEKCqbOWewI6dt4C7EX1BEkKL4QGH1nNNWRw=="
    }

Here is an example of callback with an information about successful 100.00 NGN refund in the 257 project.

Figure: Example of a declined refund callback

 {
        "project_id": 257,
        "payment": {
            "id": "TEST_155",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-13T12:35:49+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 50000,
                "currency": "NGN"
            },
            "description": "TEST_155"
        },
        "operation": {
            "id": 258000003164,
            "type": "refund",
            "status": "decline",
            "date": "2019-02-15T13:36:28+0000",
            "created_date": "2019-02-15T13:36:27+0000",
            "request_id": "354c11cdc403a2",
            "sum_initial": {
                "amount": 10000,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
        },
        "signature": "1aw64dc0nH3bKt4XJr8F6UXhC352gaSGEvSrHz8zsg4mOR3kcHGRYAxYPI9sqQ57/2KWDwhjfNf2XY2ZuDMovg=="
    }

Here is an example of callback for a refund rejected due to refund amount in the request is more than init amount.

Related topics

The following topics might be useful when implementing payments through Gate:

Payout via Gate

General information

In the Flutterwave method, any payout follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to ECommPay URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the payout process is provided below.

Figure: Payout sequence when using Gate

  1. Customer orders a payout on the bank account.
  2. Merchant's web service sends to the appropriate ECommPay URL the refund request for processing by using Gate.
  3. The payment platform receives the request for the payout processing by using Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends to the web service response with request receipt confirmation and correctness check result.
  6. Processed request is sent to the Flutterwave service.
  7. The payout is processed on the Flutterwave side.
  8. The Flutterwave service sends the result notification to the ECommPay payment platform.
  9. The ECommPay payment platform sends a callback to the web service.
  10. The customer receives the payout processing results in the form specific to the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Flutterwave payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the Flutterwave method:
  1. You send payout requests by sending the v2/payment/flutterwave/payout request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object that contains general purchase information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—identifier
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer bank account number
      • bank_id—bank identifier
    • payment—object that contains purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. The currency of payout can only be one of the following currencies: GHS, KES, NGN, TZS, UGX, USD, ZAR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Flutterwave method must include general information about request, customer, account, and payment information:

Figure: Payout request example

{
  "general": {
    "project_id": 258,
    "payment_id": "flutterwave-payout-00118",
    "signature": "H6Q9ZfsreIyrOva9CuxO/34IignE3ZZEQepbpNmZM/V5jdk1ad2NN00PGrfdiBTfM0AFyL31CJtmVTIETtUBrA=="
  },
  "account": {
    "number": "0017704603",
    "bank_id": 308
  },
  "customer": {
    "id": "cust000001",
    "ip_address": "127.0.0.1"
  },
  "payment": {
    "amount": 1000,
    "currency": "NGN",
    "description": "payout"
  }
}

Callback format

The Flutterwave method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

Figure: Example of a successful payout callback

{
        "project_id": 258,
        "payment": {
            "id": "flutter-wave-payout-00118",
            "type": "payout",
            "status": "success",
            "date": "2019-02-15T06:52:42+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 1000,
                "currency": "NGN"
            },
            "description": "payout"
        },
        "account": {
            "number": "0017704603"
        },
        "customer": {
            "id": "cust000001"
        },
        "operation": {
            "id": 3950000003217,
            "type": "payout",
            "status": "success",
            "date": "2019-02-15T06:52:42+0000",
            "created_date": "2019-02-15T06:48:39+0000",
            "request_id": "b8dcdecbdd842017c91efd752a71a2afa790884b-70151ed2a85d685602a73045c2e07fdbf027182a",
            "sum_initial": {
                "amount": 1000,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": "53313",
                "date": "2019-02-15T06:48:40+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Qg9YTDQhe6VG4O9WtvtW4VqQRfWVb/iDs4z8TKuYGq1DA3sFCtBwKCxWXSjytuX+FpBqAiomhYD1GBGzo3HG1w=="
    }

Here is an example of callback with an information about successful 10.00 NGN payout for the cust000001 customer in the 258 project.

Figure: Example of a declined payout callback

{
        "project_id": 257,
        "payment": {
            "id": "flutter-wave-payout-0010",
            "type": "payout",
            "status": "decline",
            "date": "2019-02-06T12:34:37+0000",
            "method": "flutterwave",
            "sum": {
                "amount": 900,
                "currency": "NGN"
            },
            "description": "payout"
        },
        "account": {
            "number": "0017704603"
        },
        "customer": {
            "id": "cust000001"
        },
        "errors": [
            {
                "code": "3028",
                "message": "Insufficient funds on merchant balance",
                "description": "public: BALANCE_INSUFFICIENT_FUNDS"
            }
        ],
        "operation": {
            "id": 2591000003033,
            "type": "payout",
            "status": "decline",
            "date": "2019-02-06T12:34:37+0000",
            "created_date": "2019-02-06T12:34:36+0000",
            "request_id": "07ff210d268901074cbd161e8d75ac28b81b5c41-5b123cb84a1a55362c98b6fd801b682884576779",
            "sum_initial": {
                "amount": 900,
                "currency": "NGN"
            },
            "sum_converted": {
                "amount": 900,
                "currency": "NGN"
            },
            "provider": {
                "id": 1149,
                "payment_id": ""
            },
            "code": "3028",
            "message": "Insufficient funds on merchant balance"
        },
        "signature": "Y7PNifR1g7rBXJPBAGoypaBMg8ixa5LKmsyU3f3ZXjb0TgPD7X2zcgtRLrJmTIvlyqOTwaW1kXkr3VcrM0uz4Q=="
    }

Here is an example of callback for a payout rejected due to insufficient funds on merchant balance.

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Flutterwave method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.