Lịch sử thanh toán

Trả về danh sách các hóa đơn

post

https://api.cryptomus.com/v1/payment/list

Sao chép

Lời yêu cầu

Tham số truy vấn

Tên	Kiểu tham số	Giá trị mặc định	Sự định nghĩa
date_from	stringformat: YYYY-MM-DD H:mm:ss	null	Lọc theo ngày tạo, từ
date_to	stringformat: YYYY-MM-DD H:mm:ss	null	Lọc theo ngày tạo, để

Kiểu tham số

stringformat: YYYY-MM-DD H:mm:ss

Sự định nghĩa

Lọc theo ngày tạo, từ

Kiểu tham số

stringformat: YYYY-MM-DD H:mm:ss

Sự định nghĩa

Lọc theo ngày tạo, để

Ví dụ yêu cầu


curl https://api.cryptomus.com/v1/payment/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json' \

Sao chép

Để lọc hóa đơn theo ngày tạo từ ngày 4 tháng 5 đến ngày 16 tháng 5.


curl https://api.cryptomus.com/v1/payment/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json' \
-d '{
	"date_from": "2023-05-04 00:00:00"
	"date_to": "2023-05-16 23:59:59"
}'

Sao chép

Phản ứng

Các thông số phản hồi

Tên	Sự định nghĩa
items	Mảng hóa đơn. Cấu trúc của mục
paginate

: Sự định nghĩa
Mảng hóa đơn. Cấu trúc của mục
: Sự định nghĩa

Cấu trúc củaphân trang

Tên	Kiểu tham số	Sự định nghĩa
count	integer	Số lượng mục trên trang hiện tại
hasPages	boolean	Có đủ các thành phần để chia thành nhiều trang hay không (đúng / sai)
nextCursor	string / null	Con trỏ đến trang tiếp theo
previousCursor	string / null	Con trỏ đến trang trước
perPage	integer	Số lượng phần tử tối đa trên mỗi trang

Kiểu tham số

integer

Sự định nghĩa

Số lượng mục trên trang hiện tại

Kiểu tham số

boolean

Sự định nghĩa

Có đủ các thành phần để chia thành nhiều trang hay không (đúng / sai)

Kiểu tham số

string / null

Sự định nghĩa

Con trỏ đến trang tiếp theo

Kiểu tham số

string / null

Sự định nghĩa

Con trỏ đến trang trước

Kiểu tham số

integer

Sự định nghĩa

Số lượng phần tử tối đa trên mỗi trang

Để có được các mục trang tiếp theo/trước đó, hãy chỉ định băm con trỏ tiếp theo/trước đó trong các tham số truy vấn (?cursor=nextCursorHash)

Ví dụ:


1curl https://api.cryptomus.com/v1/payment/list?cursor=eyJpZCI6MjEyLCJ fcG9pbnRzVzVG9OZhXh0SXRlbXMiOnRydWV9 \
2-X POST \
3-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
4-H 'sign: f80fa426a89eb62bd53997326865d850' \
5-H 'Content-Type: application/json' \
6

Sao chép

Ví dụ phản hồi


1{
2	"state": 0,
3	"result": {
4		"items": [{
5			"uuid": "ac1af391-8e98-4335-b9d7-7b6f6b40f268",
6			"order_id": "20fe59c4601dd174985e497e3f6bbcd2",
7			"amount": "20.00",
8			"payment_amount": "0.00000000",
9			"payer_amount": "0.00064860",
10			"discount_percent": 0,
11			"discount": "0.00000000",
12			"payer_currency": "BTC",
13			"currency": "USD",
14			"merchant_amount": null,
15			"comments": null,
16			"network": "btc",
17			"address": "bc1qxm6ehuy6mz2l2h3ag88frcjvl2xxlr9hvnq835",
18			"from": null,
19			"txid": null,
20			"payment_status": "cancel",
21			"url": "https://pay.cryptomus.com/pay/ac1af391-8e98-4335-b9d7-7b6f6b40f268",
22			"expired_at": 1689172103,
23			"status": "cancel",
24			"is_final": true,
25			"additional_data": null,
26			"created_at": "2023-07-12T16:28:24+03:00",
27			"updated_at": "2023-07-12T17:30:16+03:00"
28		}, {
29			"uuid": "1bb48358-2905-4e98-b681-5f1948e818d1",
30			"order_id": "a3329f462eb036dad12b5409147809a3",
31			"amount": "15.00",
32			"payment_amount": "0.00",
33			"payer_amount": "14.25",
34			"discount_percent": 5,
35			"discount": "0.75",
36			"payer_currency": "USDT",
37			"currency": "USDT",
38			"merchant_amount": "15.43500000",
39			"comments": null,
40			"network": "tron",
41			"address": "TSChodGNEJ6D31d9uueFxJAVH9NxiJjTwC",
42			"from": null,
43			"txid": null,
44			"payment_status": "cancel",
45			"url": "https://pay.cryptomus.com/pay/1bb48358-2905-4e98-b681-5f1948e818d1",
46			"expired_at": 1689099958,
47			"status": "cancel",
48			"is_final": true,
49			"additional_data": null,
50			"created_at": "2023-07-11T20:25:58+03:00",
51			"updated_at": "2023-07-11T21:26:18+03:00"
52		}, {
53			"uuid": "70b8db5c-b952-406d-af26-4e1c34c27f15",
54			"order_id": "65bbe87b4098c17a31cff3e71e515243",
55			"amount": "15.00",
56			"payment_amount": "0.00",
57			"payer_amount": "15.75",
58			"discount_percent": -5,
59			"discount": "-0.75",
60			"payer_currency": "USDT",
61			"currency": "USDT",
62			"merchant_amount": "15.43500000",
63			"comments": null,
64			"network": "tron",
65			"address": "TXhfYSWt2oKRrHAJVJeYRuit6ZzKuoEKXj",
66			"from": null,
67			"txid": null,
68			"payment_status": "cancel",
69			"url": "https://pay.cryptomus.com/pay/70b8db5c-b952-406d-af26-4e1c34c27f15",
70			"expired_at": 1689099831,
71			"status": "cancel",
72			"is_final": true,
73			"additional_data": null,
74			"created_at": "2023-07-11T20:23:52+03:00",
75			"updated_at": "2023-07-11T21:24:17+03:00"
76		},
77		...
78],
79		"paginate": {
80			"count": 15,
81			"hasPages": true,
82			"nextCursor": "eyJpZCI6MjkxNTU0MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
83			"previousCursor": null,
84			"perPage": 15
85		}
86	}
87}

Sao chép

Lỗi có thể xảy ra

Lỗi xác thực

mã số : 422

ví dụ phản hồi:

Nếu tham số date_from hoặc date_to được truyền theo định dạng không đúng:


1{
2	"state": 1,
3	"errors": {
4		"date_from": ["validation.regex"]
5	}
6}

Sao chép