POST /invoice

POST/invoice

Create a payment invoice that returns a QR code string, deposit address, and warning messages. Use this when you want to build your own checkout UI.

Request body

Parameter	Type	Required	Description
`conversion_id`	string	Yes	Conversion ID obtained from `GET /prices`
`amount_in_usd`	string	Yes	Payment amount in USD
`amount_in_local_currency`	string	Yes	Payment amount in local currency
`amount_in_crypto`	string	Yes	Payment amount in the selected cryptocurrency
`crypto_code`	string	Yes	Asset code (e.g. `BTC`, `USDTERC20`)

Example request

{
  "conversion_id": "1xmKHnsJH23",
  "amount_in_usd": "5950",
  "amount_in_local_currency": "472750",
  "amount_in_crypto": "0.5",
  "crypto_code": "BTC"
}

curl example

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "conversion_id": "1xmKHnsJH23",
  "amount_in_usd": "5950",
  "amount_in_local_currency": "472750",
  "amount_in_crypto": "0.5",
  "crypto_code": "BTC"
}' 'https://api.ipint.io:8003/invoice'

Response (200)

{
  "invoice_id": "3hovNh96SmZXXaQ7PwEHc5Rr2B4E",
  "invoice_expired_in": "time in minutes",
  "deposit_crypto": "BTC",
  "deposit_address": "bc1qva0hpugr0t3zxah6fvcd7vunx2pw6efg3zyag8",
  "qr_string": "bitcoin:bc1qva0hpugr0t3zxah6fvcd7vunx2pw6efg3zyag8?amount=0.5",
  "invoice_amount_in_crypto": "0.5",
  "invoice_amount_in_usd": "5950",
  "local_currency_amount": "472750",
  "local_currency_code": "INR",
  "warning_messages": [
    "Send only Bitcoin to this deposit address. Sending any other coin will result in the loss of your deposit.",
    "Your transaction will be considered after it receives one confirmation on the Bitcoin network.",
    "Please make sure that the wallet you are using to pay this invoice has set enough mining fees.",
    "If your transaction arrives too late, the price may expire."
  ]
}

Response fields

Field	Type	Description
`invoice_id`	string	Unique invoice identifier
`invoice_expired_in`	string	Time until invoice expires (in minutes)
`deposit_crypto`	string	Which cryptocurrency to deposit
`deposit_address`	string	Wallet address the customer should send payment to
`qr_string`	string	QR code data string (render as QR image)
`invoice_amount_in_crypto`	string	Crypto amount the customer should send
`invoice_amount_in_usd`	string	Invoice amount in USD
`local_currency_amount`	string	Invoice amount in local currency
`local_currency_code`	string	Local currency code
`warning_messages`	string[]	Important warnings to display to the customer

Always display the warning_messages to the customer — they contain critical information about sending the correct cryptocurrency and mining fees.

crypto_code values

Asset	Network	`crypto_code`
USDT	Tron	`USDTTRC20`
USDT	Ethereum	`USDTERC20`
BTC	Bitcoin	`BTC`
ETH	Ethereum	`ETH`
TRX	Tron	`TRX`
LTC	Litecoin	`LTC`
DOGE	Dogecoin	`DOGE`
BCH	Bitcoin Cash	`BCH`
BNB	BNB Chain	`BNB`

Try it live

Open in Swagger UI →

Next steps

GET /invoice — check the status of this invoice
GET /prices — how to get the conversion_id
Webhooks — get notified when payment status changes

POST /invoice

On this page