# Listing invoices

<mark style="color:green;">`GET`</mark> `/api/public/v1/invoices`

This endpoint returns a list of invoices with pagination.

**Headers**

| Name          | Value                      |
| ------------- | -------------------------- |
| Content-Type  | `application/vnd.api+json` |
| Authorization | `Bearer <api_key>`         |

**URL Parameters**

<table><thead><tr><th width="164.692626953125">Name</th><th width="142.010009765625">Type</th><th>Description</th></tr></thead><tbody><tr><td>order</td><td>string</td><td>Field to order the list of invoices by. Currently the only supported value is <code>created_at</code>.</td></tr><tr><td>order_type</td><td>string</td><td>Order type. Can be either <code>asc</code> or <code>desc</code>.</td></tr><tr><td>page</td><td>number</td><td>Page for which you want to return invoices.</td></tr><tr><td>per_page</td><td>number</td><td>Number of invoices per page to return.</td></tr><tr><td>reference</td><td>string</td><td>Invoice <code>reference</code>.</td></tr><tr><td>created_at_from</td><td>string</td><td>Date and time filter. Supports timestamps in ISO 8601 format, e.g. <code>2024-06-18T15:49:02.031Z</code>.</td></tr><tr><td>created_at_to</td><td>string</td><td>Date and time filter. Supports timestamps in ISO 8601 format, e.g. <code>2024-06-18T15:49:02.031Z</code>.</td></tr></tbody></table>

**Response Body**

<table><thead><tr><th>Name</th><th width="97">Type</th><th>Description</th></tr></thead><tbody><tr><td>data.id</td><td>string</td><td>Invoice ID.</td></tr><tr><td>data.type</td><td>string</td><td>Entity type returned. Always <code>invoices</code>.</td></tr><tr><td>data.attributes</td><td>object</td><td>Set of invoice attributes.</td></tr><tr><td>data.attributes.amountBilled</td><td>string</td><td>Invoice amount to display to end users. Determines the amount due after conversion.</td></tr><tr><td>data.attributes.amountCharged</td><td>string</td><td>Amount due. Determines the amount of cryptocurrency the end-user is required to pay.</td></tr><tr><td>data.attributes.targetAmount</td><td>string</td><td>Amount you will receive into your target currency account.</td></tr><tr><td>data.attributes.billedCurrency</td><td>string</td><td>Invoice currency to display to end users. Determines the currency due after conversion. Refer to <a href="/pages/SA7q0b6VrvXO3W09TQfS">supported</a> currencies.</td></tr><tr><td>data.attributes.chargedCurrency</td><td>string</td><td>Cryptocurrency that the customer must pay in. Refer to <a href="/pages/SA7q0b6VrvXO3W09TQfS">supported</a> currencies.</td></tr><tr><td>data.attributes.targetCurrency</td><td>string</td><td>Settlement currency. This is the currency you will receive in your account after the payment is processed.</td></tr><tr><td>data.attributes.targetAccountId</td><td>string</td><td>The ID of the account to which the invoice payment is credited.</td></tr><tr><td>data.attributes.chargedTargetRate</td><td>string</td><td>Charged currency to target currency exchange rate.</td></tr><tr><td>data.attributes.chargedTargetRateCurrency</td><td>string</td><td>Currency in which <code>chargedTargetRate</code> is quoted.</td></tr><tr><td>data.attributes.reference</td><td>string</td><td>The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose.</td></tr><tr><td>data.attributes.statusContext</td><td>string</td><td>Indicates whether the end-user paid in <code>full</code>, <code>underpaid</code>, <code>overpaid</code>, or has not paid (<code>unpaid</code>) the invoice. Refer to <a href="/pages/gi0dnWPISndBROaBxzYn">Invoice status flow</a>.</td></tr><tr><td>data.attributes.network</td><td>string</td><td>Network code. Refer to <a href="/pages/SA7q0b6VrvXO3W09TQfS">Supported currencies</a>.</td></tr><tr><td>data.attributes.networkName</td><td>string</td><td>Network name to display.</td></tr><tr><td>data.attributes.paymentMethods</td><td>array</td><td>Invoice payment methods.</td></tr><tr><td>data.attributes.status</td><td>string</td><td>Invoice status. Refer to <a href="/pages/gi0dnWPISndBROaBxzYn">Invoice status flow</a>.</td></tr><tr><td>data.attributes.successRedirectUrl</td><td>string</td><td>URL your customer will be redirected from our hosted page to if the invoice completes.</td></tr><tr><td>data.attributes.unsuccessRedirectUrl</td><td>string</td><td>URL your customer will be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.</td></tr><tr><td>data.attributes.paymentStatus</td><td>string</td><td>Invoice payment status. Refer to <a href="/pages/gi0dnWPISndBROaBxzYn">Invoice status flow</a>.</td></tr><tr><td>data.attributes.exchangeRate</td><td>string</td><td>Invoice exchange rate valid for 20 minutes.</td></tr><tr><td>data.attributes.expiresAt</td><td>string</td><td>Invoice expiry date and time.</td></tr><tr><td>data.attributes.createdAt</td><td>string</td><td>Date and time invoice was created at.</td></tr><tr><td>data.attributes.hostedPageUrl</td><td>string</td><td>Invoice hosted page.</td></tr><tr><td>data.attributes.scAddress</td><td>string</td><td>Smart contract address for the NFT payment feature. <code>null</code> when not enabled.</td></tr><tr><td>included.type(addresses).attributes</td><td>object</td><td>Invoice receiving address. This is the address the end-user must send their cryptocurrency payment to.</td></tr><tr><td>included.type(binanceOrders).attributes</td><td>object</td><td>Payment instructions for an off-chain payment via the Binance application.</td></tr><tr><td>included.type(coinTransactions).attributes</td><td>object</td><td>Details of a crypto payment received at the invoice address, including <code>txHash</code>, <code>currencyCode</code>, <code>amount</code>, and other related fields.</td></tr><tr><td>included.type(invoiceTransactions).attributes</td><td>object</td><td>Details of the invoice transaction, including <code>billedChargedRate</code>, <code>transactionFee</code>, <code>targetTransactionFee</code>, and related fields.</td></tr><tr><td>included.type(invoiceTransactions).attributes.amountBilled</td><td>string</td><td>The actual payment amount in <code>billedCurrency</code>, reflecting what the end-user's crypto payment converted to. Use this field to credit the end-user's balance on your platform. In a full payment it equals the original invoice amount; for underpayments and overpayments, Txn applies the spot exchange rate to the crypto actually received, so this value will differ. Pre-fee — see <code>transactionFee</code> and <code>targetTransactionFee</code> for the fee breakdown.</td></tr><tr><td>included.type(apiKeys).attributes.name</td><td>string</td><td>Name of the API key that created the invoice.</td></tr><tr><td>included.type(apiKeys).attributes.createdAt</td><td>string</td><td>Timestamp when the API key was created.</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="HTTP 200" %}

```json
{
  "data": [
    {
      "id": "806f822f-7e7c-440e-bb2d-cba36e4ad6f2",
      "type": "invoices",
      "attributes": {
        "amountBilled": "33.00",
        "amountCharged": "33.365698",
        "targetAmount": "27.76",
        "billedCurrency": "USD",
        "chargedCurrency": "USDT",
        "targetCurrency": "EUR",
        "chargedTargetRate": "0.85512683728197",
        "chargedTargetRateCurrency": "EUR",
        "reference": "dd171c10-f246-4888-9759-ee39009745bf",
        "statusContext": "unpaid",
        "network": "ttrx:usdt",
        "networkName": "Tron (TRC20)",
        "paymentMethods": [
          "on_chain"
        ],
        "status": "cancelled",
        "successRedirectUrl": null,
        "unsuccessRedirectUrl": null,
        "paymentStatus": "expecting",
        "exchangeRate": "0.9890397",
        "expiresAt": "2026-01-19T10:07:54.355Z",
        "createdAt": "2026-01-19T07:07:54.483Z",
        "hostedPageUrl": "https://sandbox.txn.io/redirect?invoice_id=806f822f-7e7c-440e-bb2d-cba36e4ad6f2&request_type=invoice_hosted_page&zone=eu",
        "scAddress": null
      },
      "relationships": {
        "targetAccount": {
          "data": {
            "type": "accounts",
            "id": "adb0f9c4-c7fd-4989-a273-1bd11ad5847b"
          }
        },
        "binanceOrder": {
          "data": null
        },
        "address": {
          "data": {
            "type": "addresses",
            "id": "525d85d7-a0c5-47ad-a775-eb2a6375b706"
          }
        },
        "refundLinks": {
          "data": []
        },
        "invoiceTransactions": {
          "data": [
            {
              "type": "invoiceTransactions",
              "id": "307f4dc9-5395-4a7b-b78d-7484985f7166"
            }
          ]
        },
        "coinDeposits": {
          "data": []
        }
      }
    },
    {
      "id": "9506769e-295d-4d9e-b371-9995dc91fba0",
      "type": "invoices",
      "attributes": {
        "amountBilled": "1000.00",
        "amountCharged": "23.123807",
        "targetAmount": "22.33",
        "billedCurrency": "TRY",
        "chargedCurrency": "USDT",
        "targetCurrency": "USD",
        "chargedTargetRate": "0.99926",
        "chargedTargetRateCurrency": "USD",
        "reference": "edeaa162-3b95-4aa1-b800-b1efa24fbcb6",
        "statusContext": "unpaid",
        "network": "ttrx:usdt",
        "networkName": "Tron (TRC20)",
        "paymentMethods": [
          "on_chain"
        ],
        "status": "cancelled",
        "successRedirectUrl": null,
        "unsuccessRedirectUrl": null,
        "paymentStatus": "expecting",
        "exchangeRate": "43.24547465",
        "expiresAt": "2026-01-17T15:58:58.652Z",
        "createdAt": "2026-01-17T12:58:59.186Z",
        "hostedPageUrl": "https://sandbox.txn.io/redirect?invoice_id=9506769e-295d-4d9e-b371-9995dc91fba0&request_type=invoice_hosted_page&zone=eu",
        "scAddress": null
      },
      "relationships": {
        "targetAccount": {
          "data": {
            "type": "accounts",
            "id": "80b8dd61-35bc-49cc-9e04-f2c0f741a096"
          }
        },
        "binanceOrder": {
          "data": null
        },
        "address": {
          "data": {
            "type": "addresses",
            "id": "f83db4c7-b86c-4b45-8009-2c9d042eac1d"
          }
        },
        "refundLinks": {
          "data": []
        },
        "invoiceTransactions": {
          "data": [
            {
              "type": "invoiceTransactions",
              "id": "7f044fef-f685-4a11-9fac-da5d962ade97"
            }
          ]
        },
        "coinDeposits": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "adb0f9c4-c7fd-4989-a273-1bd11ad5847b",
      "type": "accounts",
      "attributes": {
        "master": false,
        "currencyCode": "EUR",
        "label": "EUR_4",
        "bankReference": "BDR0154632342411086",
        "balance": "31.63",
        "totalBalance": "31.63",
        "bankWithdrawalAvailable": true,
        "bankDepositAvailable": true,
        "transferAvailable": true,
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "525d85d7-a0c5-47ad-a775-eb2a6375b706",
      "type": "addresses",
      "attributes": {
        "label": "Tron (TRC20)",
        "value": "TDa95SveS24fbYATjn59jYdXNAxgpHdvbZ",
        "createdAt": "2026-01-13T07:13:30.951Z"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "307f4dc9-5395-4a7b-b78d-7484985f7166",
      "type": "invoiceTransactions",
      "attributes": {
        "amountBilled": "33.00",
        "billedChargedRate": "0.9890397",
        "billedChargedRateCurrency": "USD",
        "consolidationFee": "0.56",
        "transactionFee": "0.33",
        "transactionFeeCurrency": "USD",
        "targetTransactionFee": "0.29",
        "targetTransactionFeeCurrency": "EUR",
        "simplifiedState": "pending"
      },
      "relationships": {
        "txn": {
          "data": {
            "type": "transactions",
            "id": "307f4dc9-5395-4a7b-b78d-7484985f7166"
          }
        },
        "exchangeQuote": {
          "data": null
        },
        "account": {
          "meta": {
            "included": false
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "author": {
          "data": {
            "type": "apiKeys",
            "id": "9c4b8ebd-ae0b-4812-a97b-92d8359fd1e0"
          }
        }
      }
    },
    {
      "id": "80b8dd61-35bc-49cc-9e04-f2c0f741a096",
      "type": "accounts",
      "attributes": {
        "master": true,
        "currencyCode": "USD",
        "label": "master",
        "bankReference": "BDR3455470827278341",
        "balance": "3614.05",
        "totalBalance": "3839.43",
        "bankWithdrawalAvailable": false,
        "bankDepositAvailable": true,
        "transferAvailable": true,
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "f83db4c7-b86c-4b45-8009-2c9d042eac1d",
      "type": "addresses",
      "attributes": {
        "label": "Tron (TRC20)",
        "value": "TXXnCyP46NcyH5aiM9LDx9him1kbWYJJmQ",
        "createdAt": "2026-01-12T18:04:40.953Z"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "7f044fef-f685-4a11-9fac-da5d962ade97",
      "type": "invoiceTransactions",
      "attributes": {
        "amountBilled": "1000.00",
        "billedChargedRate": "43.24547465",
        "billedChargedRateCurrency": "TRY",
        "consolidationFee": "23.73",
        "transactionFee": "10.00",
        "transactionFeeCurrency": "TRY",
        "targetTransactionFee": "0.23",
        "targetTransactionFeeCurrency": "USD",
        "simplifiedState": "pending"
      },
      "relationships": {
        "txn": {
          "data": {
            "type": "transactions",
            "id": "7f044fef-f685-4a11-9fac-da5d962ade97"
          }
        },
        "exchangeQuote": {
          "data": null
        },
        "account": {
          "meta": {
            "included": false
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "author": {
          "data": {
            "type": "apiKeys",
            "id": "b56961f4-46cf-4e60-bb32-b36addb09f66"
          }
        }
      }
    },
    {
      "id": "307f4dc9-5395-4a7b-b78d-7484985f7166",
      "type": "transactions",
      "attributes": {
        "createdAt": "2026-01-19T07:07:54.527Z",
        "simplifiedState": "pending",
        "transactionType": "InvoiceTransaction",
        "amount": "27.76",
        "currency": "EUR",
        "balance": null,
        "reference": "dd171c10-f246-4888-9759-ee39009745bf",
        "accountId": "adb0f9c4-c7fd-4989-a273-1bd11ad5847b"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "meta": {
            "included": false
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "9c4b8ebd-ae0b-4812-a97b-92d8359fd1e0",
      "type": "apiKeys",
      "attributes": {
        "name": "My API Key",
        "createdAt": "2025-07-04T08:07:13.549Z"
      }
    },
    {
      "id": "7f044fef-f685-4a11-9fac-da5d962ade97",
      "type": "transactions",
      "attributes": {
        "createdAt": "2026-01-17T12:58:59.293Z",
        "simplifiedState": "pending",
        "transactionType": "InvoiceTransaction",
        "amount": "22.33",
        "currency": "USD",
        "balance": null,
        "reference": "edeaa162-3b95-4aa1-b800-b1efa24fbcb6",
        "accountId": "80b8dd61-35bc-49cc-9e04-f2c0f741a096"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "meta": {
            "included": false
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "9c4b8ebd-ae0b-4812-a97b-92d8359fd1e0",
      "type": "apiKeys",
      "attributes": {
        "name": "My API Key",
        "createdAt": "2025-07-04T08:07:13.549Z"
      }
    },
    {
      "id": "b56961f4-46cf-4e60-bb32-b36addb09f66",
      "type": "apiKeys",
      "attributes": {
        "name": "Test API key",
        "createdAt": "2024-06-17T19:41:33.398Z"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 4637
  },
  "jsonapi": {
    "version": "1.0"
  }
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.txn.io/invoices/listing-invoices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.