Listing invoices
GET
/api/public/v1/invoices
This endpoint returns a list of invoices with pagination.
Headers
Query Parameters
Response Body
Response
{
"data": [
{
"id": "55f7832f-9745-4553-8548-1a06e30fb251",
"type": "invoices",
"attributes": {
"amountBilled": "1000.00",
"amountCharged": "1011.233592",
"billedCurrency": "usd",
"chargedCurrency": "usdt",
"reference": "9556e207-b785-4faf-9486-8e79fb442e76",
"statusContext": "full",
"network": "ttrx:usdt",
"networkName": "Tron (TRC20)",
"status": "completed",
"successRedirectUrl": "https://example.com/success",
"unsuccessRedirectUrl": "https://example.com/fail",
"paymentStatus": "on_time",
"exchangeRate": "0.98889",
"expiresAt": "2024-06-14T12:50:53.637Z",
"createdAt": "2024-06-14T12:30:53.693Z",
"hostedPageUrl": "https://sandbox.txn.pro/redirect?invoice_id=55f7832f-9745-4553-8548-1a06e30fb251\u0026request_type=invoice_hosted_page"
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "b5c97775-1378-4170-a7f0-78c2c5d60720"
}
},
"invoiceTransactions": {
"data": [
{
"type": "invoiceTransactions",
"id": "00312f1a-4f9d-499f-abaa-1919e6e03e63"
}
]
},
"coinDeposits": {
"data": [
{
"type": "coinDeposits",
"id": "ddd289d9-41c8-4d60-8d8a-6c50d2fb21b1"
}
]
}
}
}
],
"included": [
{
"id": "b5c97775-1378-4170-a7f0-78c2c5d60720",
"type": "addresses",
"attributes": {
"label": "USDT TTRX",
"value": "TBq5k63KV9q4reE6JEF9e7wTYGo3RUkMQU",
"createdAt": "2024-06-14T12:18:47.095Z"
},
"relationships": {
"account": {
"meta": {
"included": false
}
},
"network": {
"meta": {
"included": false
}
}
}
},
{
"id": "00312f1a-4f9d-499f-abaa-1919e6e03e63",
"type": "invoiceTransactions",
"attributes": {
"transactionFee": "10.0",
"transactionFeeCurrency": "USD"
},
"relationships": {
"txn": {
"data": {
"type": "transactions",
"id": "00312f1a-4f9d-499f-abaa-1919e6e03e63"
}
},
"exchangeQuote": {
"data": {
"type": "exchangeQuotes",
"id": "45a4789f-497d-4cbc-a9d3-92685b53e657"
}
}
}
},
{
"id": "ddd289d9-41c8-4d60-8d8a-6c50d2fb21b1",
"type": "coinDeposits",
"attributes": {
"txHash": "2cdde6dbe7669dbe933956cd28c7728e7ceb450804287149f3a8e59ee5bb344a",
"currencyCode": "USDT",
"createdAt": "2024-06-14T12:32:19.097Z",
"amount": "1011.233592",
"riskScore": "4.0"
},
"relationships": {
"network": {
"meta": {
"included": false
}
},
"address": {
"meta": {
"included": false
}
}
}
},
{
"id": "00312f1a-4f9d-499f-abaa-1919e6e03e63",
"type": "transactions",
"attributes": {
"createdAt": "2024-06-14T12:34:39.530Z",
"simplifiedState": "completed",
"transactionType": "InvoiceTransaction",
"amount": "990.00"
},
"relationships": {
"account": {
"meta": {
"included": false
}
}
}
},
{
"id": "45a4789f-497d-4cbc-a9d3-92685b53e657",
"type": "exchangeQuotes",
"attributes": {
"expiresAt": "2024-06-14T12:35:09.402Z",
"amountCharged": "1011.233592",
"amountReceived": "1000.0",
"rate": "0.98889",
"exchangeFee": "0.00",
"exchangeFeeCurrency": "USD",
"rateCurrency": "USD"
},
"relationships": {
"accountCharged": {
"meta": {
"included": false
}
},
"accountReceived": {
"meta": {
"included": false
}
},
"exchangeOrder": {
"meta": {
"included": false
}
}
}
}
],
"meta": {},
"jsonapi": {
"version": "1.0"
}
}
Last updated