List Transactions

GET Request to {Endpoint}/crypto/v1/list-txs

This endpoint will provide a list of invoiced created via API. You can filter through transactions by utilizing the FromDate, ToDate, and HideUnpaid url parameters.

URL Parameters:

• FromDate: (Optional) Start date of transaction filter. Use formatting YYYY-MM-DD

• ToDate: (Optional) End date of transaction filter. Use formatting YYYY-MM-DD

• HideUnpaid: (Optional) If 'true', the endpoint will only display invoices that have received at least one payment. You can use this to exclude inactive invoices.

Successful Response (Status 200)

{
    "success": true,
    "count": 2,
    "totalPaid": 8.4,
    "details": [
        {
            "client": {
                "name": "First Name",
                "email": "[email protected]",
                "phone": "[phone]"
            },
            "paidAmount": 4.2,
            "subTotal": 1.2,
            "total": 4.2,
            "partialPaymentsEnabled": false,
            "currency": "USDC",
            "completed": true,
            "description": "Payment Description",
            "transactions": [
                {
                    "tx": "0xe45f9b59fffd9c2b3d945acf4a076804dfc625e5890de0a0e9fb2a0e42a983a4",
                    "sender": "0xD15aE11e29b002d41ae5dbcb2eDF4ED0b91cC4e5",
                    "amount": 4.2,
                    "cryptoAmount": 4200000,
                    "timestamp": "2024-06-24T05:49:35.000Z",
                    "network": "ETH"
                }
            ],
            "createdAt": "2024-06-24T05:19:56.854Z",
            "merchant": {
                "name": "Business Name",
                "initiator": "Internal Test POS API 1"
            },
            "id": "667901fcb753825891f6337e"
        },
        {
            "client": {
                "name": "First Name",
                "email": "[email protected]",
                "phone": "[phone]"
            },
            "paidAmount": 4.2,
            "subTotal": 1.2,
            "total": 4.2,
            "partialPaymentsEnabled": false,
            "currency": "USDC",
            "completed": true,
            "description": "Payment Description",
            "transactions": [
                {
                    "tx": "0x7814690311130862cfa4b91e2453683417e8ac3d61e0a9d211ac337e00482971",
                    "sender": "0x2F67f1426f33E25A920F0b2139cd460fDfb8997C",
                    "amount": 4.2,
                    "cryptoAmount": 4200000,
                    "timestamp": "2024-06-24T13:39:00.000Z",
                    "network": "MATIC_POLYGON"
                }
            ],
            "createdAt": "2024-06-24T13:37:20.674Z",
            "merchant": {
                "name": "Business Name",
                "initiator": "Internal Test POS API 1"
            },
            "id": "66797690b753825891f63d8a"
        }
    ]
}

Response Parameters

Field Name	Type	Description
success	boolean	True if request is successful
count	number	The number of results to be displayed
totalPaid	number	The USD adjusted** sum paid through the selected invoives
details	Object	Refer to Get Status for transaction body.