Withdraw Money - os-salahuddin/php8-cluster GitHub Wiki

Bank

Get Summary

This API provides the withdraw money summary details

URL

[POST] http://127.0.0.1:8282//api/v1/private/transaction/withdraw-money-bank-request/summary

Sample request

{
    "beneficiary_id" : "977",
    "amount" : 10,
    "remarks" : "Test Remarks !",
    "is_npsb" : 1
}

Sample Request Format

Parameter Type Description Always Present
beneficiary_id Int beneficiary id Yes
amount Number amount Yes
remarks String Remark text Yes
is_npsb Boolean is npsb or not Yes

Sample Response

{
    "code": 422,
    "messages": [
        "Sorry! Instant transfer is not active right now. Try regular / BEFTN transfer."
    ],
    "data": null
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data Object Transaction summary Yes

Execute request

This API performs execution of withdraw money via bank request

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/withdraw-money-bank-request/execute

Sample request

{
    "beneficiary_id" : "977",
    "amount" : 100,
    "pin" : 1235,
    "remarks" : "Test Remarks !",
    "is_npsb" : 1
}

Sample Request Format

Parameter Type Description Always Present
beneficiary_id Int beneficiary id Yes
amount Number amount Yes
pin String pin no Yes
remarks String Remark text Yes
is_npsb Boolean is npsb or not Yes

Sample Response

{
    "code": 422,
    "messages": [
        "Sorry! Insufficient balance.",
        "121055.1400"
    ],
    "data": null
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (e.g., "Payment is successful") Yes
data Object Transaction summary Yes

History

Get history date

This API provides history details data of withdraw money via bank

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/withdraw-money-bank-request/history

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "history": [           
            {
                "id": "8ec4eab2-e06d-454e-896b-ea6a48fb8e78",
                "amount": "৳100",
                "status": 3,
                "user": {
                    "mobile_no": "+8801784563942",
                    "name": "Onjon Hossain",
                    "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/36WgiXqYdVNZSP8TJpwgaGeTF1735198756.png"
                },
                "beneficiary": {
                    "id": 977,
                    "bank": {
                        "bank_id": 139,
                        "bank_name": "AB Bank Limited",
                        "bank_name_bn": "এবি ব্যাংক লিমিটেড",
                        "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/rwHOI1653562249.png",
                        "code": "020"
                    },
                    "branch": {
                        "bank_id": 139,
                        "branch_id": 22,
                        "name": "Anderkilla"
                    },
                    "name": "MARIA YASMIN NILA",
                    "ac_no": "12356789654"
                },
                "transaction": {
                    "invoice_id": "DXJHQWN942",
                    "amount": "100.0000",
                    "charge": "1.00"
                },
                "remarks": ""
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data.history Array List of withdrawal history Yes
data.history[].id String Unique ID of the transaction Yes
data.history[].amount String Withdrawn amount with currency symbol Yes
data.history[].status Int Status code of the transaction Yes
data.history[].user Object Details of the user Yes
data.history[].user.mobile_no String Mobile number of the user Yes
data.history[].user.name String Name of the user Yes
data.history[].user.photo String URL of the user’s profile photo Yes
data.history[].beneficiary Object Details of the beneficiary Yes
data.history[].beneficiary.id Int Unique ID of the beneficiary Yes
data.history[].beneficiary.bank Object Details of the bank Yes
data.history[].beneficiary.bank.bank_id Int Unique ID of the bank Yes
data.history[].beneficiary.bank.bank_name String Bank name in English Yes
data.history[].beneficiary.bank.bank_name_bn String Bank name in Bangla Yes
data.history[].beneficiary.bank.logo String URL of the bank's logo Yes
data.history[].beneficiary.bank.code String Bank code Yes
data.history[].beneficiary.branch Object Details of the bank branch Yes
data.history[].beneficiary.branch.bank_id Int Unique ID of the bank Yes
data.history[].beneficiary.branch.branch_id Int Unique ID of the branch Yes
data.history[].beneficiary.branch.name String Branch name Yes
data.history[].beneficiary.name String Name of the beneficiary Yes
data.history[].beneficiary.ac_no String Bank account number Yes
data.history[].transaction Object Transaction details Yes
data.history[].transaction.invoice_id String Invoice ID Yes
data.history[].transaction.amount String Transaction amount Yes
data.history[].transaction.charge String Transaction charge Yes
data.history[].remarks String Remarks for the transaction Yes