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

List of recent recipient of Request Money

Get recent recipient List

This API provides the recent recipient of request money

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/request-money/recent-recipients

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "recipients": [
            {
                "name": null,
                "mobile_number": "+8801626426999",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/UVJi3iPrazEZLs7nfRJZC9sng1695621478.png"
            },
            {
                "name": "John smith",
                "mobile_number": "+8801877724434",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/nGVzNDX3wVZY3lBcIguk8Itrg1724240459.png"
            },
            {
                "name": null,
                "mobile_number": "+8801678311369",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/031jQI9BBakhMYE5DiJhmDpcA1730195954.png"
            },
            {
                "name": null,
                "mobile_number": "+8801810097586",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/qpGmGc5Pel5pEUdyFHQNJgdPc1693130579.png"
            },
            {
                "name": "John doe",
                "mobile_number": "+8801684544812",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/5QObsPBWJjnuMjzLB4TsQQhWm1671020340.png"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.recipients Array List of recipients Yes
data.recipients[].name String Name of the recipient (null if not available) No
data.recipients[].mobile_number String Mobile number of the recipient Yes
data.recipients[].avatar String URL to the avatar image of the recipient Yes

Request Money

Get Summary

This API provides the recent recipient of request money

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/request-money/summary

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "summary": {
            "nature_of_transaction": "Transfer",
            "recipient": {
                "name": "John",
                "mobile_number": "+8801315595046",
                "avatar": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/uAunPoSMD9E2JJeVYBKtZdLpj1692785293.png"
            },
            "card": null,
            "amount": "৳111.00",
            "charge": "৳0.00",
            "total_payable": "৳111.00",
            "remarks": "Test Remarks !"
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.summary Object Transaction summary Yes
data.summary.nature_of_transaction String Nature of the transaction (e.g., Transfer) Yes
data.summary.recipient Object Details of the recipient Yes
data.summary.recipient.name String Name of the recipient Yes
data.summary.recipient.mobile_number String Mobile number of the recipient Yes
data.summary.recipient.avatar String URL to the avatar image of the recipient Yes
data.summary.card Object Card details (null if not available) No
data.summary.amount String Transaction amount Yes
data.summary.charge String Transaction charge Yes
data.summary.total_payable String Total amount payable (including charge) Yes
data.summary.remarks String Remarks related to the transaction Yes

Execute request

This API provides the recent recipient of request money

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/request-money/execute

Sample request

{
    "requestee_mobile_number" : "+8801784563942",
    "amount": 110,
    "pin": 1235,
    "remarks": "Test Remarks !"
}

Sample Request Format

Parameter Type Description Always Present
requestee_mobile_number string mobile number Yes
amount Number amount Yes
pin string pin Yes
remarks string remarks Yes

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "history": [
            {
                "request_id": "e293f036-4605-4b5a-bbff-8fdafed0cb34",
                "icon": "https://dev-apigw-personal.deshipay.com/image/icons/request_money.png",
                "title": {
                    "text": "Money request to",
                    "color": "#000000"
                },
                "identity": {
                    "name": "John",
                    "mobile_number": "+8801315595046",
                    "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/uAunPoSMD9E2JJeVYBKtZdLpj1692785293.png",
                    "color": "#000000"
                },
                "amount": {
                    "text": "৳110.00",
                    "currency": "BDT",
                    "color": "#000000"
                },
                "date": "18 Feb 25, 03:06 PM",
                "transaction-type": "Money Request",
                "status": {
                    "icon": "https://dev-apigw-personal.deshipay.com/image/icons/money-requests/pending.png",
                    "text": "PENDING",
                    "color": "#FF4D61"
                },
                "is_actionable": false,
                "remarks": "Test Remarks !"
            },
            {
                "request_id": "cf2ca4e2-7bcc-40fb-b51d-bd6b64b03a61",
                "icon": "https://dev-apigw-personal.deshipay.com/image/icons/request_money.png",
                "title": {
                    "text": "Money request to",
                    "color": "#000000"
                },
                "identity": {
                    "name": "",
                    "mobile_number": "+8801626426999",
                    "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/UVJi3iPrazEZLs7nfRJZC9sng1695621478.png",
                    "color": "#000000"
                },
                "amount": {
                    "text": "৳500.00",
                    "currency": "BDT",
                    "color": "#000000"
                },
                "date": "12 Jun 24, 09:38 AM",
                "transaction-type": "Money Request",
                "status": {
                    "icon": "https://dev-apigw-personal.deshipay.com/image/icons/money-requests/pending.png",
                    "text": "PENDING",
                    "color": "#FF4D61"
                },
                "is_actionable": false,
                "remarks": ""
            },
            {
                "request_id": "dca32036-2cbc-42a2-b703-41f456d544c1",
                "icon": "https://dev-apigw-personal.deshipay.com/image/icons/request_money.png",
                "title": {
                    "text": "Money request to",
                    "color": "#000000"
                },
                "identity": {
                    "name": "",
                    "mobile_number": "+8801626426999",
                    "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/UVJi3iPrazEZLs7nfRJZC9sng1695621478.png",
                    "color": "#000000"
                },
                "amount": {
                    "text": "৳100.00",
                    "currency": "BDT",
                    "color": "#000000"
                },
                "date": "14 May 24, 04:24 PM",
                "transaction-type": "Money Request",
                "status": {
                    "icon": "https://dev-apigw-personal.deshipay.com/image/icons/money-requests/pending.png",
                    "text": "PENDING",
                    "color": "#FF4D61"
                },
                "is_actionable": false,
                "remarks": ""
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.history Array List of transaction history records Yes
data.history[].request_id String Unique identifier for the money request Yes
data.history[].icon String URL to the transaction type icon Yes
data.history[].title Object Title information Yes
data.history[].title.text String Title text Yes
data.history[].title.color String Hex color code for the title text Yes
data.history[].identity Object Recipient identity details Yes
data.history[].identity.name String Name of the recipient (empty if not available) No
data.history[].identity.mobile_number String Mobile number of the recipient Yes
data.history[].identity.photo String URL to the recipient’s profile photo Yes
data.history[].identity.color String Hex color code for the identity text Yes
data.history[].amount Object Transaction amount details Yes
data.history[].amount.text String Transaction amount formatted as text Yes
data.history[].amount.currency String Currency code (e.g., BDT) Yes
data.history[].amount.color String Hex color code for the amount text Yes
data.history[].date String Date and time of the transaction Yes
data.history[].transaction-type String Type of transaction (e.g., Money Request) Yes
data.history[].status Object Transaction status details Yes
data.history[].status.icon String URL to the status icon Yes
data.history[].status.text String Status text (e.g., PENDING) Yes
data.history[].status.color String Hex color code for the status text Yes
data.history[].is_actionable Bool Indicates whether the request requires action Yes
data.history[].remarks String Additional remarks (empty if not provided) No

Accept request

This API accept the request money

URL

[GET] http://127.0.0.1:8282/api/v1/private/transaction/request-money/update

Sample request

{
    "request_id" : "4645fd78-6b32-4c34-9886-9246709ae7f4",
    "status": 1
}

Sample Request Format

Parameter Type Description Always Present
request_id string Request id of request money Yes
status boolean Accept (i.e status = 1 for accept, status = 2 for decline) Yes

Sample Response

{
  "code": 200,
  "messages": [
    "Your Money Request has been accepted."
  ],
  "data": {
    "request_id": "443c6605-4547-4234-b1a8-1fc56b55168d",
    "icon": "https://dev-apigw-personal.deshipay.com/image/icons/request_money.png",
    "title": {
      "text": "Money request from",
      "color": "#03EBA3"
    },
    "identity": {
      "name": "",
      "mobile_number": "+8801910097586",
      "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/euUgvmbfW0lfGp3y2HpZb4Fim1730183612.png",
      "color": "#03EBA3"
    },
    "amount": {
      "text": "৳1,500.00",
      "currency": "BDT",
      "color": "#03EBA3"
    },
    "date": "18 February 2025 17:24 PM",
    "transaction-type": "Money Request",
    "status": {
      "icon": "https://dev-apigw-personal.deshipay.com/image/icons/money-requests/declined.png",
      "text": "DECLINED",
      "color": "#FF4D61"
    },
    "is_actionable": false
  }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.request_id String Unique identifier for the money request Yes
data.icon String URL to the transaction type icon Yes
data.title.text String Title text Yes
data.title.color String Hex color code for the title text Yes
data.identity.name String Name of the recipient (empty if not available) No
data.identity.mobile_number String Mobile number of the recipient Yes
data.identity.photo String URL to the recipient’s profile photo Yes
data.identity.color String Hex color code for the identity text Yes
data.amount.text String Transaction amount formatted as text Yes
data.amount.currency String Currency code (e.g., BDT) Yes
data.amount.color String Hex color code for the amount text Yes
data.date String Date and time of the transaction Yes
data.transaction-type String Type of transaction (e.g., Money Request) Yes
data.status.icon String URL to the status icon Yes
data.status.text String Status text (e.g., DECLINED) Yes
data.status.color String Hex color code for the status text Yes
data.is_actionable Bool Indicates whether the request requires action Yes