Get all payment-event list

This API can receive all payment-event list.

request a payment-event list#

bash
curl -X GET \
     "https://develop.kokoon.cloud/kokoon/api/sr/v3/credit/payment/event?page_num=0&page_size=2&start_date=2023-01-01&end_date=2024-05-01" \
     -H "Content-Type:application/json" \
     -H 'Authorization: eyJraWQiOiJPMGs5...eyJzdWIiOiIzN2U3NzYxM'

request query parameter#

filters

field	mandatory	description
page_size	optional	size per page for pagenation.(page_num is required.)
page_num	optional	current page for pagenation.(page_size is required.)
start_date	optional	start date
end_date	optional	end date

response#

json
{
  "all_count": 114,
  "curr_count": 2,
  "page_size": "2",
  "page_num": "0",
  "start_date": "2023-01-01",
  "end_date": "2024-05-01",
  "pay_events": [
    {
      "eid": "186",
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "tid": "ee45f0f0-c421-11ee-aa6b-cb922cbeb55a",
      "cid": "00000000-0000-0000-0000-000000000000",
      "event_type": "convert",
      "request_time": "2024-02-05T12:27:34.000Z",
      "finish_time": null,
      "status_code": null,
      "result_message": null,
      "orig_filename": "small_32x32.mp4",
      "pay_intent_id": null,
      "used_credit": 0,
      "used_point": 0,
      "last_credit": 4058,
      "last_point": 0,
      "is_api": false
    },
    {
      "eid": "6",
      "uid": "539e3480-929a-11ee-ada2-51e4bfe11414",
      "tid": "00000000-0000-0000-0000-000000000000",
      "cid": "00000000-0000-0000-0000-000000000000",
      "event_type": "credit_charged",
      "request_time": "2023-12-05T07:13:02.000Z",
      "finish_time": "2023-12-05T07:13:02.000Z",
      "status_code": null,
      "result_message": null,
      "orig_filename": null,
      "pay_intent_id": "pi_3OJsoBJBeRA5p2Z41SqQh2VX",
      "used_credit": 4800,
      "used_point": 0,
      "last_credit": 4829,
      "last_point": 0,
      "is_api": false
    }
  ]
}

response body field#

field	type	description
all_count	int	total item count for filted results.
curr_count	int	item count for current page.
page_num	string	current page for pagenation.
page_size	string	size per page for pagenation.
start_date	string	start date.
end_date	string	end date.

pay_events

field	type	description
eid	string	payment event unique id.
event_type	string	payment event type `credit_charged` : a filled credit by credit card. `free_charged` : a filled free-credit when registered. `firstuse_charged` : a filled free-credit when first used. `coupon` : a filled credit by coupon. `convert` : a subtracted credit by conversion. `refund` : a refunded credit by error or cancel. `manual_charged` : a manually filled credit by administrator. `manual_subtracted` : a manually subtracted credit by administrator.
uid	string	user unique id.
tid	string	task unique id. valid when event_type is `convert` or `refund`.
cid	string	coupon unique id.
request_time	string	requested time for task. valid when event_type is `convert` or `refund`.
finish_time	string	finished time for task. valid when event_type is `convert` or `refund`.
status_code	string	status_code for SR task. valid when event_type is `convert` or `refund`.
result_message	string	result message for SR task. valid when event_type is `convert` or `refund`.
orig_filename	string	original video's filename. valid when event_type is `convert` or `refund`.
pay_intent_id	string	payment intent id. valid when event_type is `credit_charged`.
used_credit	string	used credit in this event_type.
used_point	string	used point in this event_type.
last_credit	string	my last credit in this event_type.
last_point	string	my last point in this event_type.
is_api	string	checks this event is called by kokoon-api or web. valid when event_type is `convert` or `refund`.