Acesso real disponível

Carteira de agente · Bangladesh

bKash Agent API

Carteira de agente/lojista bKash (Bangladesh) — login com OTP, saldo, transações recentes, busca, histórico paginado, extratos em PDF e transferência Cash-In de agente para cliente.

Testar no sandbox Demonstração guiada (inglês)

14 endpoints1 crédito / chamada real bem-sucedida

Sandbox · Requisição

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

Exemplo ilustrativo do sandbox. Nenhum provedor é contatado, SMS é enviado, valor é movimentado ou crédito é cobrado.

Referência da API

Conheça cada endpoint.

Métodos, rotas e regras vêm do mesmo catálogo usado pelo console. Abra um endpoint para ver seus campos.

Autenticação da carteira

POST

/login/request-otp

Send the login OTP by SMS

Acesso real disponível

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

POST login/request-otp · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Corpo JSON Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`phoneOperator`Obrigatório	string	Corpo 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

Acesso real disponível

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

POST login/verify-otp · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Corpo JSON Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`pin`Obrigatório	string	Corpo JSON Wallet PIN. Sensível · nunca em URLs Formato: `^\d{4,8}$`
`otp`Obrigatório	string	Corpo JSON Digits of the SMS OTP. Sensível · nunca em URLs Formato: `^\d{4,8}$`
`otpHash`Obrigatório	string	Corpo JSON The trailing hash string of the OTP SMS. Sensível · nunca em URLs Formato: `^[A-Za-z0-9+/=_-]{4,128}$`

Conta e atividade

GET

/balance

Wallet balance, or a peek at a destination wallet

Acesso real disponível

/api/sandbox/bkash-agent/balance

GET balance · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`msisdn`Opcional	string	Parâmetro de consulta Wallet to peek at (with serviceName=CASH_IN). Formato: `^01\d{9}$`
`serviceName`Opcional	string	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

Acesso real disponível

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

GET recent-transactions · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`pageSize`Opcional	integer	Parâmetro de consulta Intervalo: 1 … 50

GET

/transaction-search

Search transactions by id, amount or counterparty

Acesso real disponível

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

GET transaction-search · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`searchKey`Obrigatório	string	Parâmetro de consulta Transaction id, amount or counterparty number. Comprimento: 1 … 64

GET

/notification-history

Paged transaction feed (pageToken cursor)

Acesso real disponível

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

GET notification-history · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`pageSize`Opcional	integer	Parâmetro de consulta Intervalo: 1 … 50
`pageToken`Opcional	string	Parâmetro de consulta Cursor from the previous page (omit for the first page). Formato: `^[!-~]{1,128}$` Comprimento: 0 … 128

GET

/summary/daily

Daily transaction summary by type

Acesso real disponível

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

GET summary/daily · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`

GET

/summary/monthly

Monthly transaction summary

Acesso real disponível

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

GET summary/monthly · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`

Extratos

GET

/statement/metadata

Statement types and selectable date ranges

Acesso real disponível

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

GET statement/metadata · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`

GET

/statement/history

Statement requests and remaining quota

Acesso real disponível

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

GET statement/history · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`pageSize`Opcional	integer	Parâmetro de consulta Intervalo: 1 … 50
`pageToken`Opcional	string	Parâmetro de consulta Cursor from the previous page (omit for the first page). Formato: `^[!-~]{1,128}$` Comprimento: 0 … 128

POST

/statement/download

Queue a PDF statement (emailed to the agent)

Acesso real disponível

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

POST statement/download · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Corpo JSON Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`fromDate`Obrigatório	date	Corpo JSON `YYYY-MM-DD`
`toDate`Obrigatório	date	Corpo JSON `YYYY-MM-DD`
`type`Opcional	string	Corpo JSON Valores permitidos: `DETAILED_STATEMENT \| SUMMARY_STATEMENT`

fromDate ≤ toDate

Transferências

GET

/business-wallet

Business wallet bound to the agent (B2B target)

Acesso real disponível

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

GET business-wallet · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Parâmetro de consulta Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`

POST

/cash-in

Cash-In from the agent wallet to a customer wallet

Acesso real disponível

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

Movimenta fundos reais apenas em uma integração real compatível. Confirme destino e valor; envie uma Idempotency-Key única.

POST cash-in · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Corpo JSON Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`customerWallet`Obrigatório	string	Corpo JSON Customer wallet to credit. Formato: `^01\d{9}$`
`amount`Obrigatório	decimal	Corpo JSON Intervalo: 10 … ∞ Casas decimais: 2
`pin`Obrigatório	string	Corpo JSON Wallet PIN. Sensível · nunca em URLs Formato: `^\d{4,8}$`
`cashInType`Opcional	string	Corpo JSON Valores permitidos: `CASH_IN \| CASH_IN_VIA_QR`

POST

/b2b-transfer

B2B transfer to the bound business wallet

Acesso real disponível

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

Movimenta fundos reais apenas em uma integração real compatível. Confirme destino e valor; envie uma Idempotency-Key única.

POST b2b-transfer · Parâmetro
Parâmetro	Tipo	Regras e envio
`account`Obrigatório	string	Corpo JSON Agent wallet number (11 digits). Use uma carteira autorizada. No modo real, a identidade deve estar vinculada à sua conta do site pelo login da carteira. Formato: `^01\d{9}$`
`token`Obrigatório	string	Enviar em X-OBG-Token Session token from the login step. Prefer the X-OBG-Token header so it stays out of URLs. Sensível · nunca em URLs Formato: `^[A-Za-z0-9._~+/=-]{8,512}$`
`amount`Obrigatório	decimal	Corpo JSON Intervalo: 1 … ∞ Casas decimais: 2
`pin`Obrigatório	string	Corpo JSON Wallet PIN. Sensível · nunca em URLs Formato: `^\d{4,8}$`
`businessWallet`Opcional	string	Corpo JSON Target business wallet. Omit it to use the wallet bound to the agent. Formato: `^01\d{9}$`

Identificadores e descrições específicas do provedor são mantidos em inglês para corresponder ao contrato.

Testar no sandbox

Uma requisição que você pode examinar.

O console inicia no sandbox. Use apenas os valores públicos de teste. Mudar para Real altera o destino e pode usar contas e fundos reais.

Carregando…

Sandbox

Separe testes, acesso às contas e cobrança.

Da primeira requisição à conexão real.

Explore sem fazer login
Escolha uma API e use os valores de teste documentados. As simulações não movem dinheiro nem contatam bancos.
Crie sua conta na plataforma
Entre com Google, receba 1.000 créditos e crie uma chave API. Isso conecta você ao site, não a uma carteira.
Conecte quando estiver pronto
Nas APIs com acesso real, faça o login da carteira separadamente. Cada chamada real bem-sucedida custa um crédito; falhas não custam nada.

1.000 créditos de boas-vindas · sem cartão

Comece pequeno. Custo claro.

US$ 10 compram 10.000 créditos. Uma chamada real bem-sucedida usa um; falhas e sandbox não usam créditos. Comprar créditos não libera integrações somente sandbox.

Comprar 10.000 créditos

Guia de integração

Leve para o seu código.

Exemplos de sandbox usam valores públicos. Exemplos reais usam marcadores: mantenha credenciais no servidor e nunca as inclua no repositório.

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

Acesso real disponível

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"

Sessões reais do bKash se vinculam à sua conta do site após o login. Outro usuário não pode assumir esse vínculo. Guarde o token com segurança e autentique novamente quando a sessão expirar.

Limites claros antes da primeira requisição.

Algumas coisas que vale saber.

O sandbox usa contas reais?

Não. Usa respostas simuladas e credenciais públicas de teste. Não contata provedores financeiros, envia códigos OTP nem movimenta fundos.

Todas as APIs permitem chamadas reais?

Não. Apenas as integrações marcadas com acesso real têm um provedor conectado. As demais são somente sandbox e retornam LIVE_ACCESS_NOT_ENABLED no modo real. Fale conosco sobre o acesso.

Quando um crédito é cobrado?

Um crédito é cobrado por chamada real bem-sucedida. Falhas e sandbox são gratuitos. Consulte X-Credits-Charged, não apenas o status HTTP. Se houver X-OBG-Settlement: unknown, a cobrança está indefinida: X-Credits-Charged: 0 não comprova que nenhum crédito foi debitado. Consulte o histórico de uso e concilie antes de tentar novamente.

Entrar com Google conecta minha carteira?

Não. O Google gerencia sua conta do site, créditos e chaves API. O login da carteira é um fluxo separado para uma integração compatível e uma conta que você tenha autorização para usar.

bKash Agent API

Conheça cada endpoint.

Autenticação da carteira

Conta e atividade

Extratos

Transferências

Uma requisição que você pode examinar.

Da primeira requisição à conexão real.

Explore sem fazer login

Crie sua conta na plataforma

Conecte quando estiver pronto

Comece pequeno. Custo claro.

Leve para o seu código.

Sandbox

Acesso real disponível

Algumas coisas que vale saber.

Continue explorando.

Nagad Uddokta

EasyPaisa (Phoenix)

ACB ONE