Offramp Service Provider Integration

[manjik-rumsan]

We need to design a flexible API interface to integrate with various offramp service providers. This API will facilitate key functionalities such as KYC verification, crypto account management, crypto deposits, and offramps to mobile money or bank accounts. The design should accommodate multiple providers, starting with KotaniPay, and ensure seamless user experiences across different financial operations.

Key API Functionalities

1. Create KYC on Selected Offramp Provider
2. Verify KYC Status on Offramp Providers
3. Create Crypto Account in Offramp Provider
4. Deposit Crypto to Offramp Provider’s Crypto Account
5. Offramp Crypto to Mobile Money or Bank Accounts

---

Here are some example API endpoints designed with the help of CHATGPT.

API Endpoints and Data Definitions

1. Create KYC on Selected Offramp Provider

• Endpoint: POST /offramp/kyc
• Description: Initiates the KYC process for the user on the selected offramp provider.
• Input Data:

  {
  "provider": "string",        // e.g., "KotaniPay"
  "user_id": "string",         // Unique user identifier
  "full_name": "string",       // User's full name
  "document_type": "string",   // e.g., "Passport", "ID"
  "document_number": "string", // Document ID number
  "document_file": "string",   // Base64-encoded document
  "country": "string"          // Country of the user
  }

• Response Data:

  {
  "kyc_request_id": "string",  // Unique KYC request ID
  "status": "string"           // KYC request status (e.g., "submitted", "pending")
  }

---

2. Verify KYC Status on Offramp Provider

• Endpoint: GET /offramp/kyc/status
• Description: Verifies the status of the user's KYC process.
• Input Query Params:
  • kyc_request_id: (string) Unique KYC request ID.
• Response Data:

  {
  "kyc_request_id": "string",  // KYC request ID
  "status": "string",          // KYC status (e.g., "verified", "pending", "rejected")
  "remarks": "string"          // Additional details or rejection reason
  }

---

3. Create Crypto Account in Offramp Provider

• Endpoint: POST /offramp/crypto/account
• Description: Creates a crypto account/wallet on the selected offramp provider for the user.
• Input Data:

  {
  {
  "provider": "string",        // e.g., "KotaniPay"
  "user_id": "string",         // Unique user identifier
  "name": "string",            // Required: Name of the wallet
  "customAddress": "string",   // Optional: Custom public address for deposits
  "coin": "string",            // Required: Currency of the wallet (
  }

• Response Data:

  {
  "account_id": "string",      // Crypto account ID
  "wallet_address": "string"   // Crypto wallet address
  }

---

4. Deposit Crypto to Offramp Provider’s Crypto Account

• Endpoint: POST /offramp/crypto/deposit
• Description: Deposits cryptocurrency into the user’s crypto account on the selected offramp provider.
• Input Data:

  {
  "provider": "string",        // e.g., "KotaniPay"
  "account_id": "string",      // User's crypto account ID
  "amount": "number",          // Amount to deposit
  "crypto_asset": "string"     // Cryptocurrency type (e.g., "ETH", "BTC")
  }

• Response Data:

  {
  "deposit_id": "string",      // Unique deposit transaction ID
  "status": "string",          // Deposit status (e.g., "pending", "completed")
  "transaction_hash": "string" // Blockchain transaction hash (if applicable)
  }

---

5. Offramp Crypto to Mobile Money or Bank Account

• Endpoint: POST /offramp/crypto/offramp
• Description: Converts the deposited cryptocurrency into fiat and transfers it to the user’s mobile money or bank account.
• Input Data:

  {
  "provider": "string",         // e.g., "KotaniPay"
  "account_id": "string",       // User's crypto account ID
  "amount": "number",           // Amount to withdraw
  "currency": "string",         // Fiat currency type (e.g., "USD", "KES"
  "destination_type": "string", // "mobile_money" or "bank"
  "destination_account": {      // Destination details
    "account_number": "string",
    "bank_name": "string"       // If bank transfer
  }
  }

• Response Data:

  {
  "offramp_id": "string",           // Unique offramp transaction ID
  "status": "string",               // Offramp status (e.g., "pending", "completed")
  "fiat_amount": "number",          // Amount converted to fiat
  "mobile_money_ref": "string",     // Mobile money reference (if applicable)
  "bank_transaction_id": "string"   // Bank transaction ID (if applicable)
  }

---

Expected Outcome

Develop an API that seamlessly integrates with multiple offramp service providers, starting with KotaniPay. The API should enable users to:

• Complete KYC processes.
• Create and manage crypto accounts.
• Deposit cryptocurrencies.

• Offramp crypto to mobile money or bank accounts.

References

• KotaniPay Create Crypto Wallet API
• KotaniPay Withdraw API
• KotaniPay KYC API

[manjik-rumsan]

@raghav-rumsan I think we can have these api endpoints in rahat-core to manage the offramp. kotanipay is one of the offramp provider

[manjik-rumsan]

@nishu-rumsan we will be creating an issue for offramping based on the final decision of this discussion