支持真实调用

代理钱包 · 孟加拉国

bKash Agent API

bKash 代理/商户钱包（孟加拉国）—— OTP 登录、余额、近期交易、搜索、分页历史、PDF 对账单，以及代理→客户的 Cash-In 转账。

14 个端点真实调用成功扣 1 积分

沙箱 · 请求

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

沙箱示例：不联系服务商、不发送短信、不转移资金、不扣除积分。

API 参考文档

清楚了解可调用的接口。

请求方法、路径和参数规则与控制台使用同一份目录。展开端点即可查看请求字段。

钱包认证

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. 敏感字段 · 请勿放入 URL 格式: `^\d{4,8}$`
`otp`必填	string	JSON 请求体 Digits of the SMS OTP. 敏感字段 · 请勿放入 URL 格式: `^\d{4,8}$`
`otpHash`必填	string	JSON 请求体 The trailing hash string of the OTP SMS. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[A-Za-z0-9._~+/=-]{8,512}$`
`pageSize`可选	integer	查询参数范围: 1 … 50

GET

/transaction-search

Search transactions by id, amount or counterparty

支持真实调用

/api/sandbox/bkash-agent/transaction-search

GET transaction-search · 参数
参数	类型	规则与传递方式
`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. 敏感字段 · 请勿放入 URL 格式: `^[A-Za-z0-9._~+/=-]{8,512}$`
`searchKey`必填	string	查询参数 Transaction id, amount or counterparty number. 长度: 1 … 64

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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^[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. 敏感字段 · 请勿放入 URL 格式: `^\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. 敏感字段 · 请勿放入 URL 格式: `^[A-Za-z0-9._~+/=-]{8,512}$`
`amount`必填	decimal	JSON 请求体范围: 1 … ∞ 小数位数: 2
`pin`必填	string	JSON 请求体 Wallet PIN. 敏感字段 · 请勿放入 URL 格式: `^\d{4,8}$`
`businessWallet`可选	string	JSON 请求体 Target business wallet. Omit it to use the wallet bound to the agent. 格式: `^01\d{9}$`

端点标识和服务商专用描述保留英文，以对应 API 协议。

在沙箱中试用

发起一个可检查的请求。

控制台默认进入沙箱，请仅使用公开测试值。切换到真实模式会改变请求目标，并可能使用真实账户和资金。

加载中…

沙箱

将探索测试、账户权限和计费清晰分开。

从第一次请求到真实连接。

无需登录，先行探索
选择 API，使用文档中的测试值调用沙箱。模拟响应不会转移资金，也不会联系银行。
创建网关账户
使用 Google 登录，获得 1,000 欢迎积分并创建 API 密钥。这只登录网站，不会登录钱包。
准备好后再连接
对于已支持的真实 API，请单独完成钱包登录。真实请求成功扣 1 积分，失败不扣费。

1,000 欢迎积分 · 无需银行卡

轻松起步，费用清晰。

10 美元购买 10,000 积分。真实请求成功扣 1 积分，失败和沙箱调用不扣费。购买积分不会解锁仅沙箱的接口。

购买 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 钱包登录后，其会话会关联到你的网站账户。其他网站用户不能接管该钱包关联。请安全保存返回的钱包令牌，并在服务商会话过期后重新认证。

在第一次请求前，明确边界。

开始前，你可能想了解。

沙箱会使用真实账户吗？

不会。沙箱使用固定模拟响应和公开测试凭据，不会联系金融服务商、发送验证码或转移资金。

所有 API 都能真实调用吗？

不能。只有标注支持真实调用的接口具有真实上游。其他接口仅支持沙箱，在真实模式下返回 LIVE_ACCESS_NOT_ENABLED。如需开通，请联系我们。

什么时候会扣除积分？

每次成功的真实调用扣 1 积分，失败调用和沙箱调用免费。请查看 X-Credits-Charged，不要仅凭 HTTP 状态判断扣费。如果出现 X-OBG-Settlement: unknown，表示计费结果尚未确定：X-Credits-Charged: 0 不能证明没有扣款。请先查询用量并核对结果，再考虑重试。

Google 登录会连接我的钱包吗？

不会。Google 登录管理网站账户、积分和 API 密钥。钱包登录是独立且明确的流程，仅可用于已支持的接口和你有权使用的账户。

bKash Agent API

清楚了解可调用的接口。

钱包认证

账户与活动

对账单

转账

发起一个可检查的请求。

从第一次请求到真实连接。

无需登录，先行探索

创建网关账户

准备好后再连接

轻松起步，费用清晰。

把接口接入你的代码。

沙箱

支持真实调用

开始前，你可能想了解。

继续探索。

Nagad Uddokta

EasyPaisa (Phoenix)

ACB ONE