Localization

Languages

To support both local developers and international partners, the Ethiopian Platform API provides documentation in:

• Amharic: Tailored for Ethiopian developers, ensuring accessibility in the local language. Available at https://api.birr-connect.com/am/docs.
• CRM English: Clear, concise English documentation for global partners and developers. Available at https://api.birr-connect.com/en/docs.

Ethiopian Context

The platform addresses unique challenges in Ethiopia to ensure seamless integration:

• Intermittent Internet:

  • Optimize API calls for low-bandwidth environments by using pagination and caching.
  • Implement retry logic with exponential backoff for transient network failures.
  • Provide offline fallback options, such as queuing payments for later submission.

• Legacy Banking Systems:

  • Support for older bank formats through standardized endpoints, ensuring compatibility with legacy infrastructure.
  • Handle variable response times from banks with timeout configurations and user-friendly error messages.

• Examples Using Local Currencies and Bank Formats:

  • All API examples use Ethiopian Birr (ETB) for amounts and follow local bank account formats (e.g., acc123 for account IDs).
  • Sample payloads reflect Ethiopian conventions, such as date formats (YYYY-MM-DD) and local transaction references (e.g., “Invoice #123”).

Example Transaction Response:

{
  "transaction_id": "txn456",
  "amount": 5000.0,
  "currency": "ETB",
  "date": "2025-01-02",
  "description": "Payment to Addis Merchant"
}

Example Payment Request:

curl -X POST https://api.birr-connect.com/v1/payments \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"account_id": "acc123", "amount": 1000.00, "recipient_account": "acc789", "reference": "Addis Invoice #123"}'