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

Card

Get Channel List

This API provides the add money card lists (i.e visa, amex)

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money/card/lists

Sample Response

{
    "code": 200,
    "messages": [
        "Data found"
    ],
    "data": {
        "cards": [
            {
                "id": 1,
                "code": "001",
                "name": "VISA",
                "name_bn": "ভিসা",
                "alias": "EBL (CyberSource)",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
                "end_points": "api/v1/private/transaction/add-money/card/create/1"
            },
            {
                "id": 3,
                "code": "003",
                "name": "AMEX",
                "name_bn": "এমেক্স",
                "alias": "CBL",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/amex.png",
                "end_points": "api/v1/private/transaction/add-money/cbl/create/3"
            },
            {
                "id": 4,
                "code": "001",
                "name": "VISA (BBL)",
                "name_bn": "ভিসা",
                "alias": "BBL",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
                "end_points": "api/v1/private/transaction/add-money/brac/create/4"
            },
            {
                "id": 6,
                "code": "002",
                "name": "MASTER (CBL)",
                "name_bn": "মাস্টার",
                "alias": "CBL",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/mastercard.jpg",
                "end_points": "api/v1/private/transaction/add-money/cbl/create/6"
            },
            {
                "id": 7,
                "code": "001",
                "name": "VISA (CBL)",
                "name_bn": "ভিসা",
                "alias": "CBL",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
                "end_points": "api/v1/private/transaction/add-money/cbl/create/7"
            },
            {
                "id": 10,
                "code": "001",
                "name": "VISA (SEBL-CS)",
                "name_bn": "ভিসা",
                "alias": "SEBL (CyberSource)",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
                "end_points": "api/v1/private/transaction/add-money/sebl-cs/create/10"
            },
            {
                "id": 9,
                "code": "002",
                "name": "MASTER (SEBL)",
                "name_bn": "মাস্টার",
                "alias": "SEBL (MPGS)",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/mastercard.jpg",
                "end_points": "api/v1/private/transaction/add-money/sebl/create/9"
            }
        ],
        "notices": {
            "non_beneficiary": "Without adding bank/MFS account user can add up to ৳10,000.",
            "beneficiary": "Verified user can add max. ৳100,000 on each transaction.",
            "daily_limit": "Daily limit on add money is ৳100,000.",
            "monthly_limit": "Monthly limit on add money is ৳400,000."
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.cards Array List of available cards Yes
data.cards[].id Int Unique identifier for the card Yes
data.cards[].code String Card code Yes
data.cards[].name String Card name Yes
data.cards[].name_bn String Card name in Bangla Yes
data.cards[].alias String Alias of the card Yes
data.cards[].logo String URL of the card logo Yes
data.cards[].end_points String API endpoint for adding money using this card Yes
data.notices Object Notices related to add money transactions Yes
data.notices.non_beneficiary String Limit for users without added bank/MFS account Yes
data.notices.beneficiary String Limit for verified users per transaction Yes
data.notices.daily_limit String Daily limit on adding money Yes
data.notices.monthly_limit String Monthly limit on adding money Yes

Add money request [EBL CYBERSOURCE]

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/add-money/card/create/1

Sample request

{
    "amount" : 10,
    "email_address" : "[email protected]"
}

Sample Request Format

Parameter Type Description Always Present
amount Number value Yes
email_address String email No

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "url": "https://dev-apigw-personal.deshipay.com/add-money-by-card/create/100001650_67c046c62e3cf",
        "status_urls": {
            "success": "https://dev-apigw-personal.deshipay.com/add-money-by-card/success",
            "failed": "https://dev-apigw-personal.deshipay.com/add-money-by-card/failed",
            "cancel": "https://dev-apigw-personal.deshipay.com/add-money-by-card/cancel"
        },
        "has_beneficiary": true
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.url String Payment URL for redirecting to the payment gateway Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes
data.has_beneficiary Bool Whether the payment has a beneficiary Yes

Add money request [BRAC]

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/add-money/brac/create/4

Sample request

{
    "amount" : 10
}

Sample Request Format

Parameter Type Description Always Present
amount Number value Yes

Sample Response

{
    "code": 200,
    "messages": [
        "Payment Initiated Successfully"
    ],
    "data": {
        "url": "https://upayments.bracbank.com/pg/paymentpage.htm?PaymentID=101202504928479782",
        "status_urls": {
            "success": "https://dev-apigw-personal.deshipay.com/add-money-by-card/success",
            "failed": "https://dev-apigw-personal.deshipay.com/add-money-by-card/failed",
            "cancel": "https://dev-apigw-personal.deshipay.com/add-money-by-card/cancel"
        },
        "has_beneficiary": true
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.url String Payment URL for redirecting to the payment gateway Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes
data.has_beneficiary Bool Whether the payment has a beneficiary Yes

Add money request [SEBL MPGS]

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/add-money/sebl/create/9

Sample request

{
    "amount" : 10
}

Sample Request Format

Parameter Type Description Always Present
amount Number value Yes

Sample Response

{
    "code": 200,
    "messages": [
        "Payment successfully initiate"
    ],
    "data": {
        "url": "https://dev-apigw-personal.deshipay.com/add-money-by-card-sebl/step2/100001650_67c04a181be6c",
        "status_urls": {
            "success": "https://dev-apigw-personal.deshipay.com/add-money-by-card/success",
            "failed": "https://dev-apigw-personal.deshipay.com/add-money-by-card/failed",
            "cancel": "https://dev-apigw-personal.deshipay.com/add-money-by-card/cancel"
        },
        "has_beneficiary": true
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.url String Payment URL for redirecting to the payment gateway Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes
data.has_beneficiary Bool Whether the payment has a beneficiary Yes

Add money request [SEBL CYBERSOURCE]

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/add-money/sebl-cs/create/10

Sample request

{
    "amount" : 10
}

Sample Request Format

Parameter Type Description Always Present
amount Number value Yes

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "url": "https://dev-apigw-personal.deshipay.com/add-money-by-card-sebl/create/100001650_67c043eb161b7",
        "status_urls": {
            "success": "https://dev-apigw-personal.deshipay.com/add-money-by-card/success",
            "failed": "https://dev-apigw-personal.deshipay.com/add-money-by-card/failed",
            "cancel": "https://dev-apigw-personal.deshipay.com/add-money-by-card/cancel"
        },
        "has_beneficiary": true
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.url String Payment URL for redirecting to the payment gateway Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes
data.has_beneficiary Bool Whether the payment has a beneficiary Yes

Add money request [CBL]

URL

[POST] http://127.0.0.1:8282//api/v1/private/transaction/add-money/cbl/create/3

Sample request

{
    "amount" : 10,
    "cardNumber" : ""
}

Sample Request Format

Parameter Type Description Always Present
amount Number value Yes
cardNumber String Card Number No

Sample Response

{
    "code": 200,
    "messages": [
        "Payment Initiated Successfully"
    ],
    "data": {
        "url": "https://sandbox.thecitybank.com:8097/?TxnID=1b5b4a23-960e-4679-909b-0c662d9fe05d&ID=19446&CardNo=",
        "status_urls": {
            "success": "https://dev-apigw-personal.deshipay.com/add-money-by-card/success",
            "failed": "https://dev-apigw-personal.deshipay.com/add-money-by-card/failed",
            "cancel": "https://dev-apigw-personal.deshipay.com/add-money-by-card/cancel"
        },
        "has_beneficiary": true
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.url String Payment URL for redirecting to the payment gateway Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes
data.has_beneficiary Bool Whether the payment has a beneficiary Yes

Get Add money response

This API provides a response after money has been successfully added using a channel value (e.g., card). If the correct channel value is provided, the response will be 1 indicating success. If an incorrect channel value is provided, the response will be 2 indicating an error

URL

[POST] http://127.0.0.1:8282/api/v1/private/transaction/add-money/response

Sample request

{
    "channel" : "card"
}

Sample Request Format

Parameter Type Description Always Present
channel string Channel value (e.g card) Yes

Sample Response

Response 1:

{
    "code": 200,
    "messages": [
        "Add money is successful"
    ],
    "data": {
        "summary": {
            "sender": {
                "name": "VISA Card",
                "number": "411111xxxxxx1111",
                "mobile_number": "411111xxxxxx1111",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg"
            },
            "invoice_id": "N/A",
            "date": "18 February, 2025",
            "time": "11:16 AM",
            "new_balance": "৳122,115.14",
            "total_payable": "৳10.00",
            "fee": "৳0.00",
            "amount": "৳10.00"
        }
    }
}

Response 2:

{
    "code": 422,
    "messages": [
        "Add money is unsuccessful"
    ],
    "data": {
        "summary": {
            "sender": {
                "name": "Nagad",
                "number": "",
                "mobile_number": "",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/mfs/nagad_logo.jpeg"
            },
            "invoice_id": "N/A",
            "date": "05 November, 2024",
            "time": "03:29 PM",
            "new_balance": "৳122,115.14",
            "total_payable": "৳20.00",
            "fee": "৳0.00",
            "amount": "৳20.00"
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.summary Object Summary of the transaction Yes
data.summary.sender Object Information about the sender Yes
data.summary.sender.name String Name of the sender Yes
data.summary.sender.number String Number of the sender's card Yes
data.summary.sender.mobile_number String Mobile number associated with the sender Yes
data.summary.sender.avatar String URL of the sender's avatar image Yes
data.summary.invoice_id String Invoice ID for the transaction No
data.summary.date String Date of the transaction Yes
data.summary.time String Time of the transaction Yes
data.summary.new_balance String New balance after the transaction Yes
data.summary.total_payable String Total payable amount Yes
data.summary.fee String Fee associated with the transaction Yes
data.summary.amount String Amount added to the account Yes

MFS

Get Channel List

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money/mfs

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "mfs": [
            {
                "id": 1,
                "name": "bKash",
                "name_bn": "বিকাশ",
                "code": "0347bff0-5f86-4158-a69e-b563841380b9",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/addmoney/channel/GxOoZtXhmxHlXPyUEATQ0uXYr1729071414.png"
            },
            {
                "id": 2,
                "name": "Nagad",
                "name_bn": "নগদ",
                "code": "f994e999-a519-45e6-8dea-013855f300a6",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/mfs/nagad_logo.jpeg"
            },
            {
                "id": 3,
                "name": "Upay",
                "name_bn": "উপায়",
                "code": "c52cd195-b2b2-4f8d-b353-6e362cc65549",
                "logo": "https://www.upaybd.com/images/Upay-Logo.jpg"
            }
        ],
        "notices": {
            "non_beneficiary": "Without adding bank/MFS account user can add up to ৳10,000.",
            "beneficiary": "Verified user can add max. ৳100,000 on each transaction.",
            "daily_limit": "Daily limit on add money is ৳100,000.",
            "monthly_limit": "Monthly limit on add money is ৳400,000."
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.mfs Array List of available MFS channels for adding money Yes
data.mfs[].id Int Unique identifier for the MFS channel Yes
data.mfs[].name String Name of the MFS channel (e.g., bKash, Nagad, Upay) Yes
data.mfs[].name_bn String Name of the MFS channel in Bangla Yes
data.mfs[].code String Unique code associated with the MFS channel Yes
data.mfs[].logo String URL to the logo of the MFS channel Yes
data.notices Object Notices related to adding money Yes
data.notices.non_beneficiary String Limit for users without added bank/MFS account Yes
data.notices.beneficiary String Limit for verified users per transaction Yes
data.notices.daily_limit String Daily limit on adding money Yes
data.notices.monthly_limit String Monthly limit on adding money Yes

Add money

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money/mfs/nagad/summary

Sample request

{
    "mfs":2,
    "amount":100
}

Sample Request Format

Parameter Type Description Always Present
mfs string value (e.g nagad = 2) Yes
amount Number amount Yes

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "redirect_url": "http://sandbox.mynagad.com:10060/check-out/MTAwNDE1MTUyMjc5Mi42ODMwMDIwMDcxMDQyMjUuSW52MjAyMjEwMDQxNTMzMjIuZTg0MjRhYWY4Y2U2ZjE3OWMyNTM=",
        "status_urls": {
            "success": "https://dev-apigw-marketing.deshipay.com/nagad/success",
            "failed": "https://dev-apigw-marketing.deshipay.com/nagad/failed",
            "cancel": "https://dev-apigw-marketing.deshipay.com/nagad/cancel"
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.redirect_url String URL for redirecting to the payment page Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes

IB

Get Channel List

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money/add-money/ib/lists

Sample Response

{
    "code": 200,
    "messages": [
        "Data found"
    ],
    "data": {
        "lists": [
            {
                "id": 1,
                "code": "MTB",
                "is_account_required": 1,
                "account_no": "",
                "name": "Mutual Trust Bank",
                "name_bn": "এমটিবি",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/addmoney/channel/lCPfCPXJGI8tkD5ozszUzrLPc1729071559.png",
                "end_points": "api/v1/private/transaction/add-money-mtb/ib/create"
            }
        ],
        "notices": {
            "non_beneficiary": "Without adding bank/MFS account user can add up to ৳10,000.",
            "beneficiary": "Verified user can add max. ৳100,000 on each transaction.",
            "daily_limit": "Daily limit on add money is ৳100,000.",
            "monthly_limit": "Monthly limit on add money is ৳400,000."
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.lists Array List of available banks/MFS for adding money Yes
data.lists[].id Int Unique identifier for the bank/MFS Yes
data.lists[].code String Code for the bank/MFS channel Yes
data.lists[].is_account_required Int Whether an account is required for this bank/MFS (1 = Yes, 0 = No) Yes
data.lists[].account_no String Account number (if required) No
data.lists[].name String Name of the bank/MFS (e.g., Mutual Trust Bank) Yes
data.lists[].name_bn String Name of the bank/MFS in Bangla Yes
data.lists[].logo String URL of the logo for the bank/MFS Yes
data.lists[].end_points String Endpoint for processing the transaction Yes
data.notices Object Notices related to adding money Yes
data.notices.non_beneficiary String Limit for users without added bank/MFS account Yes
data.notices.beneficiary String Limit for verified users per transaction Yes
data.notices.daily_limit String Daily limit on adding money Yes
data.notices.monthly_limit String Monthly limit on adding money Yes

Add money [IB]

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money-mtb/ib/create

Sample request

{
    "amount":100,
    "account_no":"131xxxxxxxx93",
}

Sample Request Format

Parameter Type Description Always Present
amount Number amount Yes
account_no string account no Yes

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "redirect_url": "https://sandbox.mtbpay.com/checkout/MTAwNTE1MTUyMjc5Mi42ODMwMDIwMDcxMDQyMjUuSW52MjAyMjEwMDQxNTMzMjIuMTIzNDU2Nzg5",
        "status_urls": {
            "success": "https://dev-apigw-marketing.deshipay.com/nagad/success",
            "failed": "https://dev-apigw-marketing.deshipay.com/nagad/failed",
            "cancel": "https://dev-apigw-marketing.deshipay.com/nagad/cancel"
        }
    }
}

{
    "code": 422,
    "messages": [
        "Sorry! Could not initiate transaction : "
    ],
    "data": [
        []
    ]
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.redirect_url String URL for redirecting to the payment page Yes
data.status_urls Object Object containing the success, failure, and cancel URLs Yes
data.status_urls.success String URL for success status Yes
data.status_urls.failed String URL for failure status Yes
data.status_urls.cancel String URL for canceled payment status Yes

Remove Linked account [MTB]

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/add-money-mtb/ib/delete-link-account

Sample request

{
    "link_token":"LBM|S2xxxxxxxxxxxxxx503",
    "account_no":"131xxxxxxxx93",
}

Sample Request Format

Parameter Type Description Always Present
link_token string token Yes
account_no string account no Yes

Sample Response

{
    "code": 200,
    "messages": [
       "success"
    ],
    "data": null
}

{
    "code": 500,
    "messages": [
        "Sorry! Something went wrong. Please try again later."
    ],
    "data": null
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data Mixed Object or null Yes