Transactions

get

https://api.cryptomus.com/v2/user-api/transaction/list

COPY

Request

Query parameters

Name	Definition
date_from	filtering by creation date, from (format: "YYYY-MM-DD H:mm:ss")
date_to	filtering by creation date, to (format: "YYYY-MM-DD H:mm:ss")
type	Transaction type

: Definition
filtering by creation date, from (format: "YYYY-MM-DD H:mm:ss")
: Definition
filtering by creation date, to (format: "YYYY-MM-DD H:mm:ss")
: Definition
Transaction type

Request example


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

COPY

Types

Request types

Name	Definition
payment	Payment transactions
payout	Payout transactions
transfer	Transfer from/to Business wallet transactions

: Definition
Payment transactions
: Definition
Payout transactions
: Definition
Transfer from/to Business wallet transactions

Response

Response parameters

Name	Definition
items	Structure
paginate	Structure

: Definition
Structure
: Definition
Structure

Items response parameters

Name	Definition
uuid	Transaction UUID
type	Transaction type
status	Structure
amount	Amount
amount_equivalent	Amount in equivalent
currency_equivalent	Currency equivalent amount (Currency set in your personal account)
currency	Currency code
comment	Commentary
network	Blockchain network code
address	Wallet address for payment
txid	Transaction Hash
created_at	Transaction time

: Definition
Transaction UUID
: Definition
Transaction type
: Definition
Structure
: Definition
Amount
: Definition
Amount in equivalent
: Definition
Currency equivalent amount (Currency set in your personal account)
: Definition
Currency code
: Definition
Commentary
: Definition
Blockchain network code
: Definition
Wallet address for payment
: Definition
Transaction Hash
: Definition
Transaction time

Paginate response parameters

Name	Definition
count	Number of items on the current page
hasPages	Whether there are enough elements to split into multiple pages (true / false)
nextCursor	Cursor to next page
previousCursor	Cursor to previous page
perPage	Maximum number of elements per page

: Definition
Number of items on the current page
: Definition
Whether there are enough elements to split into multiple pages (true / false)
: Definition
Cursor to next page
: Definition
Cursor to previous page
: Definition
Maximum number of elements per page

Status response parameters

Name	Definition
check	Waiting for the transaction to appear on the blockchain
paid	The transaction was successful
fail	Transaction error
cancel	Transaction cancelled
locked	Funds are locked due to the AML program

: Definition
Waiting for the transaction to appear on the blockchain
: Definition
The transaction was successful
: Definition
Transaction error
: Definition
Transaction cancelled
: Definition
Funds are locked due to the AML program

To get the records of the next/previous page, specify the next/previous cursor hash in the query parameters (?cursor=<nextCursorHash>)

Example:


curl https://api.cryptomus.com/v2/user-api/transaction/list?cursor=eyJpZCI6MjEyLCJ fcG9pbnRzVzVG9OZhXh0SXRlbXMiOnRydWV9 \
    -X POST \
    -H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: f80fa426a89eb62bd53997326865d850' \
    -H 'Content-Type: application/json' \
    -d '{}'

COPY

Response example


1{
2  "state": 0,
3  "result": {
4    "items": [
5      {
6        "uuid": "3a3efbe5-4835-48f3-95c0-7b63e2c8a0b6",
7        "type": "transfer",
8        "status": "paid",
9        "created_at": "2022-07-22T15:11:46.000000Z",
10        "amount": "10.00",
11        "amount_equivalent": "10.1679",
12        "currency_equivalent": "USD",
13        "currency": "USDT",
14        "network": null,
15        "txid": null,
16        "address": null,
17        "comment": null
18      },
19      {
20        "uuid": "d4953ea1-6f55-46f1-b1c9-f72c04badc45",
21        "type": "payout",
22        "status": "paid",
23        "created_at": "2022-09-01T14:46:44.000000Z",
24        "amount": "10.00",
25        "amount_equivalent": "10.1679",
26        "currency_equivalent": "USD",
27        "currency": "USDT",
28        "network": "tron",
29        "txid": null,
30        "address": "TSV1JBNzp71tucPrEsRPG5iLD1DkftzWzF",
31        "comment": null
32      },
33      {
34        "uuid": "690f745a-6b0c-42e1-a6ee-0de34485cab7",
35        "type": "payment",
36        "status": "fail",
37        "created_at": "2022-09-02T08:32:03.000000Z",
38        "amount": "2.00",
39        "amount_equivalent": "10.63359",
40        "currency_equivalent": "USD",
41        "currency": "USDT",
42        "network": "tron",
43        "txid": null,
44        "address": "TSV1JBNzp71tucPrEsRPG5iLD1DkftzWzF",
45        "comment": null
46      }
47    ],
48    "paginate": {
49      "count": 3,
50      "hasPages": true,
51      "nextCursor": "eyJpdiI6IlFIZnd5Lzd0VUN3TGtUNUF6ckV5TEE9PSIsInZhbHVlIjoiUHcvZm1rWmRqdDVKL25NMW5EVEQ1OW9JS0NiSjhJcHd1byt5SGhmVG95UjhGaUlCa3djT1ZSOU5Lc29Id3B3bC80T0VBSnhhZEZBWk1yZUN5RTByN2pKK0dNVUZ0QnFlcThwMU93d0NSR2pXMHJOQWZIa3N6cStmT0YxOG9VVDJyT1Q2NmVhbU9JU1N6cTJsM3JLTitRPT0iLCJtYWMiOiI2M2E4OWVmZTk3MDNjYzUwNjY0ZWY4ZjcxMjUyOGUzMmI4NzNkNWU4YzNlYmUxNmNmMThhM2JhN2RjNTkyYjgxIiwidGFnIjoiIn0=",
52      "previousCursor": null,
53      "perPage": 15
54    }
55  }
56}
57

COPY