Listing invoices
GET /api/public/v1/invoices
This endpoint returns a list of invoices with pagination.
Headers
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
URL Parameters
order
string
Field to order the list of invoices by. Currently the only supported value is created_at.
order_type
string
Order type. Can be either asc or desc.
page
number
Page for which you want to return invoices.
per_page
number
Number of invoices per page to return.
reference
string
Invoice reference.
created_at_from
string
Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.
created_at_to
string
Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.
Response Body
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.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.networkName
string
Network name to display.
data[].attributes.paymentMethods
array
Invoice payment methods.
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.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 for the NFT payment feature. null when not enabled.
data[].relationships.targetAccount.type
string
Entity type of the settlement account. Always accounts.
data[].relationships.targetAccount.id
string
ID of the account to which the invoice payment is credited.
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(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.name
string
Name of the API key that created the invoice.
included[].type(apiKeys).attributes.createdAt
string
Timestamp when the API key was created.
meta.page
number
Current page number.
meta.per_page
number
Page size used for the response.
meta.total
number
Total number of invoices matching the query.
Response
Last updated