search
Sandbox LoginProduction LoginStatus Page

Listing invoices

GET /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

Name
Type
Description

order

string

Order in which the list of transactions should be returned. Can be created_at.

order_type

string

Order type. Can be either asc or desc.

page

number

Page for which you want to return transactions.

per_page

number

Number of transactions per page to return.

reference

number

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

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 cryptucurrency 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

Crypto currency that 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

Charged currency to target currency exchange rate.

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.paymentMethods

string

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.

included.type(addresses).attributes

object

Invocie receiving address. This is the address the end-user must send their crytpocurrency 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.amountBilled

object

This is the amount the invoice payment results in before fees. This is typically the amount merchants credit to an end-user’s balance on their platform.

Response

PreviousReading invoiceNextInvoice refunds

Last updated