Open Banking Gateway
اتصال فعلي متاح

محفظة وكيل · بنغلاديش

bKash Agent API

محفظة وكيل/تاجر bKash (بنغلاديش) — تسجيل دخول عبر OTP، الرصيد، المعاملات الأخيرة، البحث، السجل المُقسّم صفحات، كشوف الحساب بصيغة PDF، وتحويل Cash-In من الوكيل إلى العميل.

جرّب في البيئة التجريبيةعرض إرشادي (بالإنجليزية)
14 نقاط نهايةرصيد واحد لكل طلب فعلي ناجح

بيئة تجريبية · الطلب

curl · POST /login/request-otp
curl -X POST 'https://www.openbankinggateway.com/api/sandbox/bkash-agent/login/request-otp' \
  -H 'Content-Type: application/json' \
  --data '{
  "account": "01700000001",
  "phoneOperator": "Grameenphone"
}'

مثال تجريبي توضيحي. لا يجري الاتصال بمزوّد، ولا تُرسل رسائل، ولا تُنقل أموال، ولا يُخصم رصيد.

مرجع الواجهة

تعرّف على الطلبات المتاحة.

الأساليب والمسارات وقواعد المعلمات من الدليل نفسه الذي يشغّل وحدة الاختبار. افتح نقطة نهاية لعرض حقولها.

مصادقة المحفظة

POST
/login/request-otp

Send the login OTP by SMS

اتصال فعلي متاح

/api/sandbox/bkash-agent/login/request-otp

POST login/request-otp · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

جسم JSON

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
phoneOperatorمطلوبstring

جسم JSON

Mobile operator of the agent SIM.

  • القيم المسموحة: Grameenphone | RobiAirtel | Banglalink | Teletalk | Airtel
POST
/login/verify-otp

Verify the OTP and issue a session token

اتصال فعلي متاح

/api/sandbox/bkash-agent/login/verify-otp

POST login/verify-otp · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

جسم JSON

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
pinمطلوبstring

جسم JSON

Wallet PIN.

حساس · لا تضعه في الروابط

  • الصيغة: ^\d{4,8}$
otpمطلوبstring

جسم JSON

Digits of the SMS OTP.

حساس · لا تضعه في الروابط

  • الصيغة: ^\d{4,8}$
otpHashمطلوبstring

جسم JSON

The trailing hash string of the OTP SMS.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9+/=_-]{4,128}$

الحساب والنشاط

GET
/balance

Wallet balance, or a peek at a destination wallet

اتصال فعلي متاح

/api/sandbox/bkash-agent/balance

GET balance · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
msisdnاختياريstring

معلمة استعلام

Wallet to peek at (with serviceName=CASH_IN).

  • الصيغة: ^01\d{9}$
serviceNameاختياريstring

معلمة استعلام

TAP_FOR_BALANCE (own wallet) or CASH_IN (destination peek).

  • القيم المسموحة: TAP_FOR_BALANCE | CASH_IN
GET
/recent-transactions

Most recent transactions with full details

اتصال فعلي متاح

/api/sandbox/bkash-agent/recent-transactions

GET recent-transactions · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeاختياريinteger

معلمة استعلام

  • النطاق: 1 … 50
GET
/notification-history

Paged transaction feed (pageToken cursor)

اتصال فعلي متاح

/api/sandbox/bkash-agent/notification-history

GET notification-history · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeاختياريinteger

معلمة استعلام

  • النطاق: 1 … 50
pageTokenاختياريstring

معلمة استعلام

Cursor from the previous page (omit for the first page).

  • الصيغة: ^[!-~]{1,128}$
  • الطول: 0 … 128
GET
/summary/daily

Daily transaction summary by type

اتصال فعلي متاح

/api/sandbox/bkash-agent/summary/daily

GET summary/daily · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
GET
/summary/monthly

Monthly transaction summary

اتصال فعلي متاح

/api/sandbox/bkash-agent/summary/monthly

GET summary/monthly · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$

كشوف الحساب

GET
/statement/metadata

Statement types and selectable date ranges

اتصال فعلي متاح

/api/sandbox/bkash-agent/statement/metadata

GET statement/metadata · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
GET
/statement/history

Statement requests and remaining quota

اتصال فعلي متاح

/api/sandbox/bkash-agent/statement/history

GET statement/history · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeاختياريinteger

معلمة استعلام

  • النطاق: 1 … 50
pageTokenاختياريstring

معلمة استعلام

Cursor from the previous page (omit for the first page).

  • الصيغة: ^[!-~]{1,128}$
  • الطول: 0 … 128
POST
/statement/download

Queue a PDF statement (emailed to the agent)

اتصال فعلي متاح

/api/sandbox/bkash-agent/statement/download

POST statement/download · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

جسم JSON

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
fromDateمطلوبdate

جسم JSON

  • YYYY-MM-DD
toDateمطلوبdate

جسم JSON

  • YYYY-MM-DD
typeاختياريstring

جسم JSON

  • القيم المسموحة: DETAILED_STATEMENT | SUMMARY_STATEMENT

fromDate ≤ toDate

التحويلات

GET
/business-wallet

Business wallet bound to the agent (B2B target)

اتصال فعلي متاح

/api/sandbox/bkash-agent/business-wallet

GET business-wallet · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

معلمة استعلام

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
POST
/cash-in

Cash-In from the agent wallet to a customer wallet

اتصال فعلي متاح

/api/sandbox/bkash-agent/cash-in

ينقل أموالًا حقيقية في تكامل فعلي مدعوم فقط. أكّد الوجهة والمبلغ وأرسل Idempotency-Key فريدًا.

POST cash-in · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

جسم JSON

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
customerWalletمطلوبstring

جسم JSON

Customer wallet to credit.

  • الصيغة: ^01\d{9}$
amountمطلوبdecimal

جسم JSON

  • النطاق: 10 … ∞
  • المنازل العشرية: 2
pinمطلوبstring

جسم JSON

Wallet PIN.

حساس · لا تضعه في الروابط

  • الصيغة: ^\d{4,8}$
cashInTypeاختياريstring

جسم JSON

  • القيم المسموحة: CASH_IN | CASH_IN_VIA_QR
POST
/b2b-transfer

B2B transfer to the bound business wallet

اتصال فعلي متاح

/api/sandbox/bkash-agent/b2b-transfer

ينقل أموالًا حقيقية في تكامل فعلي مدعوم فقط. أكّد الوجهة والمبلغ وأرسل Idempotency-Key فريدًا.

POST b2b-transfer · المعلمة
المعلمةالنوعالقواعد وطريقة الإرسال
accountمطلوبstring

جسم JSON

Agent wallet number (11 digits).

استخدم محفظة مخوّلًا لك الوصول إليها. يجب ربط الهوية الفعلية بحساب الموقع عبر دخول المحفظة.

  • الصيغة: ^01\d{9}$
tokenمطلوبstring

أرسل عبر X-OBG-Token

Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs.

حساس · لا تضعه في الروابط

  • الصيغة: ^[A-Za-z0-9._~+/=-]{8,512}$
amountمطلوبdecimal

جسم JSON

  • النطاق: 1 … ∞
  • المنازل العشرية: 2
pinمطلوبstring

جسم JSON

Wallet PIN.

حساس · لا تضعه في الروابط

  • الصيغة: ^\d{4,8}$
businessWalletاختياريstring

جسم JSON

Target business wallet. Omit it to use the wallet bound to the agent.

  • الصيغة: ^01\d{9}$

تُحفظ المعرّفات وأوصاف المزوّد المتخصصة بالإنجليزية لتطابق مواصفات الواجهة.

جرّب في البيئة التجريبية

طلب يمكنك فحصه.

تبدأ وحدة الاختبار بالوضع التجريبي؛ استخدم قيم الاختبار العامة فقط. التبديل للوضع الفعلي يغيّر الوجهة وقد يستخدم حسابات وأموالًا حقيقية.

بيئة تجريبية

افصل بين التجربة وصلاحيات الحساب والفوترة.

من أول طلب إلى الاتصال الفعلي.

  1. استكشف دون تسجيل الدخول

    اختر واجهة واستخدم قيم الاختبار الموثقة. البيانات التجريبية لا تحرّك الأموال ولا تتصل بالبنوك.

  2. أنشئ حسابك في المنصة

    سجّل الدخول عبر Google لتحصل على 1,000 رصيد وتنشئ مفتاح API. هذا دخول للموقع، لا للمحفظة.

  3. اتصل عندما تكون مستعدًا

    للواجهات الفعلية المدعومة، أكمل دخول المحفظة بشكل مستقل. كل طلب ناجح يكلّف رصيدًا واحدًا، والفشل لا يكلّف شيئًا.

1,000 رصيد ترحيبي · دون بطاقة

بداية بسيطة وتكلفة واضحة.

10 دولارات تشتري 10,000 رصيد. الطلب الفعلي الناجح يستهلك واحدًا، والفشل والتجربة لا يستهلكان رصيدًا. شراء الرصيد لا يفتح التكاملات التجريبية فقط.

اشترِ 10,000 رصيد

دليل التكامل

أضفه إلى تطبيقك.

الأمثلة التجريبية تستخدم قيمًا عامة، والفعلية تستخدم عناصر نائبة. احتفظ ببيانات الاعتماد على خادمك ولا تضعها في المستودع.

بيئة تجريبية

curl · POST
curl -X POST 'https://www.openbankinggateway.com/api/sandbox/bkash-agent/login/request-otp' \
  -H 'Content-Type: application/json' \
  --data '{
  "account": "01700000001",
  "phoneOperator": "Grameenphone"
}'

اتصال فعلي متاح

curl · x-api-key
curl 'https://www.openbankinggateway.com/api/v1/bkash-agent/balance?account=<YOUR_WALLET_NUMBER>' \
  -H "x-api-key: $OBG_API_KEY" \
  -H "X-OBG-Token: $WALLET_TOKEN"

تُربط جلسات bKash الفعلية بحساب موقعك بعد الدخول. لا يمكن لمستخدم آخر الاستيلاء على هذا الربط. احفظ رمز المحفظة بأمان وأعد المصادقة عند انتهاء جلسة المزوّد.

حدود واضحة قبل أول طلب.

أمور تستحق المعرفة.

هل تستخدم البيئة التجريبية حسابات حقيقية؟

لا. تستخدم استجابات ثابتة وبيانات اختبار عامة، ولا تتصل بمزوّد مالي أو ترسل رمزًا أو تنقل أموالًا.

هل تدعم كل الواجهات الطلبات الفعلية؟

لا. الواجهات المعلّمة بالاتصال الفعلي فقط لها مزوّد متصل. غيرها تجريبية وتعيد LIVE_ACCESS_NOT_ENABLED في الوضع الفعلي. تواصل معنا للاستفسار عن الوصول.

متى يُخصم الرصيد؟

يُخصم رصيد واحد لكل طلب فعلي ناجح، والطلبات الفاشلة والتجريبية مجانية. راجع X-Credits-Charged بدلًا من حالة HTTP وحدها. إذا ظهر X-OBG-Settlement: unknown فنتيجة الفوترة غير محسومة؛ ولا يثبت X-Credits-Charged: 0 عدم حدوث خصم. راجع سجل الاستخدام وطابق النتائج قبل إعادة المحاولة.

هل يربط تسجيل Google محفظتي؟

لا. يدير تسجيل Google حساب الموقع والرصيد ومفاتيح API. دخول المحفظة عملية مستقلة وصريحة لتكامل مدعوم وحساب مخوّل لك استخدامه.

واصل الاستكشاف.