History - os-salahuddin/php8-cluster GitHub Wiki
Transaction History
Get Transaction History
This API provides list of transaction histories
URL
[GET] http://127.0.0.1:8282/api/v1/private/user/transaction/history
Sample Response
{
"code": 200,
"messages": [],
"data": {
"transactions": [
{
"color": "#FC2861",
"icon": "https://dev-apigw-personal.deshipay.com/image/icons/send.png",
"title": "Money Sent",
"transaction_id": "BZCTPFY942",
"amount": "৳106.00",
"currency": "BDT",
"transaction_type": "Withdraw Bank",
"created_at": "19 Feb 25, 03:05 PM",
"source": null,
"destination": {
"name": "Transfer to Visa Debit Card",
"mobile_no": "411111******1111"
},
"type_of_tx": "Debit",
"nature_of_transaction": "Transfer",
"remarks": "Remarks : Test",
"new": {
"photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
"bank": null,
"withdraw_bank_status": "Transferred",
"type": "Transfer to Visa Debit Card",
"title": "411111******1111",
"trx_no": "Trans ID: BZCTPFY942",
"amount": "৳106.00",
"amount_color_code": "#FC2861",
"created_at": "19 Feb 25, 03:05 PM",
"fee": "৳2.12",
"service_charge": "৳0.00",
"total_amount": "৳108.12"
}
},
{
"color": "#FC2861",
"icon": "https://dev-apigw-personal.deshipay.com/image/icons/send.png",
"title": "Money Sent",
"transaction_id": "CZCTNAH942",
"amount": "৳10.00",
"currency": "BDT",
"transaction_type": "P2P-Transfer",
"created_at": "19 Feb 25, 01:34 PM",
"source": null,
"destination": {
"name": "John Doe",
"mobile_no": "+88017xxxxxxxx"
},
"type_of_tx": "Debit",
"nature_of_transaction": "Transfer",
"remarks": "",
"new": {
"photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/laLXlucvdKqUSdkP7sBaS63e41637652156.png",
"bank": null,
"withdraw_bank_status": null,
"type": "Send Money",
"title": "John Sohn",
"trx_no": "Trans ID: CZCTNAH942",
"amount": "৳10.00",
"amount_color_code": "#FC2861",
"created_at": "19 Feb 25, 01:34 PM",
"fee": "৳5.00",
"service_charge": "৳0.00",
"total_amount": "৳15.00"
}
},
{
"color": "#FC2861",
"icon": "https://dev-apigw-personal.deshipay.com/image/icons/send.png",
"title": "Money Sent",
"transaction_id": "AZCTN6J942",
"amount": "৳10.00",
"currency": "BDT",
"transaction_type": "P2P-Transfer",
"created_at": "19 Feb 25, 01:31 PM",
"source": null,
"destination": {
"name": "John Smith",
"mobile_no": "+88017xxxxxxxx"
},
"type_of_tx": "Debit",
"nature_of_transaction": "Transfer",
"remarks": "",
"new": {
"photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/laLXlucvdKqUSdkP7sBaS63e41637652156.png",
"bank": null,
"withdraw_bank_status": null,
"type": "Send Money",
"title": "John Smith",
"trx_no": "Trans ID: AZCTN6J942",
"amount": "৳10.00",
"amount_color_code": "#FC2861",
"created_at": "19 Feb 25, 01:31 PM",
"fee": "৳5.00",
"service_charge": "৳0.00",
"total_amount": "৳15.00"
}
},
{
"color": "#03EBA3",
"icon": "https://dev-apigw-personal.deshipay.com/image/icons/receive.png",
"title": "You Received Money",
"transaction_id": "CZCROG6005",
"amount": "৳120.00",
"currency": "BDT",
"transaction_type": "Add Money",
"created_at": "17 Feb 25, 02:40 PM",
"source": {
"name": "Visa to ST Pay",
"mobile_no": "411111******1111"
},
"destination": null,
"type_of_tx": "Credit",
"nature_of_transaction": "Transfer",
"remarks": "",
"new": {
"photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/visa.jpg",
"bank": null,
"withdraw_bank_status": null,
"type": "Visa to ST Pay",
"title": "Visa to ST Pay",
"trx_no": "Trans ID: CZCROG6005",
"amount": "৳120.00",
"amount_color_code": "#03EBA3",
"created_at": "17 Feb 25, 02:40 PM",
"fee": "৳0.00",
"service_charge": "৳0.00",
"total_amount": "৳120.00"
}
}
],
"has_next_page": true
},
"data_additional": {
"per_page": 10,
"total": 435
}
}
Sample Response Format
| Parameter | Type | Description | Always Present |
|---|---|---|---|
code |
Int | HTTP code (e.g., 200) | Yes |
messages |
Array | Result messages | Yes |
data.transactions |
Array | List of transactions | Yes |
data.transactions[].color |
String | Color code for transaction | Yes |
data.transactions[].icon |
String | URL of the transaction icon | Yes |
data.transactions[].title |
String | Title of the transaction | Yes |
data.transactions[].transaction_id |
String | Unique transaction ID | Yes |
data.transactions[].amount |
String | Transaction amount | Yes |
data.transactions[].currency |
String | Currency of the transaction | Yes |
data.transactions[].transaction_type |
String | Type of transaction | Yes |
data.transactions[].created_at |
String | Transaction creation date and time | Yes |
data.transactions[].source |
Object | Source details | No |
data.transactions[].source.name |
String | Name of the source | No |
data.transactions[].source.mobile_no |
String | Mobile number of the source | No |
data.transactions[].destination |
Object | Destination details | No |
data.transactions[].destination.name |
String | Name of the destination | No |
data.transactions[].destination.mobile_no |
String | Mobile number of the destination | No |
data.transactions[].type_of_tx |
String | Type of transaction (Credit/Debit) | Yes |
data.transactions[].nature_of_transaction |
String | Nature of transaction | Yes |
data.transactions[].remarks |
String | Remarks for the transaction | No |
data.transactions[].new |
Object | Additional transaction details | Yes |
data.transactions[].new.photo |
String | URL of the transaction-related photo | No |
data.transactions[].new.bank |
String | Bank information | No |
data.transactions[].new.withdraw_bank_status |
String | Bank withdrawal status | No |
data.transactions[].new.type |
String | Type of transaction | Yes |
data.transactions[].new.title |
String | Title displayed for the transaction | Yes |
data.transactions[].new.trx_no |
String | Transaction number | Yes |
data.transactions[].new.amount |
String | Amount of the transaction | Yes |
data.transactions[].new.amount_color_code |
String | Color code for amount display | Yes |
data.transactions[].new.created_at |
String | Date and time of transaction | Yes |
data.transactions[].new.fee |
String | Fee charged for transaction | Yes |
data.transactions[].new.service_charge |
String | Service charge for transaction | Yes |
data.transactions[].new.total_amount |
String | Total amount including fees | Yes |
data.has_next_page |
Bool | Indicates if there are more transactions | Yes |
data_additional.per_page |
Int | Number of transactions per page | Yes |
data_additional.total |
Int | Total number of transactions | Yes |
Get Summary
This API provides the Monthly summary of expense
URL
[GET] http://127.0.0.1:8282/api/v1/private/user/transaction/summary
Sample Response
{
"code": 200,
"messages": [
"Expense Summary"
],
"data": {
"monthly_report": [
{
"month": "Feb 2025",
"expense": "৳ 22,957.12",
"receive": "৳ 1,544.00",
"total": "৳ 24,501.12",
"currency": "BDT",
"summary": {
"add_money": {
"count": 10,
"amount": "৳ 1,544.00",
"percentage": 6.3
},
"send_money": {
"count": 6,
"amount": "৳ 1,360.00",
"percentage": 5.55
},
"received_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"payment": {
"count": 1,
"amount": "৳ 10.00",
"percentage": 0.04
},
"make_payment": {
"count": 13,
"amount": "৳ 21,479.00",
"percentage": 87.67
},
"ecomm_payment": {
"count": 1,
"amount": "৳ 10.00",
"percentage": 0.04
},
"bank_transfer": {
"count": 1,
"amount": "৳ 108.12",
"percentage": 0.44
},
"pay_bill": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
}
}
},
{
"month": "Jan 2025",
"expense": "৳ 190.00",
"receive": "৳ 65,146.00",
"total": "৳ 65,336.00",
"currency": "BDT",
"summary": {
"add_money": {
"count": 13,
"amount": "৳ 65,146.00",
"percentage": 99.71
},
"send_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"received_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"payment": {
"count": 1,
"amount": "৳ 190.00",
"percentage": 0.29
},
"make_payment": {
"count": 1,
"amount": "৳ 190.00",
"percentage": 0.29
},
"ecomm_payment": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"bank_transfer": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"pay_bill": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
}
}
},
{
"month": "Dec 2024",
"expense": "৳ 0.00",
"receive": "৳ 0.00",
"total": "৳ 0.00",
"currency": "BDT",
"summary": {
"add_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"send_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"received_money": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"payment": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"make_payment": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"ecomm_payment": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"bank_transfer": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
},
"pay_bill": {
"count": 0,
"amount": "৳ 0.00",
"percentage": 0
}
}
}
]
}
}
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.monthly_report |
Array | Monthly expense and receive summary | Yes |
data.monthly_report[].month |
String | Month and year of the report | Yes |
data.monthly_report[].expense |
String | Total expenses for the month | Yes |
data.monthly_report[].receive |
String | Total received amount for the month | Yes |
data.monthly_report[].total |
String | Total transaction amount | Yes |
data.monthly_report[].currency |
String | Currency of the amounts | Yes |
data.monthly_report[].summary |
Object | Summary of different transactions | Yes |
data.monthly_report[].summary.add_money.count |
Int | Number of add money transactions | Yes |
data.monthly_report[].summary.add_money.amount |
String | Total amount added | Yes |
data.monthly_report[].summary.add_money.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.send_money.count |
Int | Number of send money transactions | Yes |
data.monthly_report[].summary.send_money.amount |
String | Total amount sent | Yes |
data.monthly_report[].summary.send_money.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.received_money.count |
Int | Number of received money transactions | Yes |
data.monthly_report[].summary.received_money.amount |
String | Total amount received | Yes |
data.monthly_report[].summary.received_money.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.payment.count |
Int | Number of payment transactions | Yes |
data.monthly_report[].summary.payment.amount |
String | Total payment amount | Yes |
data.monthly_report[].summary.payment.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.make_payment.count |
Int | Number of make payment transactions | Yes |
data.monthly_report[].summary.make_payment.amount |
String | Total make payment amount | Yes |
data.monthly_report[].summary.make_payment.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.ecomm_payment.count |
Int | Number of e-commerce payment transactions | Yes |
data.monthly_report[].summary.ecomm_payment.amount |
String | Total e-commerce payment amount | Yes |
data.monthly_report[].summary.ecomm_payment.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.bank_transfer.count |
Int | Number of bank transfer transactions | Yes |
data.monthly_report[].summary.bank_transfer.amount |
String | Total bank transfer amount | Yes |
data.monthly_report[].summary.bank_transfer.percentage |
Float | Percentage of total transactions | Yes |
data.monthly_report[].summary.pay_bill.count |
Int | Number of bill payment transactions | Yes |
data.monthly_report[].summary.pay_bill.amount |
String | Total bill payment amount | Yes |
data.monthly_report[].summary.pay_bill.percentage |
Float | Percentage of total transactions | Yes |
Transaction Limits
This API provides daily transaction limit information
URL
[GET] http://127.0.0.1:8282/api/v1/private/user/transactional-limits
Sample Response
{
"code": 200,
"messages": [],
"data": {
"daily": [
{
"service_id": 12,
"service_type": "Add Money",
"total_max_no_of_tx": 20,
"total_max_amount": "100000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 27,
"service_type": "Credit Card Bill",
"total_max_no_of_tx": 50,
"total_max_amount": "100000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 1,
"service_type": "Ecom Payment",
"total_max_no_of_tx": 100,
"total_max_amount": "400000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 2,
"service_type": "Make Payment",
"total_max_no_of_tx": 100,
"total_max_amount": "400000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 23,
"service_type": "Money Transfer",
"total_max_no_of_tx": 100,
"total_max_amount": "100000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 3,
"service_type": "Send Money",
"total_max_no_of_tx": 30,
"total_max_amount": "100000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
}
],
"monthly": [
{
"service_id": 12,
"service_type": "Add Money",
"total_max_no_of_tx": 40,
"total_max_amount": "400000",
"consumed_tx_count": 10,
"consumed_tx_amount": "৳ 1,544.00"
},
{
"service_id": 27,
"service_type": "Credit Card Bill",
"total_max_no_of_tx": 50,
"total_max_amount": "400000",
"consumed_tx_count": 0,
"consumed_tx_amount": "৳ 0.00"
},
{
"service_id": 1,
"service_type": "Ecom Payment",
"total_max_no_of_tx": 500,
"total_max_amount": "400000",
"consumed_tx_count": 13,
"consumed_tx_amount": "৳ 21,479.00"
},
{
"service_id": 2,
"service_type": "Make Payment",
"total_max_no_of_tx": 500,
"total_max_amount": "400000",
"consumed_tx_count": 1,
"consumed_tx_amount": "৳ 10.00"
},
{
"service_id": 23,
"service_type": "Money Transfer",
"total_max_no_of_tx": 100,
"total_max_amount": "400000",
"consumed_tx_count": 1,
"consumed_tx_amount": "৳ 108.12"
},
{
"service_id": 3,
"service_type": "Send Money",
"total_max_no_of_tx": 200,
"total_max_amount": "400000",
"consumed_tx_count": 6,
"consumed_tx_amount": "৳ 1,360.00"
}
]
}
}
Sample Response Format
| Parameter | Type | Description | Always Present |
|---|---|---|---|
code |
Int | HTTP code (e.g., 200) | Yes |
messages |
Array | Result messages (empty in this case) | Yes |
data.daily |
Array | Daily transaction limits and usage details | Yes |
data.daily[].service_id |
Int | Unique identifier for the service | Yes |
data.daily[].service_type |
String | Type of service (e.g., "Add Money") | Yes |
data.daily[].total_max_no_of_tx |
Int | Maximum allowed transactions per day | Yes |
data.daily[].total_max_amount |
String | Maximum allowed amount per day | Yes |
data.daily[].consumed_tx_count |
Int | Number of transactions used today | Yes |
data.daily[].consumed_tx_amount |
String | Total amount used today | Yes |
data.monthly |
Array | Monthly transaction limits and usage details | Yes |
data.monthly[].service_id |
Int | Unique identifier for the service | Yes |
data.monthly[].service_type |
String | Type of service (e.g., "Add Money") | Yes |
data.monthly[].total_max_no_of_tx |
Int | Maximum allowed transactions per month | Yes |
data.monthly[].total_max_amount |
String | Maximum allowed amount per month | Yes |
data.monthly[].consumed_tx_count |
Int | Number of transactions used this month | Yes |
data.monthly[].consumed_tx_amount |
String | Total amount used this month | Yes |