MAINHACK

Viewing / Editing File: README.md

<h1 align="center">
<div align="center">
  <a href="http://chapa.co/" target="_blank">
    <img src="https://assets.chapa.co/assets/images/chapa-logo.svg" width="320" alt="Chapa Logo"/>
  </a>
  <p align="center">Official Laravel package for Chapa's API (Laravel 5,6,7,9,10,11)</p>
</div>
</h1>

If your are doing a Laravel project and want to integrate Chapa's payment
solution, this package would help big time.

Go to [Chapa](https://dashboard.chapa.co/) to signup and get your secret key

## Documentation

Please visit [Chapa](https://developer.chapa.co/docs/accept-payments/) for full documentation.

## Guide

Please visit [Developers Guide](https://developer.chapa.co/laravel-sdk/) for full guide and examples.

### Usage

You can check [this](https://github.com/Chapa-Et/sdk-examples/tree/master/chapa-laravel-example) sample Laravel code as a reference.

### Configuration

Open your .env file and add your public key, secret keys, and other environment variables like this:

```
CHAPA_SECRET_KEY=CHAPA-SECK-xxxxxxxxxxxxxxxxxxxxx-X
```

## Features

The current features have been implemented

- Initiate Payment
- Payment verification
- Create a Transfer
- Verify a Transfer
- Validate a Webhook Request
- Bulk Transfer
- Create Subaccount

## API Reference
### Create Subaccount

```https
  GET https://api.chapa.dev/v1/transaction/sub-accounts
```

### Collecting Customer Information

```https
  POST https://api.chapa.co/v1/transaction/initialize
```

### Verify Payments

```https
  GET https://api.chapa.dev/v1/transaction/verify/{tx-ref}
```

### Verify Transfers

```https
  GET https://api.chapa.dev/v1/transfers/verify/{tx-ref}
```

### Bulk Transfers

```https
  GET https://api.chapa.dev/v1/bulk-transfers
```

### Get Banks
The Get Banks API retrieves a list of banks available for transfers via the Chapa API. This is useful when you need to display a list of banks for users to select from or when you need bank codes for initiating transactions.

### Verify Webhooks
This function validates incoming webhook events from Chapa to ensure their authenticity. It checks the signature of the webhook against an expected signature, generated using the webhook payload and a secret key. If the signatures match, the webhook is considered valid.

#### Parameters:
- **`$request`** *(Illuminate\Http\Request)*: The incoming HTTP request containing the webhook payload and headers. The key header used for validation is:
  - **`x-chapa-signature`**: A header sent by Chapa containing the HMAC-SHA256 signature of the webhook payload. This signature is used to verify the authenticity of the webhook.

#### Returns:
- **`boolean`**:
  - `true`: If the webhook is valid (i.e., the signature matches).
  - `false`: If the webhook is invalid (i.e., the signature does not match).

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

### Security

If you discover any security related issues, please email kidusy@chapa.co instead of using the issue tracker.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: README.md

Server Info

System Features

User Info