API Reference
Start typing to search…

Get all Invoices

post https://api.calypso.finance/api/v1/invoice/all

Permission annotations:

Body Params
string
required

Merchant account ID. Request will be sent for this account

int64
required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

payload
object
required

Request data for getting invoices by state and type

Headers
string
required
string
required
Responses

Response body
object
result
array of objects
required

Array of requested objects

result*
object
string
required

Invoice id

string
required

Crypto address for deposit

string
required

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

SINGLE SINGLE_FIAT UNLIMITED UNLIMITED_LINKED BOUND

number

Amount of the invoice

number

Service fee for invoice. This amount will be deducted from invoice amount

number
required

The total amount of money received on the invoice wallet

string
required

Currency of the invoice

string
required

Status of the invoice

MEM_POOL_FOUND PENDING_PAYMENT PAID COMPLETED PENDING_INTERVENTION CANCEL ARCHIVED DECLINED PENDING_COMPLIANCE_CHECK

string

Hash of the last deposit transaction to the invoice

string
required

Short invoice description

date-time
required

Time of invoice creation

uuid
required

The external id in the uuid format that can be generated by user while creating the invoice

date-time

Server timestamp of invoice expiration moment

number

Amount of fiat money set for SINGLE_FIAT_INVOICE

string

Currency of featAmount

date-time

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

string

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

OVERPAY UNDERPAY

boolean
required

Represents whether the intervention was resolved or not (set by user)

boolean
required

Represents whether client subscribed on email notifications or not

string

Link to the web page where client can come back to from payment link (page with invoice data for payment)

string

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

string

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

string

Merchant ID that can be assigned to invoice or several invoices in string format

number

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

autoconversion
object

Response data of the Invoice Autoconversion configuration

boolean
required

Fiat available

int32
required

Numeric value indicating the page number

int32
required

Numeric value indicating the page size

int32
required

Total number of pages matching the query

int64
required

Total number of objects matching the query

Updated 30 days ago

Did this page help you?
Language

Updated 30 days ago

Did this page help you?