Open Banking Gateway
Acceso real disponible

Monedero de agente · Bangladés

bKash Agent API

Monedero de agente/comercio bKash (Bangladés) — login con OTP, saldo, transacciones recientes, búsqueda, historial paginado, extractos en PDF y transferencia Cash-In de agente a cliente.

14 endpoints1 crédito / llamada real exitosa

Sandbox · Solicitud

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"
}'

Ejemplo ilustrativo del sandbox. No se contacta al proveedor, se envían SMS, se mueven fondos ni se cobran créditos.

Referencia de la API

Conoce cada endpoint.

Los métodos, rutas y reglas provienen del mismo catálogo que usa la consola. Abre un endpoint para ver sus campos.

Autenticación del monedero

POST
/login/request-otp

Send the login OTP by SMS

Acceso real disponible

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

POST login/request-otp · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Cuerpo JSON

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
phoneOperatorObligatoriostring

Cuerpo JSON

Mobile operator of the agent SIM.

  • Valores permitidos: Grameenphone | RobiAirtel | Banglalink | Teletalk | Airtel
POST
/login/verify-otp

Verify the OTP and issue a session token

Acceso real disponible

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

POST login/verify-otp · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Cuerpo JSON

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
pinObligatoriostring

Cuerpo JSON

Wallet PIN.

Sensible · nunca en URLs

  • Formato: ^\d{4,8}$
otpObligatoriostring

Cuerpo JSON

Digits of the SMS OTP.

Sensible · nunca en URLs

  • Formato: ^\d{4,8}$
otpHashObligatoriostring

Cuerpo JSON

The trailing hash string of the OTP SMS.

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9+/=_-]{4,128}$

Cuenta y actividad

GET
/balance

Wallet balance, or a peek at a destination wallet

Acceso real disponible

/api/sandbox/bkash-agent/balance

GET balance · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
msisdnOpcionalstring

Parámetro de consulta

Wallet to peek at (with serviceName=CASH_IN).

  • Formato: ^01\d{9}$
serviceNameOpcionalstring

Parámetro de consulta

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

  • Valores permitidos: TAP_FOR_BALANCE | CASH_IN
GET
/recent-transactions

Most recent transactions with full details

Acceso real disponible

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

GET recent-transactions · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeOpcionalinteger

Parámetro de consulta

  • Rango: 1 … 50
GET
/notification-history

Paged transaction feed (pageToken cursor)

Acceso real disponible

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

GET notification-history · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeOpcionalinteger

Parámetro de consulta

  • Rango: 1 … 50
pageTokenOpcionalstring

Parámetro de consulta

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

  • Formato: ^[!-~]{1,128}$
  • Longitud: 0 … 128
GET
/summary/daily

Daily transaction summary by type

Acceso real disponible

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

GET summary/daily · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
GET
/summary/monthly

Monthly transaction summary

Acceso real disponible

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

GET summary/monthly · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$

Extractos

GET
/statement/metadata

Statement types and selectable date ranges

Acceso real disponible

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

GET statement/metadata · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
GET
/statement/history

Statement requests and remaining quota

Acceso real disponible

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

GET statement/history · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
pageSizeOpcionalinteger

Parámetro de consulta

  • Rango: 1 … 50
pageTokenOpcionalstring

Parámetro de consulta

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

  • Formato: ^[!-~]{1,128}$
  • Longitud: 0 … 128
POST
/statement/download

Queue a PDF statement (emailed to the agent)

Acceso real disponible

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

POST statement/download · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Cuerpo JSON

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
fromDateObligatoriodate

Cuerpo JSON

  • YYYY-MM-DD
toDateObligatoriodate

Cuerpo JSON

  • YYYY-MM-DD
typeOpcionalstring

Cuerpo JSON

  • Valores permitidos: DETAILED_STATEMENT | SUMMARY_STATEMENT

fromDate ≤ toDate

Transferencias

GET
/business-wallet

Business wallet bound to the agent (B2B target)

Acceso real disponible

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

GET business-wallet · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Parámetro de consulta

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
POST
/cash-in

Cash-In from the agent wallet to a customer wallet

Acceso real disponible

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

Mueve fondos reales solo en una integración real compatible. Confirma el destino y el importe; envía una Idempotency-Key única.

POST cash-in · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Cuerpo JSON

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
customerWalletObligatoriostring

Cuerpo JSON

Customer wallet to credit.

  • Formato: ^01\d{9}$
amountObligatoriodecimal

Cuerpo JSON

  • Rango: 10 … ∞
  • Decimales: 2
pinObligatoriostring

Cuerpo JSON

Wallet PIN.

Sensible · nunca en URLs

  • Formato: ^\d{4,8}$
cashInTypeOpcionalstring

Cuerpo JSON

  • Valores permitidos: CASH_IN | CASH_IN_VIA_QR
POST
/b2b-transfer

B2B transfer to the bound business wallet

Acceso real disponible

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

Mueve fondos reales solo en una integración real compatible. Confirma el destino y el importe; envía una Idempotency-Key única.

POST b2b-transfer · Parámetro
ParámetroTipoReglas y envío
accountObligatoriostring

Cuerpo JSON

Agent wallet number (11 digits).

Usa un monedero autorizado. En modo real, su identidad debe vincularse a tu cuenta del sitio mediante el acceso al monedero.

  • Formato: ^01\d{9}$
tokenObligatoriostring

Enviar en X-OBG-Token

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

Sensible · nunca en URLs

  • Formato: ^[A-Za-z0-9._~+/=-]{8,512}$
amountObligatoriodecimal

Cuerpo JSON

  • Rango: 1 … ∞
  • Decimales: 2
pinObligatoriostring

Cuerpo JSON

Wallet PIN.

Sensible · nunca en URLs

  • Formato: ^\d{4,8}$
businessWalletOpcionalstring

Cuerpo JSON

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

  • Formato: ^01\d{9}$

Los identificadores y las descripciones específicas del proveedor se mantienen en inglés para coincidir con el contrato.

Probar en sandbox

Una solicitud que puedes examinar.

La consola empieza en sandbox. Usa solo los datos de prueba. Cambiar a Real modifica el destino y puede usar cuentas y fondos reales.

Sandbox

Separa las pruebas, el acceso a cuentas y la facturación.

De la primera solicitud a la conexión real.

  1. Explora sin iniciar sesión

    Elige una API y usa sus datos de prueba. Las respuestas simuladas no mueven dinero ni contactan con un banco.

  2. Crea tu cuenta de la plataforma

    Accede con Google, recibe 1.000 créditos y crea una clave API. Esto inicia sesión en el sitio, no en un monedero.

  3. Conecta cuando estés listo

    En las APIs con acceso real, completa el acceso al monedero por separado. Cada solicitud real exitosa cuesta un crédito; los fallos, ninguno.

1.000 créditos de bienvenida · sin tarjeta

Empieza poco. Coste claro.

10 USD compran 10.000 créditos. Una solicitud real exitosa usa uno; los fallos y el sandbox no consumen créditos. Comprar créditos no habilita integraciones solo sandbox.

Comprar 10.000 créditos

Guía de integración

Llévalo a tu código.

Los ejemplos de sandbox usan datos públicos. Los ejemplos reales usan marcadores: guarda las credenciales en tu servidor, nunca en el repositorio.

Sandbox

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"
}'

Acceso real disponible

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"

Las sesiones reales de bKash se vinculan a tu cuenta del sitio tras acceder al monedero. Otro usuario no puede apropiarse de ese vínculo. Guarda el token de forma segura y vuelve a autenticarte al caducar.

Límites claros antes de la primera solicitud.

Lo que conviene saber.

¿El sandbox usa cuentas reales?

No. Usa respuestas simuladas y credenciales públicas de prueba. No contacta proveedores financieros, envía códigos OTP ni mueve fondos.

¿Todas las APIs permiten solicitudes reales?

No. Solo las integraciones marcadas con acceso real tienen un proveedor conectado. Las demás son solo sandbox y devuelven LIVE_ACCESS_NOT_ENABLED en modo real. Contáctanos para consultar el acceso.

¿Cuándo se cobra un crédito?

Se cobra un crédito por llamada real exitosa. Los fallos y el sandbox son gratuitos. Consulta X-Credits-Charged, no solo el estado HTTP. Si aparece X-OBG-Settlement: unknown, el cobro no está resuelto: X-Credits-Charged: 0 no demuestra que no se haya descontado un crédito. Consulta el historial de uso y concilia antes de reintentar.

¿Acceder con Google conecta mi monedero?

No. Google gestiona tu cuenta del sitio, créditos y claves API. El acceso al monedero es un flujo separado para una integración compatible y una cuenta que tengas autorización para usar.

Sigue explorando.