Skip to main content

Creates a new invoice

Creates a new invoice

Request Body — REQUIRED
amount float — REQUIRED
name string
currency string

Case insensitive currency code as defined in ISO_4217

payment_currencies

Comma-separated coin filters which user can pay with.

For instance forwith Ethereum network and ETH coin: eth_eth and for Polygon network and ETH coin: polygon_eth

Currently supported networks/coins:

  1. ETH: eth_eth, eth_usdt, eth_usdc

  2. Polygon: polygon_eth, polygon_usdt, polygon_usdc

    Other supported filters: all, eth_stables, polygon_stables

    Where eth_stables stands for all stablecoins over Ethereum network.

valid_for string

Examples: 300s or 2h45m. Valid time units are s, m, h.

callback_url string

It must be valid HTTP(S) URI {{schema}}://{{host}}/?optionalQuery=value

success_url string

It must be valid HTTP(S) URI {{schema}}://{{host}}/?optionalQuery=value

fail_url string

It must be valid HTHTTP(S)TP URI {{schema}}://{{host}}/?optionalQuery=value

description string
meta_data1 string
meta_data2 string
Responses
200

New Invoice

Schema
id string — REQUIRED

Invoice id

url string — REQUIRED

Invoice URL

amount float — REQUIRED
paid_amount float
prices object[]
base_currency string — REQUIRED
name string
description string
account_name string
status string — REQUIRED

pending: If the payment of the invoice is not received, then the invoice status is shown as "pending". It will be initial status when the invoice is created.

paid: When invoice is received full amount, invoice status will be shown as "paid".

under paid: If the payment of the invoice has been paid in part, the invoice status is shown as "under paid".

over paid: f the payment of the invoice is greater than amount value, the status of the invoice is shown as "overpaid".

expired: if the payment of the invoice does not complete before the expiry time, the status of the invoice is shown as "expired".

cancelled: if customer cancels the invoice, the status of the invoice is shown as "cancelled".

status_code integer — REQUIRED

0: Pending

1: Paid

2: Underpaid

3: Over Paid

4: Expired

5: Cancelled

notify_url string
suceess_url string
fail_url string
expires_on

Invoice expiration time in RFC3339 format

payments undefined[]
tx_hash string
explorer_url string
amount float
date string

Invoice creation time in RFC3339 format

confirmation integer
created_at string — REQUIRED

Invoice creation time in RFC3339 format

updated_at string

Last updated time in RFC3339 format

meta_data1 string
meta_data2 string
400

Error response

Schema
message string
errors object[]
resource string
code string
field string
description string