History Transactions
The History Transactions feature displays a comprehensive list of all transaction types, including earnings, redemptions, and other relevant activities. This provides users with a complete overview of their transaction history for easy tracking and review.
The Get Transaction History API provides a complete list of all transaction records. The returned data includes several transaction types, such as: earning, earning-request, redeem, redeem-reservation, convert-point, and point-expiration. Make sure to consult with our Account Executive to determine whether your flow requires the use of earning-request and redeem-reservation, which are primarily related to admin approval processes for earning and redeem actions.
Transaction History List
POST /customer/transaction/history
This endpoint retrieves the full transaction history, including various transaction types.
Headers
Accept
application/json
Authorization
Bearer <token>
Params
client_code
string
client identifier
customer_id
number
id of customer.Required, Integer, Exist on Data Customer
type
string
Transaction Type Optional, Default: earning,earning-request,redeem,redeem-reservation,convert-point,point-expiration
limit
number
Total record to be displayed Optional, Integer, Default: 10
page
number
Page Number Optional, Integer, Default: 1
Response
{
"status_code": 200,
"status": "success",
"paginator": {
"current_page": 1,
"per_page": 10,
"previous_page": 0,
"next_page": 0,
"total_items": 4,
"total_pages": 1
},
"data": [
{
"id": 316521,
"date": "2024-10-09 15:03:14",
"receipt_no": "EA/24/00000024",
"receipt_photo": null,
"point": {
"redeem": 0,
"lucky_draw": 0,
"lucky_draw_numbers": null
},
"amount": 1500000,
"payment_method": {
"id": "436",
"name": "Others"
},
"voided_at": null,
"adjusted_at": null,
"rollbacked_at": null,
"type": "Earning",
"description": "Earning",
"detail_url": "https://portal-staging.loyal.id/api/v1/customer/transaction/earning/316521/detail",
"status": "Success",
"note": "Example Note",
"reason": null,
"client": {
"code": "950101",
"name": "Paint Pro"
},
"store": {
"id": "3016",
"name": "Default Tenant",
"photo": null,
"unit": null,
"floor": null,
"longitude": null,
"latitude": null,
"altitude": null
},
"product": {
"id": null,
"name": null
}
},
{
"id": 316519,
"date": "2024-10-09 14:56:09",
"receipt_no": "EA/24/00000022",
"receipt_photo": null,
"point": {
"redeem": 0,
"lucky_draw": 0,
"lucky_draw_numbers": null
},
"amount": 1500000,
"payment_method": {
"id": "436",
"name": "Others"
},
"voided_at": null,
"adjusted_at": null,
"rollbacked_at": null,
"type": "Earning",
"description": "Earning",
"detail_url": "https://portal-staging.loyal.id/api/v1/customer/transaction/earning/316519/detail",
"status": "Success",
"note": "Example Note",
"reason": null,
"client": {
"code": "950101",
"name": "Paint Pro"
},
"store": {
"id": "3016",
"name": "Default Tenant",
"photo": null,
"unit": null,
"floor": null,
"longitude": null,
"latitude": null,
"altitude": null
},
"product": {
"id": null,
"name": null
}
},
{
"id": 316517,
"date": "2024-10-09 14:55:51",
"receipt_no": "EA/24/00000020",
"receipt_photo": null,
"point": {
"redeem": 0,
"lucky_draw": 0,
"lucky_draw_numbers": null
},
"amount": 150000,
"payment_method": {
"id": "436",
"name": "Others"
},
"voided_at": null,
"adjusted_at": null,
"rollbacked_at": null,
"type": "Earning",
"description": "Earning",
"detail_url": "https://portal-staging.loyal.id/api/v1/customer/transaction/earning/316517/detail",
"status": "Success",
"note": "Example Note",
"reason": null,
"client": {
"code": "950101",
"name": "Paint Pro"
},
"store": {
"id": "3016",
"name": "Default Tenant",
"photo": null,
"unit": null,
"floor": null,
"longitude": null,
"latitude": null,
"altitude": null
},
"product": {
"id": null,
"name": null
}
},
{
"id": 316515,
"date": "2024-10-09 14:41:22",
"receipt_no": "EA/24/00000018",
"receipt_photo": null,
"point": {
"redeem": 10,
"lucky_draw": 0,
"lucky_draw_numbers": null
},
"amount": 0,
"payment_method": {
"id": "436",
"name": "Others"
},
"voided_at": null,
"adjusted_at": null,
"rollbacked_at": null,
"type": "Earning",
"description": "Earning",
"detail_url": "https://portal-staging.loyal.id/api/v1/customer/transaction/earning/316515/detail",
"status": "Success",
"note": "",
"reason": null,
"client": {
"code": "950101",
"name": "Paint Pro"
},
"store": {
"id": "3016",
"name": "Default Tenant",
"photo": null,
"unit": null,
"floor": null,
"longitude": null,
"latitude": null,
"altitude": null
},
"product": {
"id": null,
"name": null
}
}
]
}{
"status_code": 422,
"status": "error",
"message": "The client code must be between 6 and 7 digits.",
"errors": [
"The client code must be between 6 and 7 digits."
]
}After retrieving the list, if you want more details about a specific transaction, ensure you hit the corresponding endpoint based on the transaction type.
Last updated