Invoices
Invoice API Methods and Refference
Last updated
Was this helpful?
Invoice API Methods and Refference
Last updated
Was this helpful?
Id is unique identifier that represents Invoice object for quering details of specific invoice
Parent id points to relative invoice that was parent in the chain of invoices. Sometimes we need to make several tranches, thats how we can bind several invoices into chain.
Client id is a identifier of your customer. Its represents a unique UUID v4 that pointers to specific user or customer to whom you direct your invoice. If you have account managment system, you may input user's id in your DB as client_id to easy bind your user's payments separate from others.
Amount of funds needed to complete invoice. It's depends on choosen currency in invoice body while creating, to calculate current rates and amount that left to pay.
Represents amount of funds to current invoice currency that was already submited as paid in one or several transactions.
Type of invoice. For now we support "payment" only.
Status of the invoice represents it's current stage. It may be ACTIVE / SUCCESS / CANCELED.
Represents timestamp when invoice was created.
Represents timestamp of new transactions appears in the Invoice or invoice status changes.
See products API section
See payload section
Retrieves a list of all invoices associated with the authenticated merchant. Results are paginated and can be filtered by status.
API version, must be 2
Retrieves detailed information about a specific invoice
Invoice ID
API version, must be 2
Cancels an active invoice. Cancelled invoices cannot receive payments. Only active invoices can be cancelled.
Invoice ID to cancel
API version, must be 2
Creates a new invoice for specified amount and currency. The invoice can be associated with specific products.
API version, must be 2
ID of the merchant application
Type of invoice, currently only 'payment' is supported
ID of the client who needs to pay
Three-letter currency code (e.g., USD)
Total amount to be paid