Invoices
Invoices are bills with indication of a sum and payment address which you render to payers. The invoice currency may differ from the wallet currency — a payer can specify any currency for the invoice.
Key points
The system accepts payments in crypto currency and allows you to enroll and withdraw funds in fiat currency.
Each transaction requires a certain number of confirmations in the blockchain.
The processing speed of a transaction in the blockchain depends on the blockchain fee amount.
Information about new transfers associated with an invoice can be sent to your system via a callback.
Each transaction can be assigned a special identifier by which the transaction can be tracked in your system.
It is possible to generate a payment page in order to send payment details to your payers.
It is possible to set time limits to specify the expiration time for the invoice as well as payment limits to hedge possible payment amount variations due to rate changes.
Types of invoices
With no sum and no time indication — this type of invoice has no indication of sum and expiration time.
With indication of sum and time — this type of invoice contains information about the sum and time of the operation. A receiver of such invoice can recalculate the sum of the invoice according to the current rates by clicking the Recalculate button.
With indication of time limit — this type of invoice contains information about the expiration time and no indication of sum.
With indication of sum limit — this type of invoice contains information about the payment amount and no indication of the expiration time.
Invoices list
- ID
The invoice identifier. This is a link to the invoice detailed information.
- Created
The date and time of invoice creation.
- Wallet
Name of the wallet to which funds are credited. This is a link to the wallet details.
- Address
Payment address of the invoice in the blockchain. This is a link to the explorer.
- Currency
Payment currency (including tokens).
- Tracking ID
Identifier of the payment in the client system.
- Status
Status of the invoice. Possible values:
Invoice — the invoice has just been created, or funds are not received in full if there were invoice amount limits.
Paid — the invoice with indication of sum is paid in full.
Cancelled — the invoice is cancelled by a user.
Unresolved — the invoice needs actions from the user (for example, if the payment is received after the specified expiration date, the status of such invoice cannot be changed automatically and the invoice needs actions from the user). Navigate to Invoice details to change the invoice status manually.
- Requested amount
The requested amount in the wallet currency.
- Requested rate
The rate that is up to date when an invoice is created. This rate is updated in 15 minutes after the invoice creation.
- Paid amount
Amount of funds sent by a payer.
- Enrolled amount
Amount received by the client. This is a paid amount minus the commission.
- Commission
- Expired at
The date and time of the expiration of the invoice with indication of time. If the invoice has no time indication, the field is blank.
Invoice details
To access Invoice details, click the invoice ID on the invoices list page.
The Invoice details page includes two tabs: Info and Log.
The Info tab contains the essential invoice information:
- Address
Payment address of the invoice in the blockchain. This is a link to the explorer, this field cannot be edited.
- View payment page button
Click this button to view the payment page. If the payment currency was selected when creating the invoice, you can view the QR code that contains the address of your deposit. You can use any QR-code generator library to create a QR code. If the payment currency was not selected, you can see a list of available payment currencies on the payment page. Select the desired payment currency to generate the QR-code.
- Payment currency
The name of the payment currency.
- Estimated amount payable
The amount in the payment currency (if the payment currency was specified). The value is updated along with the requested rate value.
- Wallet
The name of the wallet, to which the funds were credited.
- Requested amount
The requested payment amount in wallet currency.
- Requested amount
The requested payment amount in wallet currency.
- Paid in
The amount paid in the wallet currency.
- Enrolled in
Paid amount minus commission.
- Commission
Commission amount.
- Limits
The payment limits and expiration time of the invoice.
- Change status
The current status of the invoice. To change the status, click it and select the desired status.
- Limits
The payment limits and expiration time of the invoice.
- Change status
The current status of the invoice. To change the status, click it and select the desired status.
- Limits
The payment limits and expiration time of the invoice.
- Change status
The current status of the invoice. To change the status, click it and select the desired status.
- The Advanced options section
Additional invoice settings. The section contains the following fields:
- Label
The invoice name.
- Tracking ID
The identifier of the payment in the client system.
- Callback URL
URL for callback notifications on invoices. Such notifications may contain templates. To find out more about the templates, refer to How to create an invoice.
- Required block confirmations for callback
Number of confirmations to receive an additional callback. If this field is nor blank, two callbacks are sent: upon receiving the number of confirmations specified here and upon receiving the number of confirmations specified in the system settings.
- The Transactions section
A list of transactions. Transaction IDs are links to transfers details (refer to Transfer details for more details).
The Log tab contains the invoice history:
- Created at
The date and time of an action.
- Initiator
The field can have the one of the following values:
System — system actions, such as invoice creation or status change.
API — actions performed via the system API.
Email address — actions performed by a specific user via the system user interface.
- Reason
A particular reason for the action. The field can have the following values:
Created — the invoice has been created
Changed — the invoice has been changed
Deleted — the invoice has been deleted
- Comment
The description of the action.
- Old value
Previous state of the invoice.
- Actual value
Current state of the invoice.
See also