Skip to content
Open
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
145 changes: 145 additions & 0 deletions submissions/Create-Interledger-wallet-address-Motunrayo/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Chimoney Interledger Wallet Address Setup Guide

## Generate a Interledger Wallet Address using Chimoney Sandbox API

> **Setup Guide:** This walkthrough will help you authenticate and use Chimoney’s
> `/accounts/issue-wallet-address` endpoint to generate an ILP wallet address for a user.

---

### **Step 1: Create a Sandbox Account and get Your API Key**

### 1. Go to [sandbox.chimoney.io](https://sandbox.chimoney.io)

Click *“Sign Up”* or *“Sign In”*.

📸 **Screenshot Example:**

![Chimoney Sandbox Sign Up](https://i.postimg.cc/Wz4ZYZVy/image.png)

### 2. Developer Dashboard

Once logged in, you'll land on the **Developer Dashboard**.
Navigate to the **Developers & API** section from the sidebar.

📸 **Screenshot Example:**

![Chimoney Developer Portal Navigation](https://i.postimg.cc/Nf99yBjR/image.png)

### 3. Create an App

Click **“Add New App”** and enter an App name.

Once created:

- Copy your **API Key**
- Copy your **User ID** (labelled as `Team ID`)
<br/>

📸 **Screenshot Example:**

![Create App and Copy API Key](https://i.postimg.cc/C19Z7QvR/image.png)

> You’ll use the `Team ID` as your `userId` in requests.

---



### **Step 2: Make Your First API Call**

### Prerequisites

- Chimoney [Sandbox](https://sandbox.chimoney.io) developer account
- Your **API key** from the Developer dashboard
- Your **Team ID** (used as `userId`)
- A unique **ilpUsername** (e.g. `jane.doe`)
- Postman or cURL for testing the endpoint

---
### 1. Set Up Authentication in Postman

- Open your collection or create a new **POST** request.
- Under **Headers** tab, add:

| Key | Value |
| ------------ | ---------------------- |
| X-API-KEY | `YOUR_SANDBOX_API_KEY` |
| Content-Type | `application/json` |

<br/>

📸 **Screenshot Example**

![Postman Header Setup](https://i.postimg.cc/dQdDvnH9/image.png)

### 2. Configure the Request

- **Method & URL**

```bash
POST <https://api-v2-sandbox.chimoney.io/v0.2.4/accounts/issue-wallet-address>
```

- **Body (raw JSON)**

```json
{
"userID": "your_team_id",
"ilpUsername": "jane.doe"
}
```

<br/>

📸 **Screenshot Example**

![Postman Request Body Setup](https://i.postimg.cc/Pfmf0JJ3/image.png)


### 3. Send & Verify

- **Click on **Send** in Postman**
- **Look for 200 OK response**

```json
{
"status": "success",
"message": "Wallet Address issued succesfully",
"data": {
"id": "",
"createdAt": "2025-07-22T22:09:21.756Z",
"publicName": "Public Name",
"url": "https://ilp-sandbox.chimoney.com/user",
"status": "ACTIVE",
"asset": {
"code": "USD",
"createdAt": "2024-08-24T19:57:56.102Z",
"id": "",
"scale": 2,
"withdrawalThreshold": null
},
"additionalProperties": []
}
}
```

<br/>

📸 **Screenshot Example**

![Postman Response](https://i.postimg.cc/0N3CLxZn/image.png)

### **4. Common Errors & Fixes**

| HTTP Status | Type | Code | Message | Likely Cause | Suggested Fix |
|-------------|------------------|--------------------------|-----------------------------------------------|-------------------------------------------|--------------------------------------------------|
| 400 | Validation Error | INVALID_REQUEST | The request parameters are invalid. | `userId` or `ilpUsername` is invalid or missing | Double-check the request body and field formats |
| 401 | Unauthorized | – | Unauthorized access | API key is missing or incorrect | Ensure `X-API-KEY` is present and valid in header |
| 500 | Server Error | INTERNAL_SERVER_ERROR | An internal server error occurred. | Issue on Chimoney’s end or malformed request | Try again later or contact Chimoney support |

### 5. Troubleshooting Tips

- Use your exact teamId as `userId` from the app settings — not a random string.
- If you get 401, re-copy the API key from the dashboard.
- Use a unique `ilpUsername` per user (you can reuse the same userId for multiple ILP addresses).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @motuncoded. Thanks for putting this together! It’s a good start, but there are a few things that would make the tutorial easier to follow and more polished:

  • Add a list of prerequisites so readers know what they need before starting.
  • The subheadings could be named more clearly to better guide the reader through each section.
  • The numbering is inconsistent. You started off with using “Step 1”, and then it became just plain numbers for the subheadings of the steps. Pick one style.
  • Add visuals where helpful, for example, a screenshot of the Chimoney API key generation screen to make steps easier to follow.
  • The flow is a bit off. There are no transition sentences or brief explanations at the start of each section, which makes it feel abrupt. Adding short notes to explain what the reader is doing and why would help.
  • The guide could use a short conclusion to wrap up the tutorial.
  • Linking to other helpful resources where applicable would make it more complete.
  • Check the formatting and structure so everything is consistent and tidy, which will make it easier to read.

Once these changes are made, the tutorial will be much smoother, beginner-friendly, and ready for merging.

Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Chimoney Create Interledger Wallet Address Tutorial

In this tutorial, you’ll learn how to use Chimoney’s create interledger wallet address endpoint to send money to an Interledger wallet address.

This guide will walk you through the process step-by-step, from setting up your account to making your first API call.


## Overview
Chimoney’s Interledger Wallet Address is a digital account associated with a user that enables seamless, secure, and instant cross-border transactions using the Interledger Protocol (ILP). This wallet address acts like a virtual bank account on the blockchain or digital asset network, allowing users to send and receive international payments efficiently.

### Purpose of the Tutorial
This tutorial is designed to help you set up your Chimoney account, obtain your API key, and make your first API call to create an Interledger wallet address.


## Tutorial Steps
This section will walk you through the step by step process to create an Interledger wallet address using Chimoney’s API.

### Step 1: Create a Sandbox Account & Get Your API Key
![Chimoney API Key Setup](./Create-Interledger-wallet-address-Motunrayo/assets/api-setup.gif)

1. Go to the [sandbox.chimoney.io](https://sandbox.chimoney.io) and sign up for a new account.
2. Once the account is created, log in to the Chimoney dashboard.
3. Navigate to the API section and generate a new API key. Make sure to save this key securely, as it’s needed to authenticate the API requests.
4. There is need `Team ID`, which is used as the `userId` in API requests.
5. Ensure a unique Interledger protocol `ilpUsername` (e.g., `jane.doe`) that will be used in the API requests.



### Step 2: Make Your First API Call

![Chimoney API Testing Setup](./Create-Interledger-wallet-address-Motunrayo/assets/postman-setup.gif)

_Remember to create a workspace to test your API calls in [Postman](https://postman.co/workspace/create)_



### 1. Set Up Authentication in Postman
1. Open Postman and create a new request.
2. In the request settings, go to the "Authorization" tab.
3. Select "API-KEY" as the type, X-API-KEY as the key and enter your API key in the "value" field.

### 2. Configure Request Body
1. Set the request method to **POST**.
2. Enter the following URL: `https://api-v2-sandbox.chimoney.io/v0.2.4/accounts/issue-wallet-address`
3. In the "Body" tab, select "raw" and choose "JSON" as the format.
4. Enter the following JSON payload:
```json
{
"userID": "user123",
"ilpUsername": "chimoney_user123"
}
```
Replace `userID` with the Team ID of the user and `ilpUsername` with the desired Interledger username.



### 3. Send & Verify
1. Click the "Send" button to make the API call.
2. If the request is successful with a 200 OK status, you will receive a response containing the new Interledger wallet address.

### 4. Common Errors & Fixes

- **Error 400: Bad Request**: This error indicates that the request payload is malformed. Ensure that you are sending a valid JSON payload with the required fields.
- **Error 401: Unauthorized**: This error occurs when the API key is missing or invalid. Double-check your API key and ensure it is included in the request headers.
- **Error 500: Internal Server Error**: This error is returned when there is an issue with the Chimoney API. If you encounter this error, try again later or contact Chimoney support.

### 5. Troubleshooting Tips
- Ensure that you are using the correct API endpoint and HTTP method.
- Double-check your request headers and payload for any errors.
- If you continue to experience issues, consult the [Chimoney API documentation](https://chimoney.readme.io/reference/post_v0-2-4-accounts-issue-wallet-address) or reach out to their support team for assistance.


Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# How Hackathon Organizers Can Automate Payouts with Chimoney

This article shows how hackathon organizers can use the Chimoney `accounts/issue-wallet-address` API to simplify and speed up prize payouts to participants around the world. By pre-issuing Interledger wallets, organizers can offer a smooth payout experience.


## The Challenge

Running a global hackathon comes with a lot of challenges, especially when it’s time to send out prizes. using traditional payment methods often mean:

- Asking for sensitive banking details from people in many countries.
- Managing slow and expensive international bank transfers.
- Excluding participants in countries with limited access to global payment.

These problems add extra work for organizers and delay winners from receiving their prizes.

## The Solution

Chimoney's `accounts/issue-wallet-address` API offers a better way. Instead of collecting payment details manually, hackathon platforms can automatically create an Interledger (ILP) wallet for each participant as they register.

This means every participant, no matter where they’re from, has a wallet ready to receive money instantly. This makes payouts fast, secure, and easy for everyone involved.


## Use Case

Let’s walk through a real-world example.

### Step 1: Registration and Wallet Creation

When someone signs up for the hackathon:

1. They fill in their basic info (like name and email).
2. Behind the scenes, the platform calls the Chimoney `/v0.2.4/accounts/issue-wallet-address` API.
3. The new wallet address is saved in the platform’s database and linked to the user’s profile.

With this, every participant gets a wallet without needing to do anything extra.

Check the setup guide to see how to use the API → [Setup Instructions](setup.md)


### Step 2: Announcing Winners and Sending Payouts

When winners are chosen:

1. The organizer picks the winners and prize amounts.
2. Instead of using slow manual transfers, they send the funds using Chimoney's payout options.
3. The money is sent directly to the Interledger wallets created earlier.

## Why use chimoney's interledger wallet address API

Using Chimoney’s `accounts/issue-wallet-address` API brings big advantages:

- Open to Everyone: People from anywhere can join.
- Fast and Automated: No need to collect bank details later.
- Fewer Headaches: Organizers don’t have to deal with sensitive data or tricky payment setups.