Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binhussen/yaya-wallet-webhook


https://github.com/binhussen/yaya-wallet-webhook

Last synced: 29 days ago
JSON representation

Awesome Lists containing this project

README

        



logo

yaya wallet webhook

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 yaya wallet webhook

> This repository provides a guide on integrating YaYa Wallet's incoming webhooks to receive real-time updates and automate reactions based on events in your YaYa Wallet account.

## 🛠 Built With

### Tech Stack

Server

### Key Features

- **Real-time Updates:** Receive immediate transaction information updates.
- **Automatic Reactions:** Trigger reactions in your backend based on YaYa Wallet events.
- **Secure Signature Verification:** Utilize HMAC with SHA256 for secure event verification.

(back to top)

### Webhook Payload Structure
The following example payload shows a webhook update information at the end of a transaction:

```sh
{
"id": "1dd2854e-3a79-4548-ae36-97e4a18ebf81",
"amount": 100,
"currency": "ETB",
"created_at_time": 1673381836,
"timestamp": 1701272333,
"cause": "Testing",
"full_name": "Abebe Kebede",
"account_name": "abebekebede1",
"invoice_url": "https://yayawallet.com/en/invoice/xxxx"
}
```

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:binhussen/yaya-wallet-webhook.git
```

### Install

Install this project with:
```sh
npm install
```

### Usage

To run the project, execute the following command:
```sh
npm start
```

### Run tests

To run tests, run the following command:

```sh
npm test
```

(back to top)

## 👥 Authors

👤 **binhussen**

- GitHub: [@binhussen](https://github.com/binhussen)
- Twitter: [@binhussens](https://twitter.com/binhussens)
- LinkedIn: [@binhussen](https://www.linkedin.com/in/binhussen)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project...

(back to top)

## 🙏 Acknowledgments

I would like to thank for yaya [help center](https://docs.yayawallet.com/hc/main/articles/1701265610-webhooks)

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.