Chimoney is your gateway to efficient cross-border payments, multi-currency wallets, and global payouts. Experience secure, real-time transactions across 130+ countries with our scalable API solutions.

Seamless Cross-Border Payments, Payouts, and Multi-Currency Wallets API

large_Chimoney.io OG.png

medium_Chimoney.io OG.png

small_Chimoney.io OG.png

thumbnail_Chimoney.io OG.png

Chimoney.io OG.png

large_Reeple Blog.png

medium_Reeple Blog.png

small_Reeple Blog.png

thumbnail_Reeple Blog.png

Reeple Blog.png

## Simplifying Remittances for Africa

**[Reeple.ai](https://www.reeple.ai/)** is on a mission to simplify remittances for Africans living abroad, addressing the challenges they face in supporting their families and communities back home. With millions of dollars flowing into Sub-Saharan Africa annually, Reeple saw an opportunity to offer a user-friendly platform with transparent pricing and competitive exchange rates, empowering individuals in the diaspora to make a meaningful impact.

## Identifying the Challenge
Africans in the diaspora face significant hurdles when sending money back home. High transaction fees, extended processing times, and a lack of transparency are common frustrations. Despite the substantial remittances reaching Sub-Saharan Africa, valued at $54 billion in 2023 according to World Bank data, many challenges persist for both senders and recipients.

Traditional remittance channels often impose steep transaction fees, averaging around 7.9% for a $200 remittance to Africa – notably higher than the global average of 6.8%. Additionally, the prolonged processing times associated with these methods can result in delays in urgent financial assistance. Recognizing these challenges, Reeple is dedicated to addressing them and is actively working to make remittances quicker, more affordable, and more dependable for its users.

## Reeple’s Solution
Reeple is dedicated to simplifying the remittance process by prioritizing simplicity, affordability, and efficiency. Here’s how Reeple’s innovative solution addresses common challenges:

- **No Transaction Fees:** Users can send payments for the diaspora to African countries effortlessly with no transaction fees. Their loved ones receive the full value they deserve, without any deductions.

- **Real-time Tracking:** Users are able to stay informed every step of the way with Reeple’s real-time transfer tracking feature. 

- **Global Reach:** Users can secure international clients by accepting payments in Canadian Dollars, a currency that offers financial freedom and investment opportunities.

- **Swift Withdrawals:** It allows users to receive their hard-earned Canadian Dollars directly and swiftly and also ensures that withdrawals are processed efficiently.




## Chimoney Implementation and Integration

Reeple enhances its services by utilizing Chimoney's infrastructure, specifically including:

- **[Chimoney’s Interac Collection API](https://chimoney.readme.io/reference/post_v0-2-payment-initiate-1)**: This enables the secure and efficient collection of funds from Canadian users looking to remit. 

- **[Chimoney’s Cross-border Payment Infrastructure and API](https://chimoney.io/payouts/)**: This facilitates smooth cross-border fund transfers, ensuring that funds sent from Canada reach their intended recipients in Africa reliably and securely.


## Insights from Reeple's CEO
> "We understand the challenges faced by Nigerians abroad who want to send money home securely and efficiently. We also see how hard they work to support their loved ones back home, and believe they don’t have to do this at an exorbitant expense" says **Tomi Kolawole, CEO & Co-founder at Reeple**. "Our mission is to provide a transparent and cost-effective solution that empowers them to do just that."

## Empowering Economic Development
Reeple is empowering individuals to support their families and contribute to economic development in their home countries. As Reeple continues to innovate and expand its reach, the future of remittances looks brighter than ever.

Visit **[Reeple's](https://www.reeple.ai/)** website to learn more and start sending money to Africa with confidence, experiencing the convenience and affordability of their remittance platform firsthand.



Discover how Reeple streamlines remittance for Africans abroad with its user-friendly platform, offering transparent pricing and competitive rates. Integrated with Chimoney's API, Reeple ensures swift, secure, and cost-effective money transfers, empowering users to support their families back home. Experience hassle-free remittance today!


Customer Success Story: Reeple.ai's Remittance Solution for Africans Powered by Chimoney

large_Osca.png

medium_Osca.png

small_Osca.png

thumbnail_Osca.png

Osca.png


We're excited to announce our community partnership with [OSCA Nairobi](https://twitter.com/osca_nairobi?lang=en) a chapter of [Open Source Community Africa](https://oscafrica.org/)! OSCA Nairobi is a community for open-source lovers, enthusiasts, advocates, and experts within and across Kenya, aiming to increase the rate of credible contributions by Kenyan software developers, designers, writers, and everyone involved in the tech ecosystem to open-source projects locally and globally. 

## Empowering Developers, Promoting Innovation
Both Chimoney and OSCA Nairobi share a strong commitment to empowering developers and strengthening the open-source community.  This collaboration focuses on:

- **Fueling Open-Source FinTech Innovation:** Fostering the creation of transparent and iterative solutions within a collaborative environment.

- **Empowering Developers with Chimoney Tools:** Providing developers with the tools and support they need to learn and build open-source payment solutions leveraging the [Chimoney API](https://chimoney.readme.io/reference/getting-started-with-your-api).

Through a series of upcoming workshops, events, and culminating in an exciting **open-source developer challenge**, Chimoney and OSCA Nairobi will empower developers to come up with and solve real-world challenges in the global payments space.

## Benefits of the Partnership
- **[Exclusive access to the Chimoney App:](https://chimoney.app/download)** OSCA Nairobi members will get exclusive access to the Chimoney App allowing them to send and receive payments globally via multi-currency wallets and join and be part of global communities like [ISIC](https://www.isic.org/) with member benefits.
- **Comprehensive support**:  Through workshops, events, office hours and API documentation guidance we will help developers build open-source solutions with the [Chimoney API](https://chimoney.io/).
- **Rewards and Recognition:** Developers who build outstanding solutions will be rewarded for their contributions and will get a chance to present and get support from Chimoney’s CEO, **Uchi Uchibeke**.

## Impact
Our partnership directly with OSCA Nairobi aligns with our aim of promoting financial inclusion and unlocking equal economic opportunities for all. By getting access to the [Chimoney App](https://chimoney.app/download) which is built for communities, OSCA members get access to: 

- Send and receive money globally.
- Utilize multi-currency wallets for easier international transactions.
- Benefits from global communities like ISIC, including global travel discounts.

Through our combined workshops and developer challenge with OSCA Nairobi we aim to equip developers from diverse backgrounds to solve real-world payment challenges. This inclusive approach not only fuels economic prospects for developers but also leads to solutions that directly address the needs of unbanked communities.  Furthermore, the open-source environment fosters transparency, rapid iteration, and collaboration, leading to more accessible and inclusive financial solutions. 

## Hear from the Organizers
>"We're excited to partner with OSCA Nairobi in our aim to drive innovation within the open-source fintech space. This partnership is an exciting opportunity for developers to learn, grow, and we can’t wait to witness the amazing solutions that will be created" - **Chimoney Team**

>"We're thrilled to collaborate with Chimoney to support developers and contribute to the growth of the open-source fintech ecosystem. This partnership opens up new opportunities for our members to build their skills and be a part of a greater initiative to promote financial inclusion" - **OSCA Nairobi Team**

## Stay Tuned!
Be sure to follow us on our social channels for more exciting updates!
- **Chimoney:** [LinkedIn](https://www.linkedin.com/company/chimoney/) and [Twitter](https://twitter.com/chimoney_io)
- **OSCA Nairobi:** [Twitter](https://twitter.com/osca_nairobi?lang=en) and [Discord](https://bit.ly/osca-dis)


Chimoney teams up with OSCA Nairobi to boost innovation in open-source fintech. We are empowering developers, to build fintech solutions in the payment world. Keep an eye out for more updates on events and projects!








Chimoney Partners with OSCA Nairobi to Promote Open-source Innovation in Global Payments

large_Umuzi Case study.png

medium_Umuzi Case study.png

small_Umuzi Case study.png

thumbnail_Umuzi Case study.png

Umuzi Case study.png

### Introduction

For many young people in Africa and beyond, the promise of a better life doesn’t lie in traditional higher education. Tuition fees are high, learning is often theoretical, and too many graduates struggle to find jobs that match their skills.  

[**Umuzi**](https://www.umuzi.org/), a South Africa–based organization, is changing that story by offering a transformative alternative. Its 12-month, paid training program equips young people with the practical skills needed to step into high-value careers in tech and the creative industries.  

The model is hands-on, project-based, and shaped by the real needs of leading employers. As a result, more than **80% of Umuzi graduates** secure top roles with top-tier companies, building sustainable futures for themselves.  

---

### The Challenge: Scaling Support Beyond Borders

To make the program truly accessible, Umuzi goes beyond just teaching. It ensures learners can show up fully by covering critical needs like data, airtime, and travel fares.  

But as Umuzi expanded beyond South Africa into **Nigeria, Kenya, and the Philippines**, paying out these stipends became a real bottleneck. Cross-border transfers were slow, with payments often delayed for days. They were also expensive, as fees ate into funds meant for learners. And above all, they were inconsistent, with no reliable way to support students in multiple countries at once.  

For Umuzi’s team, valuable time was being lost chasing payment fixes instead of supporting learners.  

---

### The Solution: A Partner Who Understood the Mission

Umuzi first heard about [**Chimoney**](https://chimoney.io/) through an industry recommendation, and the fit was clear from the start. What sealed the partnership was the platform’s ease of use and the dedicated support the team received throughout the process.  

> *“The Chimoney team was incredibly supportive and made a great effort to ensure that we were seamlessly onboarded.”*  
> — **Hloni Letuka, Senior Partner, Umuzi**  

With Chimoney, sending payouts to learners became quick, reliable, and flexible. Instead of being stuck in delays, the team could send funds instantly, and learners could choose the payment method that worked best for them from mobile money to airtime.  

---

### The Outcome: Smooth Payments, Focused Learners

The results were immediate. The Umuzi team no longer wasted hours fixing payment issues, which meant more energy could go toward training and mentorship.  

Learners were able to receive support when they needed it most, giving them stability and peace of mind. And because Chimoney offered multiple payment options, each learner could choose the method that best fit their situation.  

For Umuzi, this meant less stress on operations and more focus on impact. For learners, it meant stability, flexibility, and the freedom to fully concentrate on their studies.  

#### Learner Feedback  

**Nigeria – Izundu Dan-Ikeh**  
> *“The platform is very user-friendly. I didn’t encounter any issues while navigating through the options. The support has been incredibly helpful, enabling me to purchase data and other essentials. It’s reduced my worries and let me dedicate more time to my studies.”*  

**Kenya – Anne Musau**  
> *“I’ve found Chimoney to be reliable and efficient. The funds I’ve received have helped me cover data costs, which are essential for attending online classes. This support has eased my stress, allowing me to focus on my studies and personal growth.”*  

---

### Closing: Impact and Partner Recommendation

> *“We highly recommend Chimoney for its speed, affordability, and diverse payout options. It’s the perfect solution for fast, cost-effective global payments.”*  
> — **Hloni Letuka, Senior Partner, Umuzi**  

For organizations seeking a reliable and efficient way to manage global payments, **[get started with Chimoney today](https://chimoney.io/)**!

Learm how Umuzi streamlined cross-border payouts for learners in South Africa, Nigeria, Kenya, and the Philippines using Chimoney’s bulk payout platform.

How Umuzi Transformed Global Payouts for Its Learners using Chimoney

large_Payment API 101 Managing User Accounts with Chimoney's API.png

medium_Payment API 101 Managing User Accounts with Chimoney's API.png

small_Payment API 101 Managing User Accounts with Chimoney's API.png

thumbnail_Payment API 101 Managing User Accounts with Chimoney's API.png

Payment API 101 Managing User Accounts with Chimoney's API.png

## Introduction

Cross-border payments have become increasingly popular and essential in today's global economy, benefiting both businesses and individuals. The Chimoney API addresses this need by offering payout and payment infrastructure. By using Chimoney, you can streamline cross-border payments, improve user experience, and expand your reach to over 130 countries.

This article showcases the key features of the Chimoney API and guides you through making your first Chimoney API call. For detailed examples and specific use cases, check out these blogs:

- [The Ultimate Guide to Simplifying Global Payouts for Your Business with API Solutions](https://chimoney.io/blogs/the-ultimate-guide-to-simplifying-global-payouts-for-your-business-with-api-solutions/)
- [Integrating Multicurrency Wallets: A Deep Dive into Multi-Currency Global Payouts](https://chimoney.io/blogs/integrating-multicurrency-wallets-a-deep-dive-to-multi-currency-global-payouts/)

Additionally, read about how Reeple is using our API for remittances to Africa in this [customer success story](https://chimoney.io/blogs/customer-success-story-reeple-s-seamless-remittance-solution-for-africans-powered-by-chimoney/). 

## What is Chimoney?

At its core, Chimoney is a provider of payment and payout infrastructure and an API, offering seamless cross-border payment solutions. Imagine a world where everyone, regardless of location or economic status, can easily receive payments and redeem them through international bank transfers, gift cards, airtime, and Mobile Money. This is precisely what Chimoney offers.

## What is the Chimoney API?
APIs _(Application Programming Interfaces)_ act as bridges allowing applications to communicate with each other. The Chimoney API enables the integration of Chimoney’s services into applications through various endpoints. It provides essential functionalities to streamline cross-border payments and improve user payment experiences via: 

- **Account and Sub-Account Management:** Create and manage user accounts and sub-accounts efficiently.
- **Multi-Currency Wallets:** Handle wallets that support multiple currencies seamlessly.
- **Global Payouts:** Facilitate payouts to over 130 countries with ease.
- **AI Invoice Generation:** Automatically generate invoices by writing a prompt.
- **Wallet and Account Transfers:** Perform transactions between different wallets and accounts.
- **Bill Payment:** Enable Canadian bill payment functionality within applications.
- **Interac Payouts and Payments**: Facilitate Payouts and collect Payments via Chimoney's Interac
- **Currency Conversions:** Manage conversions between various currencies effortlessly.
- **Payment Requests:** Initiate and manage payment requests effectively.
- **Redemption of Assets:** Redeem assets such as bank transfers and gift cards.


## Exploring Chimoney API Endpoints and Key Features

The Chimoney API is organized into several categories, each offering different Chimoney services:

#### Account Endpoints
- **Features:** Enable the creation and management of user accounts, retrieval of transaction details, and execution of account transfers.  
- **Example Endpoint:** [v0.2/accounts/transfer](https://chimoney.readme.io/reference/post_v0-2-accounts-transfer-1)


#### AI Endpoints
- **Features:** Utilize AI capabilities to automate the creation of invoices.                                   
- **Example Endpoint:** [v0.2/ai/invoice/generate](https://chimoney.readme.io/reference/post_v0-2-ai-invoice-generate)


#### Info Endpoints
- **Features:** Provide access to information such as exchange rates, Chimoney-supported countries and assets, and bank details.                                                                                                     
- **Example Endpoint:** [/v0.2/info/assets](https://chimoney.readme.io/reference/get_v0-2-info-assets-1)


#### Multi-Currency Wallets Endpoints
- **Features:** Enable the creation and management of wallets that support multiple currencies (CAD, USD, NGN). Facilitate transfers between wallets and other entities such as emails and phone numbers.                                                                                                                     
- **Example Endpoint:** [/v0.2/multicurrency-wallets/create](https://chimoney.readme.io/reference/post_v0-2-multicurrency-wallets-create)


#### Payment Endpoints
- **Features:** Enable the initiation and verification of payment requests, transactions, and payouts to various destinations, including banks, mobile money services, and gift cards.       
- **Example Endpoint:** [/v0.2/payment/initiate](https://chimoney.readme.io/reference/post_v0-2-payment-initiate-1)


#### Payout Endpoints
- **Features:** Support various types of payouts, such as bank transfers and gift cards.           
- **Example Endpoint:** [/v0.2/payouts/chimoney](https://chimoney.readme.io/reference/post_v0-2-payouts-chimoney-1)


#### Redeem Endpoints

- **Features:** Allow redemption of financial assets like airtime and gift cards.                           
- **Example Endpoint:** [/v0.2/redeem/any](https://chimoney.readme.io/reference/post_v0-2-redeem-any-1) 


#### Sub-Account Endpoints
- **Features:** Allow management of sub-accounts.                                                                               
- **Example Endpoint:** [/v0.2/sub-account/create](https://chimoney.readme.io/reference/post_v0-2-sub-account-create-1)

## Getting Started with Chimoney API

In this section, we'll guide you through the process of creating a Chimoney developer account, obtaining an API key, and initiating an API call with the Chimoney API.

### Step 1. Creating a Chimoney Developer Account

To begin integrating with the Chimoney API, you'll first need to create a developer account on the Chimoney platform. Follow these steps to get started:

1. **Visit the Chimoney Developer Portal:** Navigate to the Chimoney Developer Portal at [sandbox.chimoney.io](https://sandbox.chimoney.io).
![Pink Gradient Keep Going Desktop Wallpaper.png](/uploads/Pink_Gradient_Keep_Going_Desktop_Wallpaper_563e4dc80c.png)

2. **Create Account:** Click on create account to create your developer account and fill in your email address, and a password.
3. **Verify Your Email:** After signing up, Chimoney will send a verification email to the address you provided. Click the verification link in the email to confirm your account.
![Pink Gradient Keep Going Desktop Wallpaper (1).png](/uploads/Pink_Gradient_Keep_Going_Desktop_Wallpaper_1_d193749914.png)
4. **Complete Your Profile:** Once verified, log in to your Chimoney developer account and complete your onboarding. You can also opt to complete later by clicking on the _complete later_ button on the top right of the page.
![demo.png](/uploads/demo_36b4836823.png)

### Step 2. Obtaining an API Key

An API key is required to authenticate and authorize API requests to Chimoney. Here’s how you can obtain your API key:

1. **Navigate to Developers Tab:** Within the developer portal, create a new App.
![demo (1).png](/uploads/demo_1_f2cb69bf50.png)
![demo (3).png](/uploads/demo_3_019515b79c.png)
2. **Copy Your API Key:** Once you create a new App, your API Key will be generated. Copy the key securely as it will be used to authenticate your API requests.
![demo (4).png](/uploads/demo_4_70882be258.png)

### Step 3. Initiating API Calls with the Chimoney API

Now that you have your API key, you’re ready to start making API calls to Chimoney endpoints. Here’s a basic example of how to initiate an API call using Node.js:

#### Install Axios

First, you need to install the Axios in your project. You can do this using the following command:

```bash
npm install axios
```

After setting up your environment and installing Axios, you are ready to make your first call to the Chimoney API. The next step is to send a POST request to the Chimoney [Payout Chimoney](https://chimoney.readme.io/reference/post_v0-2-payouts-chimoney-1) endpoint, which allows the initiation of payouts. We'll explain each part of the code to ensure you understand how it works.

#### Import Axios

Start by importing the Axios library in your JavaScript file. Axios is a promise-based HTTP client for the browser and Node.js, which makes it easy to send asynchronous HTTP requests.

```js.
const axios = require('axios');
```

#### Configure Request Options

Define the options for the API request. The options include the HTTP method, the URL of the API endpoint, the headers, and the data to be sent.

- **Method:** Specify the HTTP method as 'POST' because we are sending data to create a new resource (initiate a payout).

- **URL:** Set the URL to the Chimoney Payout endpoint: [https://api-v2-sandbox.chimoney.io/v0.2/payouts/chimoney](https://api-v2-sandbox.chimoney.io/v0.2/payouts/chimoney). 

- **Headers:** Include the necessary headers:
  1. accept: The type of response data expected (in this case, JSON).
  2. content-type: The format of the data being sent (in this case, JSON).
  3. X-API-KEY: Your unique API key obtained from the Chimoney Developer Portal. Replace _YOUR_API_KEY_ with your actual API key.
 
 - **Data:** The data object contains the parameters required by the API. For the payout endpoint, you need to specify the `recipient's email` and the `amount in USD`. This data will be sent in the body of the POST request.

```js.
const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/payouts/chimoney',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '_YOUR_API_KEY_'
  },
  data: {
    chimoneys: [
      {
        email: 'test@gmail.com',
        valueInUSD: 10
      }
    ]
  }
};
```
> **Note:** Ensure you are calling the correct endpoint URL (sandbox or production). If you encounter issues, kindly verify that the appropriate endpoint is being used.

![demo (15) (1).png](/uploads/demo_15_1_4bb137117b.png)
#### Make the API Request
- Use Axios to send the request with the configured options. The `.request` method sends the HTTP request and returns a promise.

- **Then Method:** The `.then` method is used to handle the response when the request is successful. The response data is logged to the console.

- **Catch Method**: The `.catch` method is used to handle any errors that occur during the request. The error is logged to the console.

```js.
axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```

#### Complete Code Sample
Here’s the complete example code with additional comments to explain each part:

```js.
// Import the Axios library
const axios = require('axios');

// Configure the request options
const options = {
  method: 'POST', // HTTP method to use
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/payouts/chimoney', // API endpoint URL
  headers: { // HTTP headers to include
    accept: 'application/json', // Accept JSON response
    'content-type': 'application/json', // Sending JSON data
    'X-API-KEY': '_YOUR_API_KEY_' // Your Chimoney API key
  },
  data: { // Data to send in the request body
    chimoneys: [
      {
        email: 'test@gmail.com', // Recipient's email
        valueInUSD: 10 // Amount to payout in USD
      }
    ]
  }
};

// Send the API request
axios
  .request(options)
  .then(function (response) { // Handle successful response
    console.log(response.data); // Log the response data
  })
  .catch(function (error) { // Handle error
    console.error(error); // Log the error
  });
```
#### What to Expect
- When the API call is successful, you should see a response object in the console with details of the payout transaction like the example below
![demo (10).png](/uploads/demo_10_7388d10520.png)

- If there is an error (e.g., invalid API key, incorrect endpoint URL), the error details will be logged to the console.

## Conclusion
In the upcoming articles, we’ll explore the Chimoney API endpoints in greater detail. This concludes our initial setup guide for integrating with the Chimoney API. If you encounter any issues or have questions during the setup process, please reach out to us at [support@chimoney.io](support@chimoney.io) for assistance.

Happy coding with the Chimoney API!

Discover how to integrate with the Chimoney API in this introductory guide. Learn about Chimoney's payment solutions, key API endpoints, and step-by-step instructions for creating a developer account, obtaining an API key, and making your first API calls. 


Payment API 101: Getting Started with Chimoney's Integration and API

large_Payment API 102 Managing User Accounts with Chimoney's API.png

medium_Payment API 102 Managing User Accounts with Chimoney's API.png

small_Payment API 102 Managing User Accounts with Chimoney's API.png

thumbnail_Payment API 102 Managing User Accounts with Chimoney's API.png

Payment API 102 Managing User Accounts with Chimoney's API.png

## Introduction
The Chimoney API's Account Endpoints allow for the management of user accounts and transactions, from retrieving transaction details to transferring funds between accounts. These endpoints are essential for verifying transaction status, ensuring record accuracy, and resolving disputes in transactions, which ultimately enhances customer support and financial management. Additionally, they facilitate user interaction through public profile retrieval, allowing users to share their social and payment links.

This article will guide you through using the Chimoney API's Account Endpoints to manage user accounts and transactions. You'll learn how to retrieve transaction details, transfer funds, and handle other essential operations to enhance customer support and financial management in your application.

## Prerequisites
Before we begin, ensure you have the following:

- A Chimoney developer account
- Your API key from the Chimoney Developer Portal
- Node.js installed on your machine
- Axios library installed in your project

> If you haven't set up your Chimoney developer account yet, refer to our [previous article](https://chimoney.io/blogs/chimoney-guide-series-101-an-introduction-to-the-chimoney-api/) on how to get started with the Chimoney API.

## Introduction to the Account Endpoints
The Account Endpoints are designed to handle various operations related to user accounts and transactions. Here’s a brief overview of the Account Endpoints:

1. **Get Transaction Details by issueID:** Retrieves the details of a specific transaction using its unique identifier.
2. **Get Public Profile of a Chimoney User:** Fetches the public profile information of a Chimoney user. [Example of a user profile](https://profile.chimoney.io/IOjQ4fAHCFbELfKbpYZxmRke7392)
3. **Get All Transactions by Account:** Retrieves all transactions associated with a specific account.
4. **Get Single Transaction Detail:** Retrieves the details of a single transaction.
5. **Account Transfer:** Transfers funds from one account to another.
6. **Delete an Unpaid Transaction:** Deletes an unpaid transaction. 

## Integrating the Endpoints
In this section, we will explore how to integrate each of the Chimoney API's Account Endpoints into your application. 
> **Note:** Ensure you are calling the correct endpoint URL (sandbox or production). If you encounter issues, kindly verify that the appropriate endpoint is being used.

![demo (15).png](/uploads/demo_15_7309224ce8.png)
### 1. Get Transaction Details by issueID
**Endpoint:**
[POST /v0.2/accounts/issue-id-transactions](https://chimoney.readme.io/reference/post_v0-2-accounts-issue-id-transactions-1)

This endpoint allows you to retrieve the details of a specific transaction using its issueID. This is particularly useful when you need to verify the status or details of a transaction after it has been initiated.

**Application**
- Verify the details of a transaction to ensure it was processed correctly.
- Assist customer support in resolving queries related to specific transactions.

> Before we get started, you need to have an issueID. To get it you can initiate a test payout by following these steps:

- Visit the payout chimoney endpoint in the Chimoney API Documentation [here](https://chimoney.readme.io/reference/post_v0-2-payouts-chimoney-1).
![demo (14).png](/uploads/demo_14_349c27e058.png)
- Enter test details in the Body Params section;  `Recipient email address`, `Amount in USD to send`.
- Click the "Try It" Button, this will send a request to the Chimoney API and generate an issueID.
- After clicking "Try It", the issueID will be generated and displayed in the output console.
Copy the generated issueID.

#### Request Example
The code below makes a POST request to the Chimoney API using the Axios library in JavaScript. 
It sets up the request options in the options object and specifies the method as 'POST'. It provides the URL for the Chimoney API endpoint: [https://api-v2-sandbox.chimoney.io/v0.2/accounts/issue-id-transactions](https://api-v2-sandbox.chimoney.io/v0.2/accounts/issue-id-transactions). You will need to add your issueID at the end of this URL.

In the headers, include 'accept' as `application/json`, 'content-type' as `application/json`, and 'X-API-KEY' with your actual API key.
                                                                                                                                                           
```js.
const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/issue-id-transactions?issueID= ' //Enter issueID,
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': ' ' //Enter your API Key
  }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```
#### Sample Response
The response will include details of the specified transaction, such as the transaction amount, status, date, and any associated metadata. 

![demo (6).png](/uploads/demo_6_f74b7fd3de.png)

### 2. Get Public Profile of a Chimoney User
**Endpoint:**
[POST /v0.2/accounts/public-profile](https://chimoney.readme.io/reference/post_v0-2-accounts-public-profile-1)

This endpoint allows you to retrieve the public profile information of a Chimoney user including social media links.
[Example public profile page](https://profile.chimoney.io/IOjQ4fAHCFbELfKbpYZxmRke7392)

**Application**
- Display user profile information in your application.
- Build features that require user public information, such as user directories.

#### Request Example
Copy and paste the code below into your project where you need to make the API request. Replace 'user-id' in the data object with the actual user ID you want to query.

```js.
const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/public-profile',
   headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '_YOUR_API_KEY_'
  },
  data: { userId: ' ' } //Enter userID
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```
#### Sample Response
The response will contain the public profile information of the specified user, including their `payment data`, `social media links` , `username` and any other publicly available details.

![demo (12).png](/uploads/demo_12_bc31d77dc1.png)

### 3. Get All Transactions by Account
**Endpoint:**
[POST /v0.2/accounts/transactions](https://chimoney.readme.io/reference/post_v0-2-accounts-transactions-1)

This endpoint allows you to retrieve all transactions associated with a specific account. This is useful for generating account statements or for reviewing transaction history.

**Application**
- Generate detailed account statements for users.
- Review all transactions linked to a specific account for auditing purposes.

#### Request Example:
Enter the accountID whose transaction details you want to retrieve.

```js.
const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/transactions',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '_YOUR_API_KEY_'
  },
  data: { accountId: ' ' } //Enter accountID
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```
#### Sample Response
The response will list all transactions associated with the specified account, including details such as transaction IDs, dates, amounts, and statuses.
![demo (7).png](/uploads/demo_7_bf17b1b340.png)

### 4. Get Single Transaction Detail
**Endpoint:**
[POST /v0.2/accounts/transaction](https://chimoney.readme.io/reference/post_v0-2-accounts-transaction-1)

This endpoint allows you to retrieve the details of a single transaction using its transactionID. This is particularly useful for verifying individual transactions and ensuring they were processed correctly.

**Application**

- Verify individual transactions to ensure they were completed successfully.
- Analyze the specifics of a transaction for reporting or troubleshooting.

#### Request Example
Enter the Transaction ID [t_ID] of the specific transaction whose details you want to retrieve.

```js.
const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/transaction',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '_YOUR_API_KEY_'
  },
  data: { transactionID: 'transaction-id' }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```
#### Sample Response
The response will include detailed information about the specified transaction, such as the transaction amount, date, status, and any associated metadata. 

![demo (8).png](/uploads/demo_8_1df9ad86e6.png)

### 5. Account Transfer
**Endpoint:**
[POST /v0.2/accounts/transfer](https://chimoney.readme.io/reference/post_v0-2-accounts-transfer-1)

This endpoint allows you to transfer funds from one account to another. This can be used for various purposes such as internal fund transfers or sending money to another user within your application.

**Application**
- Facilitate transfers between user accounts within your application.
- Implement payment features that require transferring funds between accounts.

#### Request Example
Enter the recipient's ID for the person you intend to pay out to.

```js.
const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/transfer',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': ' ' //Enter _YOUR_API_KEY_
  },
  data: {receiver: ' '} //Enter the recipient's ID
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```
#### Sample Response
The response will confirm the successful transfer of funds between the specified accounts, including details such as the `payment link`, `redeem data`, `status`, `transfer amount`, `payment date`. 

![demo (11).png](/uploads/demo_11_5deca2e3c2.png)


### 6. Delete an Unpaid Transaction
**Endpoint:**
[POST /v0.2/acconts/delete-unpaid-transactions](https://chimoney.readme.io/reference/delete_v0-2-accounts-delete-unpaid-transaction-1)

This endpoint allows you to delete an unpaid transaction using its transactionID. This is useful for cleaning up pending transactions that were not completed or need to be canceled.

**Application**
- Clean up unpaid transactions.
- Cancel transactions that were initiated by mistake.

#### Request Example

```js.
const axios = require('axios');

const options = {
  method: 'DELETE',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/accounts/delete-unpaid-transaction?chiRef= ', //Enter  chiRef ID
  headers: {
    accept: 'application/json',
    'X-API-KEY': ' ' //Enter YOUR_API_KEY
  }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
  ```
  #### Sample Response
The response will confirm the successful deletion of the specified unpaid transaction, ensuring that it is removed from the transaction history.
![demo (9).png](/uploads/demo_9_bbce29f486.png)

## Conclusion
By following the provided examples and explanations, you should now be able to integrate these Chimoney Accounts endpoints into your application easily. 

Stay tuned for the next article in this series, where we will explore the AI endpoint of the Chimoney API. If you have any questions or need further assistance, please reach out to us at [support@chimoney.io](support@chimoney.io).

Happy coding with the Chimoney API!



Explore the Chimoney API's Account Endpoints in this guide, featuring detailed examples, use cases, and step-by-step integration instructions.








Payment API 102: Managing User Accounts with Chimoney's API

large_Blog cover 1.png

medium_Blog cover 1.png

small_Blog cover 1.png

thumbnail_Blog cover 1.png

Blog cover 1.png

## Introduction
Welcome to the Chimoney-Interledger integration guide! If you're looking to implement cross-border payments in your application, you're in the right place. This guide will walk you through every step of integrating Chimoney's Interledger-enabled payment services, from basic setup to sending your first payment.

## What is Interledger Protocol (ILP)?
The [Interledger Protocol (ILP)](https://interledger.org/developers/get-started/) is like a universal translator for payments. Just as the internet connects different computer networks, ILP connects different payment systems. This means you can send money across borders and between different types of payment systems seamlessly.

## What You'll Learn
By the end of this guide, you'll know how to:

- Set up your development environment
- Create Interledger wallet addresses for your users
- Send payments between Interledger wallets
- Handle common errors and edge cases

## Prerequisites
- A Chimoney developer account
- Your Chimoney API key
- Node.js and npm/yarn installed
- Axios for making HTTP requests

> If you haven't set up your Chimoney developer account yet, refer to this [**article**](https://chimoney.io/blogs/payment-api-101-getting-started-with-chimoney-s-integration-and-api/) on how to get started with the Chimoney API.

## Setting Up Your Project
**1. Create Your Project Directory**

Open your terminal and run these commands:

```
# create and enter project directory
mkdir chimoney-ilp-integration
cd chimoney-ilp-integration

# initialize npm project
npm init -y

# install required dependencies
npm install axios dotenv
```

**2. Set Up Environment Variables**

Create a .env file in your project root:
```
CHIMONEY_API_KEY=your_api_key_here
CHIMONEY_ENV=sandbox  # Change to 'production' when ready
```
**3. Create Your Project Structure**
![Screenshot from 2025-02-15 00-54-23.png](/uploads/Screenshot_from_2025_02_15_00_54_23_257e882d22.png)

**4. Configure Your Application**

Create `src/config.js`:

```
import dotenv from 'dotenv';
dotenv.config();

export const config = {
  apiKey: process.env.CHIMONEY_API_KEY,
  baseUrl: process.env.CHIMONEY_ENV === 'production'
    ? 'https://api-v2.chimoney.io/v0.2'
    : 'https://api-v2-sandbox.chimoney.io/v0.2',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': process.env.CHIMONEY_API_KEY
  }
};
```
## Creating Your Chimoney Service

Create `src/services/chimoneyService.js`:

```
import axios from 'axios';
import { config } from '../config.js';

class ChimoneyInterledgerService {
  constructor() {
    this.baseUrl = config.baseUrl;
    this.headers = config.headers;
  }

  async issueWalletAddress(userID, ilpUsername) {
    try {
      const response = await axios.post(
        `${this.baseUrl}/accounts/issue-wallet-address`,
        {
          userID,
          ilpUsername
        },
        { headers: this.headers }
      );
      return response.data;
    } catch (error) {
      this.handleError(error);
    }
  }

  async sendPayment(walletAddress, amount, subAccount) {
    try {
      const response = await axios.post(
        `${this.baseUrl}/payouts/interledger-wallet-address`,
        {
          interledgerWallets: [
            {
              interledgerWalletAddress: walletAddress,
              amountToDeliver: amount
            }
          ],
          subAccount
        },
        { headers: this.headers }
      );
      return response.data;
    } catch (error) {
      this.handleError(error);
    }
  }

  handleError(error) {
    if (error.response) {
      const errorMessage = error.response.data.message || 'API request failed';
      console.error('API Error:', errorMessage);
      throw new Error(errorMessage);
    }
    throw error;
  }
}

export default ChimoneyInterledgerService;
```

## Using the Service

Create `src/index.js`:

```
import ChimoneyInterledgerService from './services/chimoneyService.js';

async function main() {
  const chimoneyService = new ChimoneyInterledgerService();

  try {
    // Issue a new wallet address
    const wallet = await chimoneyService.issueWalletAddress(
      'user123',  // Your user's unique ID
      'john.doe'  // Desired ILP username
    );
    console.log('New wallet created:', wallet);

    // Send a payment
    const payment = await chimoneyService.sendPayment(
      wallet.data.walletAddress,  // Recipient's wallet address
      10,                         // Amount to send
      'your-subaccount-id'       // Your subaccount ID
    );
    console.log('Payment sent:', payment);
  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();
```
## Testing Your Integration

**Test Wallet Creation:**

```
// Test creating a wallet
const wallet = await chimoneyService.issueWalletAddress(
  'test-user-1',
  'test.user'
);
console.log(wallet);
```

**Test Sending Payment:**

```
// Test sending a small amount
const payment = await chimoneyService.sendPayment(
  'https://ilp-sandbox.chimoney.com/test.user',
  1,
  'your-subaccount'
);
console.log(payment);
```

## Common Errors and Solutions
**1. Authentication Errors**
```
{
  "status": "error",
  "message": "Invalid API key"
}
```
Solution: Double-check your API key in the .env file

**2. Invalid Wallet Address**
```
{
  "status": "error",
  "message": "Invalid wallet address format"
}
```
Solution: Ensure the wallet address follows the correct format: https://ilp-sandbox.chimoney.com/username

**3. Insufficient Funds**
```
{
  "status": "error",
  "message": "Insufficient funds in account"
}
```
Solution: Add funds to your Chimoney account or reduce the transfer amount

## Best Practices

**Error Handling**
- Always implement comprehensive error handling
- Log errors for debugging
- Provide meaningful error messages to users

**Security**
- Never commit your API keys
- Use environment variables
- Validate all input data

**Testing**
- Start with sandbox environment
- Test with small amounts first
- Test error scenarios

## Moving to Production

When you're ready to go live:

1. Change your environment to production:

```
CHIMONEY_ENV=production
```

2. Update your API key to the production key
3. Update the base URL in your requests to `https://api-v2.chimoney.io/v0.2`

## Need Help?
- Join the [Chimoney Developer Community](https://discord.com/invite/Q3peDrPG95)
- Contact support at support@chimoney.io

Remember to always test thoroughly in the sandbox environment before moving to production. 

Integrate seamless cross-border payments with Chimoney's Interledger-enabled services. Learn how to issue Interledger wallet addresses and send payments using Chimoney's API. Follow this step-by-step guide to set up, authenticate, and securely transact with Interledger Protocol.

Developer Toolkit - Your gateway to our API resources and developer tools

Get started with Chimoney API Docs

Quick start guide

Integration guides

Documentation

Tools and Resources

SDK Downloads

Postman Collection

Tutorials & Learning Materials

Case Studies

Customer Success Story: Reeple's Seamless Remittance Solution for Africans Powered by Chimoney

Chimoney Partners with OSCA Nairobi to Promote Open-source Innovation in Global Payments

How Umuzi Transformed Global Payouts for Its Learners using Chimoney

Community Support & Changelog