The invoicing feature lets you easily request cryptocurrency payments from your customers. You can manage your payments, track your invoice status, and review your transaction history all in one place.
The Invoice Object
Name
Type
Description
id
Number
Unique identifier for the object
uuid
String
Invoice uuid. A UUID (Universal Unique Identifier) is a 128-bit value used to uniquely identify an object or entity
checkoutId
Number
Unique identifier for the checkout object
label
String
An Invoice description
logoUrl
String
Client-provided logo url for the invoice page
invoiceUrl
String
Invoice url
currency
String
The Invoice currency: alphabetic currency code
network
String
Parent blockchain
address
String
Blockchain address
tag
String
Destination tags are unique identification codes used by cryptocurrencies to identify the receiver of a transaction
trackingId
String
Client-provided identifier of the payment in the external system
expectedAmount
Decimal
Expected amount to be paid
paidAmount
Decimal
Actual paid amount
walletId
Number
Wallet id to accept payment in
walletCurrency
String
Alphabetic currency code of the wallet
numberOfPayments
Number
Number of payments for this invoice
blockExplorerUrl
String
Block explorer address url
processingtype
String
Processing type
status
String
The status of the invoice
webhookUrl
String
A client provided callback URI to receive messages by the actions of the invoice
Array of payments without transactions and conversions
Commerce Solution: Create a new Invoice
POST/api/v2/invoices/create
Creates a new Invoice for the Commerce Solution
Headers
Name
Type
Description
Accept*
applicaiton/json
Request Body
Name
Type
Description
amount*
String
Invoice amount
currency*
String
Invoice currency
label
String
Invoice label
trackingId*
String
Client provided identifier of the payment in the external system
webhookUrl*
String
Notification URL
Crypto Wallets Solution: Create a new Invoice
POST/api/v2/invoices/crypto-wallets/create
Creates a new Invoice for the Crypto Wallets Solution
Headers
Name
Type
Description
Accept*
applicaiton/json
Request Body
Name
Type
Description
amount*
String
Invoice amount
label
String
Invoice label
trackingId*
String
Client provided identifier of the payment in the external system
walletId*
String
Wallet id to receive funds in
walletCurrency*
String
Wallet currency
webhookUrl*
String
Notification URL
Updates an existing invoice
PUT/api/v2/invoices/update/{id}
Headers
Name
Type
Description
Accept*
application/json
Request Body
Name
Type
Description
label
String
Invoice label
amount
String
Invoice amount
walletId*
String
Wallet id to receive funds in
webhookUrl
String
Notification URL
Lists all Invoices
GET/api/v2/invoices
Returns a list of previously created Invoices. The Invoices are returned in sorted order, with the most recent invoice appearing first. You can optionally provide parameters to filter out the results by time created.
Query Parameters
Name
Type
Description
from
Date
Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
to
Date
Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
page
Number
Get Invoice by id
GET/api/v2/invoices/{id}
Retrieves the details of an Invoice that has previously been created. Supply the id and the API will return the corresponding Invoice information.
Path Parameters
Name
Type
Description
id*
Number
Unique identifier for the object.
Headers
Name
Type
Description
Accept*
applicaiton/json
Get Invoice by Uuid
GET/api/v2/invoices/uuid/{uuid}
Retrieves the details of an Invoice that has previously been created. Supply the Uuid and the API will return the corresponding Invoice information.
