1. Partner Flow
BPN OpenAPI
  • Get started
    • Introduction to BPN
    • Introduction to API
    • Architecture Overview
    • Authentication
    • Environments
    • Response envelope
    • Idempotency
  • Guides
    • Virtual Account
      • Virtual Account Overview
      • VA · Payin
      • VA · Statuses
      • VA · Payout
      • VA · RFI
      • VA · Currencies & limits
      • VA Opening
        • VND VA Opening
        • BRL VA Opening
    • Wallet
      • Wallet · Transfer
      • Wallet · Assets & limits
      • Wallet · Deposit whitelist
      • Wallet · PaymentLink
      • Wallet Overview
      • Wallet · Deposit
      • Wallet · Statuses
      • Wallet · Withdraw
    • Convert
      • Convert Overview
      • Convert · Quote & submit
      • Convert · Business types
      • Convert · Pairs & limits
      • Convert · Statuses
  • API Reference
    • Virtual Account
      • Virtual Account field notes
      • Inquiry Master VA Balance
      • List Primary Virtual Accounts
      • Create Virtual Account
      • Get Virtual Account Detail
      • List Virtual Account
      • List Virtual Account Orders
      • Get Virtual Account Order Detail
      • Refund Virtual Account Order
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
      • Add Bank Account
      • List Bank Account
      • List Banks
      • Payout via Virtual Account
      • Send Email Verify Code
    • Wallet
      • Wallet field notes
      • Deposit Whitelist
        • Get Deposit Whitelist Options
        • Register Deposit Source Address
        • List Deposit Source Addresses
        • Get Deposit Source Address
        • Disable Deposit Source Address
        • Submit Payer Details for a Received Deposit
        • Save Sub-wallet Payer Profile
        • Update Sub-wallet Payer Profile
        • Get Sub-wallet Payer Profile
        • Get Deposit Whitelist Case
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • Wallet Internal Transfer
      • Create Sub Account
      • Query Transaction History
      • List Wallets
      • List Sub Account
      • Get Transaction Detail
      • List Wallet Transactions
      • Get Wallet Transaction Detail
    • Payment Link
      • Abnormal fund
        • Abnormal funds
        • Matchable Payment links
        • Link Order(Abnormal fund)
        • Submit to platform
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Convert
      • Convert field notes
      • Inquery FX Rate
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Reconciliation
      • Get Reconciliation Order List By Page
    • External Provider
      • FE: Create stablecoin collection sub-account link
      • FE: Deposit Travel Rule
      • External Provider · Deposit whitelist
      • Create stablecoin collection sub-account link
      • Get sub wallet account
      • List sub wallet accounts
      • Change sub wallet status
      • Query stablecoin collection order list
      • Query stablecoin collection order status
      • Get quote
      • Accept stablecoin collection order
      • Reject stablecoin collection order
      • Query USD balance
      • USD Payout (withdrawal)
      • Query USD Payout order status
      • Query USD Payout order list
      • Create deposit Travel Rule link
      • Create deposit Travel Rule detail link
    • Mock
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payment Link deposit
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
    • Files
      • Request File Upload URL
  • Webhooks
    • Webhooks Overview
    • KYB notifications
    • Event catalogue
    • Resend Fail Webhook
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
    • Abnormal Fund Notification
    • WALLET_TRANSFER_ORDER_UPDATED
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • wallet address whitelist Update
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
    • PaymentLink Notification
    • Deposit Whitelist Notification
  • Partner Flow
    • Share KYB/KYC and open account directly
      POST
    • Get KYB/KYC submit + open account status
      GET
    • List Banks
      GET
    • Check Account
      POST
    • Add Account
      POST
    • Get Stablecoin Quote
      POST
    • Create Stable Order
      POST
    • Get Order (Single) Detail
      GET
    • List Orders(Batch)
      GET
    • Submit hash
      POST
    • Order Status Notification (STABLE_ORDER_UPDATED)
  • Appendix
    • Enums quick reference
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
  • Errors
    • Error codes catalogue
  • Change Log
    • 2026-09-21 Virtual Account independent refund orders
    • Wallet deposit source-address whitelist
  1. Partner Flow

Check Account

Developing
POST
/v1/account/check-account

Check Account (Partner Flow)#

POST /v1/account/check-account — verify a KES bank account before binding it with add-account.

Supported combinations#

paymentMethodKESUGXTZS
BANK_TRANSFER✅❌❌
MOBILE_MONEY❌❌❌
Mobile money wallets cannot be verified with this endpoint. For MOBILE_MONEY (KES / UGX / TZS), skip check-account and bind the wallet directly with POST /v1/account/add-account.

Request#

fieldrequirednotes
paymentMethodyesBANK_TRANSFER
currencyyesKES
bankCodeyesbankCode from GET /v1/account/list-banks?paymentMethod=BANK_TRANSFER&currency=KES
accountNumberyeslocal bank account number
accountNameyesaccount holder name

Response data#

fieldnotes
verifyStatusSUCCESS = account verified; FAIL = account could not be verified
bankCodebank code of the checked account
accountNumberchecked account number
accountNameaccount holder name of the checked account

Rules#

verifyStatus=FAIL is a normal business result returned with status=200. Do not call add-account or place an order with that account; ask the end user to correct the details.
A non-200 status means the request itself was rejected (e.g. paymentMethod=MOBILE_MONEY, a currency other than KES, unknown bankCode); see code / msg.
Only call add-account with exactly the bankCode + accountNumber + accountName that returned verifyStatus=SUCCESS.

Request

Body Params application/json

Example
{
    "paymentMethod": "BANK_TRANSFER",
    "currency": "KES",
    "bankCode": "01",
    "accountNumber": "1234567890",
    "accountName": "Otieno Odhiambo"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/account/check-account' \
--header 'Content-Type: application/json' \
--data '{
    "paymentMethod": "BANK_TRANSFER",
    "currency": "KES",
    "bankCode": "01",
    "accountNumber": "1234567890",
    "accountName": "Otieno Odhiambo"
}'

Responses

🟢200OK
application/json
Bodyapplication/json

Examples
{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "verifyStatus": "SUCCESS",
        "bankCode": "01",
        "accountNumber": "1234567890",
        "accountName": "Otieno Odhiambo"
    },
    "traceId": "Auto:1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
    "success": true
}
Previous
List Banks
Next
Add Account
Built with