List
Fetches all transactions, including incoming and outgoing payments.
POST Transaction/List
Input
Parameter | Type | Required | Description | Default |
---|---|---|---|---|
MerchantId | string | yes | your merchant ID | – |
TimeStart | string | no | start time | null |
TimeFinish | string | no | end time | null |
Skip | number | no | start record | null |
Take | number | no | maximum number of records to fetch | null |
The TimeStart
and TimeFinish
must be in the YYYY-MM-DD hh:mm:ss
format. The hh:mm:ss
part is optional.
Output
Parameter | Type | Description |
---|---|---|
TotalCount | number | total number of transactions during the time period |
Transactions | Transaction[] | the list of transactions |
Transaction
Type
Field | Type | Description |
---|---|---|
Id | string | transaction ID (generated by ATLOS) |
SubscriptionId | string | subscription ID (generated by ATLOS) |
MerchantId | string | your merchant ID |
OrderId | string | the order ID you passed to the widget or the API as orderId |
Amount | number | the amount of asset received |
AssetCode | string | asset code |
BlockchainCode | string | blockchain code |
Fee | string | the amount of the commission fee taken |
UserWallet | string | for EVM blockchains, the sender's wallet address |
BlockchainHash | string | blockchain transaction hash (a.k.a. blockchain transaction ID) |
BlockNumber | number | blockchain block height |
TimeSent | string | time when the transaction was recorded in a block |
Status | number | 100 (success) |
Example Input
{
"MerchantId": "8XOZ64KC9X",
"TimeStart": "2024-10-15",
"TimeFinish": "2024-10-20",
"Skip": 100,
"Take": 500
}
Example Output
{
"TotalCount": 259,
"Transactions": [
{
"TransactionId": "RpoWRCnC84cjjQ5Y",
"SubscriptionId": "Xx9Gp1FJuKiP",
"MerchantId": "8XOZ64KC9X",
"OrderId": "123465",
"AssetCode": "USDC",
"BlockchainCode": "PGN",
"Amount": 19.950000,
"Fee": 0.199500,
"UserWallet": "0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0",
"BlockchainHash": "0x81d4eba9504bac535d112551afc1dd35ebfc6c8306ad805728a0a886f765def6",
"BlockNumber": 25,
"TimeSent": "2024-10-15T02:17:04Z",
"Status": 100,
},
...
]
}