পে-আউট অর্ডার তৈরি (/payout/create)
বিবরণ
মার্চেন্ট একক পে-আউট (অর্থ বিতরণ / ডিসবার্সমেন্ট) শুরু করতে এই এপিআই ব্যবহার করবে। প্ল্যাটফর্ম মার্চেন্টের অ্যাকাউন্ট ব্যালেন্স থেকে সমপরিমাণ অর্থ কর্তন করে প্রাপকের নির্ধারিত অ্যাকাউন্টে (যেমন: bKash পার্সোনাল ওয়ালেট) পাঠাবে।
রিকোয়েস্টের সাধারণ তথ্য
- রিকোয়েস্ট URL:
/payout/create - মেথড (Method):
POST - Content-Type:
application/json; charset=utf-8
রিকোয়েস্ট হেডার (HTTP Headers)
| প্যারামিটার | বাধ্যতামূলক | ধরন (Type) | বিবরণ |
|---|---|---|---|
merchantNo | হ্যাঁ (Yes) | String | মার্চেন্ট নম্বর |
sign | হ্যাঁ (Yes) | String | রিকোয়েস্ট বডির Base64 RSA ডিজিটাল স্বাক্ষর |
রিকোয়েস্ট বডি প্যারামিটার
| প্যারামিটার | বাধ্যতামূলক | ধরন | উদাহরণের মান | বিবরণ |
|---|---|---|---|---|
timestamp | হ্যাঁ | Long | 1772880300000 | মিলিসেকেন্ড টাইমস্ট্যাম্প |
merchantOrderNo | হ্যাঁ | String | PO202603070001 | মার্চেন্টের নিজস্ব অনন্য অর্ডার নম্বর |
amount | হ্যাঁ | String | 220.00 | অর্থ প্রদানের পরিমাণ (সর্বোচ্চ দুই দশমিক স্থান) |
payType | হ্যাঁ | String | BKASH | পেমেন্ট চ্যানেল মাধ্যম, নির্দিষ্ট মান: BKASH |
accountNo | হ্যাঁ | String | 01812345678 | প্রাপকের অ্যাকাউন্ট নম্বর (যেমন: bKash মোবাইল নম্বর) |
accountName | হ্যাঁ | String | Tanvir Ahmed | প্রাপকের নাম |
notifyUrl | হ্যাঁ | String | https://api.merchant.com/payout/notify | অ্যাসিনক্রোনাস নোটিফিকেশন কলব্যাক URL |
mobile | না | String | 01812345678 | প্রাপকের ফোন নম্বর |
email | না | String | receiver@example.com | প্রাপকের ইমেইল |
remark | না | String | Salary Payout | মন্তব্য (কলব্যাকে ফেরত দেওয়া হবে) |
রিকোয়েস্ট পেলোড উদাহরণ
json
{
"timestamp": 1772880300000,
"merchantOrderNo": "PO202603070001",
"amount": "220.00",
"payType": "BKASH",
"accountNo": "01812345678",
"accountName": "Tanvir Ahmed",
"notifyUrl": "https://api.merchant.com/payout/notify",
"mobile": "01812345678",
"email": "receiver@example.com",
"remark": "Salary Payout"
}রেসপন্স প্যারামিটার
সফল রেসপন্স উদাহরণ
json
{
"code": 1,
"msg": "ok",
"data": {
"merchantNo": "M1639466186292",
"merchantOrderNo": "PO202603070001",
"platOrderNo": "876324486452871168",
"amount": "220.00",
"fee": "5.00",
"status": "0"
}
}ব্যর্থ রেসপন্স উদাহরণ
json
{
"code": 0,
"msg": "Insufficient balance"
}রেসপন্স ফিল্ডের বিবরণ
| ফিল্ডের নাম | ধরন | বিবরণ |
|---|---|---|
code | Integer / String | স্ট্যাটাস কোড: 1 সফল, 0 ব্যর্থ |
msg | String | তথ্যের বিবরণ |
data | Object | লেনদেনের ডেটা অবজেক্ট |
data.merchantNo | String | মার্চেন্ট নম্বর |
data.merchantOrderNo | String | মার্চেন্ট অর্ডার নম্বর |
data.platOrderNo | String | প্ল্যাটফর্ম অর্ডার নম্বর |
data.amount | String | অর্থ প্রদানের পরিমাণ |
data.fee | String | সার্ভিস ফি |
data.status | String | অর্ডারের অবস্থা:0: তৈরি করা হয়েছে (Created)1: প্রক্রিয়াধীন (Processing)2: ব্যর্থ (Failed)3: সফল (Succeeded) |
