Telebirr Payment Gateway

Integrate Telebirr mobile money payments into your application

Telebirr Integration Overview

Telebirr is Ethiopia's leading mobile money service. Our API provides seamless integration with Telebirr's payment gateway for processing mobile money transactions.

Mobile Payments

Accept payments through Telebirr mobile app

Real-time Processing

Instant payment processing and notifications

Secure Integration

RSA encryption and secure API communication

Configuration Setup

Configure Telebirr credentials and settings for your project

POST/api/v1/telebirr/createConfigRequires Authentication

Request Body

{
  "projectId": 15,
  "MerchantAppId": "*************",
  "FabricAppId": "*************",
  "ShortCode": "*************",
  "AppSecret": "*************",
  "PrivateKey": "YOUR_PRIVATE_KEY",
  "notifyUrl": "https://yoursite.com/notify",
        "method": "payment.preorder",
        "tradeType": "Checkout",
        "version": "v1",
        "signType": "SHA256WithRSA",
        "api": "C2B"
}

cURL Example

curl -X POST "https://api.payment-gateway.com/api/v1/telebirr/createConfig" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": 15,
    "MerchantAppId": "*************",
    "FabricAppId": "*************",
    "ShortCode": "*************",
    "AppSecret": "*************",
    "PrivateKey": "YOUR_PRIVATE_KEY",
    "notifyUrl": "https://yoursite.com/notify",
        "method": "payment.preorder",
    "tradeType": "Checkout",
        "version": "v1",
    "signType": "SHA256WithRSA",
    "api": "C2B"
  }'

Create Payment Order

Create a new payment order for Telebirr processing

POST/api/v1/telebirr/createorderRequires Access Key

Request Body

{
  "title": "Product Purchase",
  "amount": "100.00",
  "telebirrConfigId": "2",
  "callback_info": "telebirr",
  "redirect_url": "https://yoursite.com/success",
  "notify_url": "https://yoursite.com/notify"
}

cURL Example

curl -X POST "https://api.payment-gateway.com/api/v1/telebirr/createorder" \
  -H "Authorization: Bearer YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Product Purchase",
    "amount": "100.00",
    "telebirrConfigId": "2",
    "callback_info": "telebirr",
    "redirect_url": "https://yoursite.com/success",
    "notify_url": "https://yoursite.com/notify"
  }'

Check Transaction Status

Retrieve the status of a specific transaction

POST/api/v1/telebirr/statusRequires Access Key

Request Body

{
  "transactionId": "17472956363011747295636301"
}

cURL Example

curl -X POST "https://api.payment-gateway.com/api/v1/telebirr/status" \
  -H "Authorization: Bearer YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "transactionId": "17472956363011747295636301"
  }'

Best Practices

Important considerations for Telebirr integration

Test with Sandbox

Always test your integration with Telebirr sandbox environment first

Handle Webhooks Properly

Implement idempotent webhook handling to avoid duplicate processing

Verify Signatures

Always verify webhook signatures to ensure request authenticity