Invoice
| Field | Type | Description |
|---|---|---|
| app_id | string | The unique identifier for the payment application. |
| payment_method_type | string | The method by which the payment will be made. Options include cryptocurrency, card, skrill, etc. |
| invoice_id | string | The unique identifier for the generated invoice from UniPayment. |
| order_id | string | A unique identifier for the merchant's order. Using a unique order ID helps in matching it with the invoice ID. |
| price_amount | float | The amount to be collected from the buyer, as specified in the request. |
| price_currency | string | The currency in which the invoice is priced, as specified in the request. |
| network | string | The specified blockchain network through which the buyer will send the payment. (Applicable for cryptocurrency payments) |
| address | string | The blockchain address to which the buyer will send the payment. (Applicable for cryptocurrency payments) |
| pay_amount | float | The amount that the buyer will pay, specified in the pay currency. |
| pay_currency | string | The currency in which the buyer will make the payment. This can be either a cryptocurrency or a fiat currency. |
| exchange_rate | float | The exchange rate between the price currency and the pay currency at the time of the invoice creation. |
| paid_amount | float | The amount that has been paid by the buyer so far. |
| refunded_price_amount | float | The amount that has been refunded to the buyer, if any. |
| create_time | datetime | The timestamp when the invoice was created. |
| expiration_time | datetime | The time window during which the invoice can be paid. After this time, the invoice status will change to expired. |
| confirm_speed | string | The speed at which blockchain confirmations are processed. (Applicable for cryptocurrency payments) |
| host_to_host_mode | boolean | Indicates if HostToHost mode is enabled. Returns true if enabled |
| host_to_host_data | object | Contains payment details when HostToHost mode is enabled. Structure varies by payment method. See Details. |
| status | string | The current status of the invoice. See Invoice Status. |
| error_status | string | The error status of the invoice, if any. This indicates any issues encountered during the invoice processing. |
| invoice_url | string | The URL of the invoice, which can be used by the merchant for checkout or to prepare their own checkout page using the response data. |
Invoice Detail
The Invoice Detail Object represents detailed information about a specific invoice in the system. It is returned by the GetInvoice API and includes additional fields such as Refunds and Transactions, offering a complete view of all activities related to the invoice.
For more information about the structure and fields of these objects, refer to their respective documentation sections:
InvoiceRefund Object: Describes the fields and status values associated with a refund, including refund amount, status, fee details, and more.
Transaction Object: Provides details about individual payment transactions, including transaction amount, currency, status, and timestamps.
CardTransaction
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier for the transaction. |
| asset_type | string | The currency used in the transaction (e.g., EUR, USD). |
| amount | float | The transaction amount in the specified currency. |
| remote_transaction_id | string | The unique identifier for the transaction on the payment provider's side. |
| holder_name | string | The cardholder's name as it appears on the card. |
| card_type | string | The type of card used in the transaction (e.g., VI for Visa, MC for MasterCard). |
| card_bin | string | The first six digits of the card number, identifying the issuing bank and card type. |
| last_digits | string | The last four digits of the card used for the transaction. |
| card_category | string | The category of the card (e.g., DEBIT, CREDIT, PREPAID). |
| issuing_bank | string | The name of the bank that issued the card. Can be null if the information is not available. |
| issuing_country | string | The country where the card was issued, represented by the ISO 3166-1 alpha-2 country code (e.g., US). |
| customer_ip | string | The IP address of the customer who initiated the transaction. |
| create_time | string | The timestamp when the transaction was created, in ISO 8601 format. |
CryptoTransaction
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier for the transaction. |
| asset_type | string | The type of cryptocurrency used in the transaction (e.g., BTC, ETH, UTT). |
| amount | float | The amount of cryptocurrency transferred in the transaction. |
| network | string | The blockchain network through which the transaction was processed (e.g., NETWORK_BSC, NETWORK_ETH). |
| from | string | The sender's blockchain address. |
| to | string | The recipient's blockchain address. |
| hash | string | The unique hash of the blockchain transaction, used to track the transaction on the blockchain. |
| is_confirmed | boolean | Indicates whether the transaction has been confirmed on the blockchain. |
| create_time | string | The timestamp when the transaction was created, in ISO 8601 format. |
SkrillTransaction
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier for the APM transaction. |
| symbol | string | The currency symbol used in the transaction (e.g., EUR, USD). |
| amount | float | The amount processed in the transaction. |
| remote_transaction_id | string | The unique identifier for the transaction on the payment provider's side. |
| create_time | string | The timestamp when the transaction was created, in ISO 8601 format. |
.