Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
FZFR committed Jul 24, 2024
1 parent d804ded commit 8ecbfe9
Show file tree
Hide file tree
Showing 6 changed files with 729 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
vendor/
*/.DS_Store
.vscode
86 changes: 84 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,84 @@
# Xendit-FOSSBilling
Xendit payment module for FOSSBilling
<div align="center">
<img src="https://cdn.fazza.fr/REDACTED/img/xendit-foss-banner.jpg" alt="Xendit for FOSSBilling">
<h1>Xendit Integration for FOSSBilling</h1>
<img src="https://img.shields.io/github/v/release/FZFR/Xendit-FOSSBilling">
<img src="https://img.shields.io/github/downloads/FZFR/Xendit-FOSSBilling/total">
<img src="https://img.shields.io/github/repo-size/FZFR/Xendit-FOSSBilling">
<img alt="GitHub" src="https://img.shields.io/github/license/FZFR/Xendit-FOSSBilling">
</div>

## Overview
Provide your [FOSSBilling](https://fossbilling.org) customers with a variety of payment options, including Credit/Debit cards, Bank Transfer, E-Wallets, and more through [Xendit](https://www.xendit.co).

> **Warning**
> This extension, like FOSSBilling itself, is under active development and is currently in beta. There may be stability or security issues, and it is not yet recommended for use in active production environments!
## Table of Contents
- [Overview](#overview)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [1). Extension directory](#1-extension-directory)
- [2). Manual installation](#2-manual-installation)
- [Configuration](#configuration)
- [Webhook Configuration](#webhook-configuration)
- [Usage](#usage)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)

## Installation

### 1). Extension directory
> Not yet implemented
>
>
### 2). Manual installation
1. Download the latest release from the [GitHub repository](https://github.com/FZFR/Xendit-FOSSBilling/releases)
2. Create a new folder named **Xendit** in the **/library/Payment/Adapter** directory of your FOSSBilling installation
3. Extract the archive you've downloaded in the first step into the new directory
4. Go to the "**Payment gateways**" page in your admin panel (under the "System" menu in the navigation bar) and find Xendit in the "**New payment gateway**" tab
5. Click the *cog icon* next to Xendit to install and configure Xendit

## Configuration
1. Access Xendit Settings: In your FOSSBilling admin panel, find "**Xendit**" under "**Payment gateways.**"
2. Enter API Credentials: Input your Xendit `API Key` and `Webhook Verification Token`. You can obtain these from your Xendit dashboard.
3. Configure Preferences: Customize settings like sandbox mode and logging as needed.
4. Save Changes: Remember to update your configuration.
5. Test Transactions (Optional): Test your gateway integration through a payment process.
6. Go Live: Switch to live mode to start accepting real payments.

## Webhook Configuration

To set up webhooks:

1. Log in to your Xendit dashboard.
2. Navigate to Settings > Webhooks.
3. Add a new webhook with the following URL:
`https://your-fossbilling-domain.com/ipn.php?gateway_id=payment_gateway_id`
(Replace `your-fossbilling-domain.com` with your actual domain)
4. Ensure the Webhook Verification Token in your Xendit settings matches the one in your FOSSBilling configuration.

## Usage
Once you've installed and configured the module, you can start using Xendit as a payment gateway in your FOSSBilling setup. Customers will now see Xendit as an option during the payment process based on the configuration you have set.

## Troubleshooting

- Check the logs at `library/Payment/Adapter/Xendit/logs/xendit.log` for detailed information on transactions and errors.
- Ensure your server's IP is whitelisted in Xendit's settings if you're experiencing connection issues.
- Verify that the API keys and Webhook Verification Tokens are correctly entered in the FOSSBilling configuration.


## Contributing
We welcome contributions to enhance and improve this integration module. If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix: `git checkout -b feature-name`.
3. Make your changes and commit them with a clear and concise commit message.
4. Push your branch to your fork: `git push origin feature-name` and create a [pull request](https://github.com/FZFR/Xendit-FOSSBilling/pulls).

## License
This FOSSBilling Xendit Payment Gateway Integration module is open-source software licensed under the [Apache License 2.0](LICENSE).

> *Note*: This module is not officially affiliated with [FOSSBilling](https://fossbilling.org) or [Xendit](https://www.xendit.co). Please refer to their respective documentation for detailed information on FOSSBilling and Xendit.
For support or questions, feel free to contact us at me@fazza.fr
15 changes: 15 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "fzfr/xendit-fossbilling",
"type": "library",
"authors": [
{
"name": "FZFR",
"email": "me@fazza.fr"
}
],
"require": {
"php": ">=8.0",
"ext-json": "*",
"monolog/monolog": "*"
}
}
173 changes: 173 additions & 0 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 8ecbfe9

Please sign in to comment.