Reading invoice

GET /api/public/v1/invoices/:id

This endpoint returns details of a particular invoice by its ID.

Headers

Name	Value
Content-Type	application/vnd.api+json

Path Parameters

Name	Value
id	Invoice ID

Response Body

Name	Type	Description
data.id	string	Invoice ID.
data.type	string	Entity type returned. Always invoices.
data.attributes	object	Set of invoice attributes.
data.attributes.amountBilled	string	Invoice amount to display to end users. Determines the amount due after conversion.
data.attributes.amountCharged	string	Amount due. Determines the amount of cryptocurrency the end-user is required to pay.
data.attributes.targetAmount	string	Amount you will receive into your target currency account.
data.attributes.billedCurrency	string	Invoice currency to display to end users. Determines the currency due after conversion. Refer to supported currencies.
data.attributes.chargedCurrency	string	Cryptocurrency that the customer must pay in. Refer to supported currencies.
data.attributes.targetCurrency	string	Settlement currency. This is the currency you will receive in your account after the payment is processed.
data.attributes.targetAccountId	string	The ID of the account to which the invoice payment is credited.
data.attributes.chargedTargetRate	string	Charged currency to target currency exchange rate.
data.attributes.chargedTargetRateCurrency	string	Currency in which chargedTargetRate is quoted.
data.attributes.reference	string	The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose.
data.attributes.statusContext	string	Indicates whether the end-user paid in full, underpaid, overpaid, or has not paid (unpaid) the invoice. Refer to Invoice status flow.
data.attributes.network	string	Network code. Refer to Supported currencies.
data.attributes.networkName	string	Network name to display.
data.attributes.paymentMethods	array	Invoice payment methods.
data.attributes.status	string	Invoice status. Refer to Invoice status flow.
data.attributes.successRedirectUrl	string	URL your customer will be redirected from our hosted page to if the invoice completes.
data.attributes.unsuccessRedirectUrl	string	URL your customer will be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.
data.attributes.paymentStatus	string	Invoice payment status. Refer to Invoice status flow.
data.attributes.exchangeRate	string	Invoice exchange rate valid for 20 minutes.
data.attributes.expiresAt	string	Invoice expiry date and time.
data.attributes.createdAt	string	Date and time invoice was created at.
data.attributes.hostedPageUrl	string	Invoice hosted page.
data.attributes.scAddress	string	Smart contract address configured for the NFT payment feature. Returns null if the feature is not enabled on the merchant account.
included.type(addresses).attributes	object	Invoice receiving address. This is the address the end-user must send their cryptocurrency payment to.
included.type(binanceOrders).attributes	object	Payment instructions for an off-chain payment via the Binance application.
included.type(coinTransactions).attributes	object	Details of a crypto payment received at the invoice address, including txHash, currencyCode, amount, and other related fields.
included.type(coinTransactions).attributes.sourceAddresses	array	Wallet address(es) the funds were sent from. Typically a single address; may contain multiple entries when the deposit arrived via a UTXO-based network (BTC, LTC, BCH, DOGE, etc.) and the sender's wallet combined several inputs.
included.type(invoiceTransactions).attributes	object	Details of the invoice transaction, including billedChargedRate, transactionFee, targetTransactionFee, and related fields.
included.type(invoiceTransactions).attributes.amountBilled	string	The actual payment amount in billedCurrency, 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 transactionFee and targetTransactionFee for the fee breakdown.
included.type(apiKeys).attributes	object	Details of the API key that created the invoice, including name and createdAt.

Response

HTTP 200

{
  "data": {
    "id": "ab0fbca0-a6b1-41af-95c7-b2ae4595f72d",
    "type": "invoices",
    "attributes": {
      "amountBilled": "1000.00",
      "amountCharged": "140.743359",
      "targetAmount": "119.73",
      "billedCurrency": "CNY",
      "chargedCurrency": "USDT",
      "targetCurrency": "EUR",
      "chargedTargetRate": "0.8593002",
      "chargedTargetRateCurrency": "EUR",
      "reference": "eef67ca4-286b-4c75-ad79-4f313c582c40",
      "statusContext": "underpaid",
      "network": "ttrx:usdt",
      "networkName": "Tron (TRC20)",
      "paymentMethods": [
        "on_chain"
      ],
      "status": "completed",
      "successRedirectUrl": "https://paymentsucceeded.com",
      "unsuccessRedirectUrl": "https://paymentfailed.com",
      "paymentStatus": "on_time",
      "exchangeRate": "7.105131",
      "expiresAt": "2025-06-20T14:46:32.246Z",
      "createdAt": "2025-06-20T12:46:32.342Z",
      "hostedPageUrl": "https://sandbox.txn.io/redirect?invoice_id=ab0fbca0-a6b1-41af-95c7-b2ae4595f72d&request_type=invoice_hosted_page&zone=eu",
      "scAddress": null
    },
    "relationships": {
      "targetAccount": {
        "data": {
          "type": "accounts",
          "id": "13a85b45-8543-41c7-b963-394d4ea128ae"
        }
      },
      "binanceOrder": {
        "data": null
      },
      "address": {
        "data": {
          "type": "addresses",
          "id": "40402ed1-9bca-4ae8-9c33-1eff05280a2d"
        }
      },
      "refundLinks": {
        "data": []
      },
      "invoiceTransactions": {
        "data": [
          {
            "type": "invoiceTransactions",
            "id": "1ab6e545-ec8e-4670-aaba-29c79e9d88f5"
          }
        ]
      },
      "coinDeposits": {
        "data": [
          {
            "type": "coinTransactions",
            "id": "289a039f-6821-48e1-b311-1167563e5855"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "40402ed1-9bca-4ae8-9c33-1eff05280a2d",
      "type": "addresses",
      "attributes": {
        "label": "Tron (TRC20)",
        "value": "TCg2JQZSVJLufjzw6nodJiX5zkjtHK45sq",
        "createdAt": "2025-06-19T07:39:11.939Z"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1ab6e545-ec8e-4670-aaba-29c79e9d88f5",
      "type": "invoiceTransactions",
      "attributes": {
        "amountBilled": "703.41",
        "billedChargedRate": "7.105131",
        "billedChargedRateCurrency": "CNY",
        "consolidationFee": "0.00",
        "transactionFee": "7.03",
        "transactionFeeCurrency": "CNY",
        "targetTransactionFee": "0.85",
        "targetTransactionFeeCurrency": "EUR",
        "simplifiedState": "completed"
      },
      "relationships": {
        "txn": {
          "data": {
            "type": "transactions",
            "id": "1ab6e545-ec8e-4670-aaba-29c79e9d88f5"
          }
        },
        "exchangeQuote": {
          "data": {
            "type": "exchangeQuotes",
            "id": "363a412f-dd92-4f03-88b9-1605dece439c"
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "289a039f-6821-48e1-b311-1167563e5855",
      "type": "coinTransactions",
      "attributes": {
        "txHash": "0c772b228a03d15beb83603b2b2ab5905c808940877d28e8d27445a4e239daa7",
        "currencyCode": "USDT",
        "createdAt": "2025-06-20T12:48:51.234Z",
        "state": "processed",
        "amount": "99.000000",
        "accountId": "e289de2b-37bd-4eff-b832-f754c31a2d95",
        "sourceAddresses": [
          "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe"
        ],
        "simplifiedState": "processed"
      },
      "relationships": {
        "network": {
          "meta": {
            "included": false
          }
        },
        "address": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1ab6e545-ec8e-4670-aaba-29c79e9d88f5",
      "type": "transactions",
      "attributes": {
        "createdAt": "2025-06-20T12:49:01.324Z",
        "simplifiedState": "completed",
        "transactionType": "InvoiceTransaction",
        "amount": "84.29",
        "currency": "EUR",
        "balance": null,
        "reference": "eef67ca4-286b-4c75-ad79-4f313c582c40",
        "accountId": "13a85b45-8543-41c7-b963-394d4ea128ae"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "363a412f-dd92-4f03-88b9-1605dece439c",
      "type": "exchangeQuotes",
      "attributes": {
        "expiresAt": "2025-06-20T12:49:31.478Z",
        "amountCharged": "99.0",
        "amountReceived": "85.14",
        "rate": "0.8600328",
        "exchangeFee": "0.00",
        "exchangeFeeCurrency": "EUR",
        "rateCurrency": "EUR",
        "accountChargedId": "e289de2b-37bd-4eff-b832-f754c31a2d95",
        "accountReceivedId": "13a85b45-8543-41c7-b963-394d4ea128ae",
        "status": "completed",
        "amountChargedCurrency": "USDT",
        "amountReceivedCurrency": "EUR"
      },
      "relationships": {
        "exchangeOrder": {
          "meta": {
            "included": false
          }
        },
        "transactions": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "type": "accounts",
      "attributes": {
        "master": true,
        "currencyCode": "EUR",
        "label": "master",
        "bankReference": "BDR6421088115176062",
        "balance": "38202.60",
        "totalBalance": null,
        "bankWithdrawalAvailable": true,
        "bankDepositAvailable": true,
        "transferAvailable": true,
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        },
        "txnBankCredentials": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "45550837-2dc6-4652-9cbf-bfbe4e16382e",
      "type": "apiKeys",
      "attributes": {
        "name": "Test API key",
        "createdAt": "2024-06-17T19:41:33.398Z"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

HTTP 404