Create invoice

post

https://sandbox-api.unipayment.io/v1.0/invoices

Creates a new invoice for payment. This action initiates the process of generating an invoice that can be presented to the buyer for payment. The invoice includes details such as the amount, currency, and other relevant information.

Body Params

app_id

string

required

The unique identifier for the payment application. This ID is necessary to authorize the invoice creation request.

price_amount

float

required

The amount to be collected from the buyer. This value must be a positive number.

price_currency

string

required

The currency code defining the fiat currency in which the invoice is priced. Examples include USD, EUR.

payment_method_type

string

enum

The method by which the payment will be made. This can be set to various options such as Crypto, Card, Skrill, etc. Supported Method Types: https://unipayment.readme.io/reference/payment-method-type

Allowed:

pay_currency

string

The currency code defining the currency in which the buyer will make the payment. This can be either a cryptocurrency (e.g., BTC, ETH) or a fiat currency (e.g., USD, EUR).

network

string

enum

Specifies the blockchain network the buyer will use to make the payment if a cryptocurrency is selected.

Allowed:

notify_url

string

Defaults to https://example.com/payment/callbak

The URL where the gateway sends webhook notifications when the invoice status changes. If not specified, the global settings for the payment application will be used.

redirect_url

string

Defaults to http://example.com/pay/result

The URL to which the buyer is redirected after returning from the checkout page. Defaults to http://example.com/pay/result.

order_id

string

required

Defaults to ORDER_123456

A unique identifier for the merchant's order. Using a unique order ID helps in matching it with the invoice ID.

title

string

Defaults to Demo Title

The title of the invoice, displayed on the checkout page. Examples include product title (e.g., "MacBook Pro") or order ID (e.g., "MyShop Order #12345").

description

string

A detailed description of the invoice, displayed on the checkout page. Maximum 256 characters.

lang

string

The language of the checkout page. Defaults to "en" if not specified.

extra_args

string

A passthrough variable provided by the merchant for correlating the invoice with an order or other object in their system.

buyer_info

object

Detailed information about the buyer.

Response

200200