API

When you're ready to go live — i.e. start processing real payments via Fapshi instead of just testing — you need to make a few changes. These are the steps:

Once those changes are made, your integration should be running in “live mode” — real transactions, real money, etc.

Direct Pay lets you collect payments directly on your platform with the Fapshi API. To activate it for live transactions, you must apply through Fapshi Support.

Prerequisite

Before applying,

1. You must first implement Direct Pay in Sandbox mode on your platform and ensure it works correctly. This is required to demonstrate your integration before activation in live mode.
2. You must have a live website that explains what your business does and how your solution/platform works such that we can ascertain your use of the API.

Note: Direct Pay is only approved for absolutely necessary use cases (e.g. Mobile app) or use cases that would not work via Initiate Pay. So, before applying, make sure you fulfill this criteria.

How to Apply

To request Direct Pay activation, send an email to support@fapshi.com with the following details:

1. Your personal and business information
   • Your full name
   • Your Fapshi account email
   • Your business name (as registered on Fapshi)

2. Description of your platform

• Explain clearly how your platform works (or how it will work once launched).

3. Platform type

• State if it’s a web application or a mobile application.

4. Sandbox testing

• Confirm whether you have already implemented your solution using the sandbox environment.

5. Reason for choosing Direct Pay

• Explain why you prefer Direct Pay instead of Initiate Pay. Check this article to know the difference between direct pay and initiate pay:
  https://www.fapshi.com/en/help-and-support/direct-pay-vs-initiate-pay-all-you-need-to-know

To get your Live credentials (apiuser, apikey), you need to create a service in your Fapshi dashboard. Here’s how:

1. Log in to your Fapshi dashboard.
2. In the side menu, go to the Merchants dropdown.
3. Click “New Service”.
4. Fill in the required details:
   • Service name (e.g. the name of your app or website)
   • Domain name (the domain you own or intend to use) — you can use one you don’t yet own, but avoid using Fapshi’s domain (e.g. don’t use fapshi.com itself).
5. Once the service is created, at the bottom of the dashboard/service page, your apiuser and apikey for that service will be displayed. Copy these carefully. They are sensitive, especially the apikey.
6. Store the credentials securely (e.g. in an environment file or secure vault). Don’t hard-code them or commit them in public repos. Rotate keys if needed.

⚠️ Note: In Live mode, the payout/disbursement function may be off by default. You might need to contact Fapshi support to activate it once you’ve tested in the sandbox and are ready.

The Fapshi API offers two powerful methods for collecting payments: Direct Pay and Initiate Pay. Each serves distinct use cases, balancing control, ease of integration, and user experience. This article breaks down the differences, benefits, and ideal scenarios for using Direct Pay and Initiate Pay, helping you choose the right approach for your application. Whether you're building a custom payment flow or need a quick solution, Fapshi's API has you covered. For more details, check the official Fapshi API documentation.

Understanding Direct Pay

Direct Pay allows developers to initiate payments directly from a user's mobile wallet without redirecting them to an external page. With this method, you have full control over the payment form and user experience, building a seamless checkout process within your application. However, this comes with the responsibility of handling validations, user input, and the payment flow on your end. The Fapshi backend processes the transaction, ensuring security and reliability, while you manage the front-end experience.

Key Features of Direct Pay

• Full Customization: Design the payment form to match your brand and user interface.
• No Redirects: Users stay within your app or website, creating a frictionless experience.
• Developer Responsibility: You handle input validation, error handling, and transaction status verification.
• Use Case Flexibility: Ideal for apps requiring tailored payment flows, such as in-app purchases or integrated checkout systems.

How It Works

1. Your application collects payment details (e.g., phone number, amount) via a custom form.
2. The app sends a payment request to Fapshi's API using your apiuser and apikey for authentication.
3. Fapshi processes the request and prompts the user to confirm the transaction on their mobile wallet.
4. Upon completion, you receive a transId (transaction ID) with a status code of 200 for successful requests or a 4XX code with an error message for failures.
5. You can use the to check the transaction status (SUCCESSFUL or FAILED) via the API or receive updates through a configured webhook.