Skip to main content

Pay-Out · Bangladesh

TOPPAY TeamAbout 2 min

Request

Pay-Out API for sending funds to recipients in Bangladesh (country code bd).

Endpoint

Domain: Prefer unified host openapi.toppayment.com (path unchanged); legacy country domain (e.g. global-bd-openapi.toppayment.com) remains available.

EnvironmentURL
Sandboxhttps://openapi.toppayment.com/sandbox/bd/disbursement/cash
Productionhttps://openapi.toppayment.com/bd/disbursement/cash

Request Headers

FieldRequiredTypeDescription
Content-TypeMStringFixed: application/json

Request Body

FieldRequiredTypeDescription
mchNoMString(32)Merchant number
orderNumMString(50)Merchant order number
amountMNumberAmount in BDT, up to 2 decimal places
bankCodeMString(32)Wallet code — see Bangladesh guide
bankCardMString(50)Recipient wallet number — starts with 01, 11 digits total
accountNameMString(50)Recipient name
descriptionOString(255)Description
feeTypeMNumber(0 or 1)Fee type: 0 deducted from amount, 1 charged separately
downNotifyUrlMString(164)Webhook URL
timestampMString(13)Millisecond timestamp
signMStringRSA signature — see Signature

Request Examples

{
    "mchNo": "{{mchNo}}",
    "orderNum": "BDPAYOUT1234561",
    "amount": 1000.00,
    "bankCode": "BKASH",
    "bankCard": "01880612345",
    "accountName": "Rahim Uddin",
    "description": "test",
    "feeType": 1,
    "downNotifyUrl": "https://example.com/notify",
    "timestamp": "1749451858772",
    "sign": "Generate per signature rules and replace"
}

Response

HTTP Response

FieldRequiredTypeDescription
Content-TypeMStringHTTP response content type specification
Fixed value: application/json

status — see Transaction Status Codes.

{
    "success": true,
    "code": "9999",
    "msg": "SUCCESS",
    "timeStamp": 1767772957433,
    "data": {
        "orderNum": "BDPAYOUT1234561",
        "platOrderNum": "TRANS2008811496544403456",
        "amount": 1000.00,
        "fee": 20.00,
        "feeType": 1,
        "status": 1,
        "statusMsg": "ORDER_RECEIVED_PROCESSING",
        "bankCode": "BKASH",
        "bankCard": "01880612345",
        "accountName": "Rahim Uddin",
        "description": "test"
    }
}

Notification

Bangladesh callbacks are fixed to v1.

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringFixed value: application/json

Notification Body

FieldRequiredTypeDescription
platOrderNumMStringPlatform order number
versionMStringVersion, fixed to v1
orderNumMStringMerchant order number, same as orderNum at order placement
amountMNumberAmount in BDT, up to two decimal places
feeMNumberFee
feeTypeMNumberFee type: 0 deducted from amount, 1 charged separately
statusMNumberTransaction status
See Transaction Status Codes
statusMsgMStringStatus message
bankCodeMStringWallet code — see Bangladesh guide
bankCardMStringRecipient wallet number
accountNameMStringRecipient name
descriptionOStringDescription
signMStringCallback signature — see Signature

Response

Verify the signature, then return the plain string SUCCESS only.

SUCCESS

Notification Example

{
    "platOrderNum": "TRANS2008812168572567552",
    "version": "v1",
    "orderNum": "BDPAYOUT1234561",
    "amount": 1000.00,
    "fee": 20.00,
    "feeType": 1,
    "status": 2,
    "statusMsg": "SUCCESS",
    "bankCode": "BKASH",
    "bankCard": "01880612345",
    "accountName": "Rahim Uddin",
    "description": "test",
    "sign": "Verify per signature rules"
}