Reading invoice
Last updated
Last updated
GET /api/public/v1/invoices/:id
This endpoint returns details of a particular invoice by its ID.
Headers
| Name | Value |
|---|---|
Path Parameters
| Name | Value |
|---|---|
Response Body
| Name | Type | Description |
|---|---|---|
Response
Content-Type
application/vnd.api+json
id
Invoice ID
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 cryptucurrency the end-user is required to pay.
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
Crypto currency that customer must pay in. Refer to supported currencies.
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
Invoice status context. 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.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.
included.type(addresses).attributes
object
Invocie receiving address. This is the address the end-user must send their crytpocurrency payment to.
included.type(invoiceTransactions).attributes
object
Invoice processing fee. This is how much Txn will debit from the finalized invoice payment before crediting funds to the merchant's account on the Txn platform - transactionFee.
included.type(coinDeposits).attributes
object
Data related to cryptocurrency payment/s made by the end-user. In this object you will find a transaction hash txHash, transaction amount amount and transaction timestamp createdAt.
included.type(transactions).attributes
object
Data related to invoice entries on the merchant's currency account on Txn. Efectively, this will be the amount credited to your account on the Txn platform after the invoice processing fees - amount. The amount currency code does always correspond with the billedCurrency code.
included.type(exchangeQuotes).attributes
object
This is the amount that the invoice payment resulted in before the invoice processing fee - amountReceived. This is how much you will usually want to credit to the end-user's balance on your end.
The exchangeRate value supplied in this object is always the effective exchange rate at which the end-user's cryptocurrency transaction was converted to billedCurrency.
>>> Normally, it matches the value of data.attributes.exchangeRate. However, if the invoice was underpaid, paid late, or overpaid, Txn applies the spot exchange rate, which will be reflected in this object. <<<