# Documentation Overview
The purpose of this documentation is to illustrate how to integrate any project with Trybit and start accepting cryptocurrency payments.
## About the service
[Trybit](https://trybit.com/) is a payment gateway that allows you to accept and process payments conveniently in popular cryptocurrencies. With our crypto acquiring service, you can connect cryptocurrency payment acceptance to an online service, online store, online school, Telegram bot and other platforms.
Our API is designed to provide flexibility and convenience for developers integrating cryptocurrency into their applications and platforms.
## Key API features
* **Invoice management:** create, manage and monitor your invoices in real-time.
* **Transaction automatization:** set up automatic payments and withdrawals to crypto wallets.
* **Security and transparency:** high level of transaction security and full transparency of all operations.
You can connect to your website or other platform in several ways:
* [API](/api-reference-v2/authorization);
* [Host2Host (H2H);](/api-reference-v2/h2h)
* [CMS plugins](/cms-plugins/list);
* [HTML forms and buttons](/buttons-forms/html-widget).
Choose the method that suits your needs and contact our support if you have any questions.
# How the Integration Works
Trybit integration involves your platform interacting with our API to automate transactions. Here's how it works:
1. **Request authorization:**
* All requests to the API must be authorized using your API keys.
2. **Invoice creation:**
* You submit a request to create an invoice, specifying the required parameters and total amount.
3. **Receiving a payment link or payment details:**
* In response to your request, the system generates and sends you a unique payment link or payment details.
4. **User payment:**
* Your user completes the payment via the provided link or payment details.
5. **Funds receipt notification:**
* Once funds are received in your account, we send a POSTBACK to the notification URL specified in your project settings.
* You need to process this notification and, if necessary, take the corresponding action on the side of your platform.
6. Invoice verification:
* You can independently verify the status of an invoice using its INV number through a corresponding request to the API.
This process provides a secure and efficient interaction between your platform and the Trybit service, allowing you to automate the payment acceptance and account management process.
# Integration Testing
After you have added your project, a test mode is automatically enabled. It is necessary to check the correctness of integration.
The current mode of the project can be tracked in the «My Projects» section.
{% hint style="info" %}
When the test mode is enabled, you can create invoices in any available way and confirm them without making a payment. These invoices will not change your balance.
{% endhint %}
1. To test the integration, you need to create an invoice by going to the checkout on your website or another platform you have integrated with. Creating an invoice manually in the «Payments» section will not test the integration with your platform.
2. To confirm the test invoice and send a payment notification, you need to go to the «Payments» section, turn on the «Show test invoices» toggle, find the required invoice and click on it.
After opening the page with information about the invoice, you will see the «Confirm invoice without payment» button.
3. When you click on this button, we will send a notification of successful payment to the «Notification URL» of your project. After sending, the invoice status in your personal account and on the payment page will automatically change to «Paid». No funds will be credited to the balance.
If, after clicking on the «Confirm invoice without payment» button, the status on the page of the created invoice has not changed, you need to make adjustments to the integration settings. In your personal account, the status of the created invoice will automatically change to «Created». After making changes to the integration settings, you can send the notification again.
To view the notification status, go to the “POSTBACK History” section. Clicking a specific notification opens a window with the request sent and the response received from your server. After exiting test mode, you can resend a notification for an already paid invoice in this section.
After the integration is configured and tested, make sure that all fields in the project are filled in correctly. Then send a request to exit the test mode — it will take up to 24 hours from the moment of sending. You can track the status of the request in your personal account.
When the test mode is turned off, you can create invoices in any available way, but the only way to confirm them will be to pay the invoice fully. The payments of these invoices will be credited to your balance.
If necessary, you can enable test mode at any time. To activate payment acceptance again, you must resubmit a request to exit test mode.
# How to Get API Keys
To work with the Trybit API, you will need to get unique API keys. These keys identify your project and enable secure communication between your platform and the Trybit service. Here's how you can get your API keys:
1. **Log in to your personal account:**
* Register and log in to your personal account on the Trybit platform.
2. **Create a new project:**
* Go to «My Projects» in the left menu.
* Click the «Create a new project» button.
* In the «How do you want to accept payments» section, select «On your website».
* Fill in all the required parameters.
3. **Receiving keys:**
* After creating a project, go to its settings.
* On the right side of the screen, find the section with your API KEY, SHOP ID and SECRET KEY.
{% hint style="info" %}
[How can I add a project?](https://support.trybit.com/getting-started/add-project)
{% endhint %}
You now have all the keys you need to work with the Trybit API. Keep them secured and do not share them with third parties.
# SDK for Work with API
In this section, you can download an SDK that makes integrating with our API much easier and faster. Here are the basic steps to help you get started:
1. **Download the SDK:**
Download the latest version of the SDK for your platform. Our SDK is available for various programming languages, providing maximum flexibility and convenience for your project.
{% file src="/files/TplD59s5PwZpnL62Xd0p" %}
2. **Connect the SDK file:**\
After downloading, simply add the SDK file to your project. It's easy to do. Our documentation provides detailed instructions for each programming language.
3. **Start the integration:**
With the SDK, you can quickly set up a connection to our API. The SDK includes a set of handy functions and methods that make it easy to send requests and process responses.
Start using our SDK today and speed up the process of integrating applications with our API!
# Integration of Icons and Buttons
Proper use of branded elements helps create a unified and recognizable user experience and increases conversion rates during the payment selection process.
The Trybit Brand Guide is designed to simplify the work for everyone who interacts with our brand. It provides clear instructions for the correct use of:
* Trybit logos on your website and marketing materials;
* The color palette and typography;
* Icons for available payment methods (BTC, ETH, USDT, and others);
* Payment buttons and banners for integration into the checkout process.
Branded Elements. This section contains everything you need for the proper use of the brand’s visual components: logos, buttons, icons, and other elements for designing payment pages and interfaces.
Marketing Materials. Here you will find ready-to-use recommendations on how to inform your users about the new cryptocurrency payment option via Trybit: banners, texts, and examples of placement on your website and communication channels.
Using the Brand Guide Helps:
* Build customer trust;
* Create a consistent brand image;
* Increase the number of successful payments and repeat purchases;
* Boost the average order value and overall website conversion rates.
Proper integration of Trybit icons and buttons makes the payment process clear and predictable for users, positively impacting all key business metrics.
# Cryptocurrency payment instruction
This section offers a cryptocurrency payment instruction template for your customers. You can place it on your website as well as on the checkout page.
{% hint style="info" %}
Publishing payment instructions helps increase conversion, especially for customers with little experience in cryptocurrency transactions.
{% endhint %}
We are pleased to offer you a convenient and secure cryptocurrency payment method. \[Company Name] accepts payment in Tether (USDT), Bitcoin (BTC), Ethereum (ETH), Litecoin (LTC) and other cryptocurrencies.
Below is a simple guide to help you through this payment process.
### 1. Creating an order
Create an order on our website and go to the payment page. In the payment methods, select «Trybit». You will be redirected to the created invoice page.
### 2. Select cryptocurrency for payment
Select the cryptocurrency and network you want to use for payment from the list of supported ones. Also, provide an email address to receive payment notifications.
Make sure that your cryptocurrency wallet has enough funds to complete the payment. Remember that sending funds in cryptocurrency involves charging a network fee. Next, click the «Pay» button.
### 3. Receiving payment address
The next payment process step will display a unique payment address for making the transaction with a QR code.
Copy the payment address or scan the QR code using your cryptocurrency wallet or exchange's mobile app. Make sure to be accurate, as sending cryptocurrency to the wrong address can result in loss of funds.
### 4. Making payment from your wallet
Open your cryptocurrency wallet from which you are going to send the payment. Select the appropriate cryptocurrency and network in the «Send» or «Withdraw» section.
Enter your wallet's copied address (or scan the QR code). Enter the exact amount of cryptocurrency needed for the transaction.
Remember about the transaction fee charged by your wallet or blockchain network, which may need to be added to the total amount of funds sent. When sending money, you need to verify that the correct amount reaches the Trybit service after all fee deductions.
Most providers add the commission to the required sum, but there are wallets and exchanges where the commission amount is deducted from the total transfer amount.
If you send the wrong funds amount, the system will detect your payment and calculate the minimum amount to be paid.
### 5. Confirmation and sending of payment
The invoice is available for payment for a limited time. On the payment page, there is a countdown timer for your convenience.
If you have sent funds and the invoice has expired, it will be confirmed as soon as the funds are received. If your invoice expires and you have not yet paid, we advise you to create or submit a new invoice for payment.
Double-check the address and amount before confirming the transaction. Remember that transactions on the blockchain are irreversible. Next, follow your wallet's procedure to authorize and submit the transaction. This may include two-factor authentication or other security measures.
### 6. Waiting for confirmation from the blockchain
Once confirmed, the transaction data will be sent to the blockchain. Once the payment service identifies your transaction, the status on the screen will change. The transaction confirmation speed depends on the selected cryptocurrency and the workload of the blockchain network. It usually takes between 2 to 10 minutes to confirm a transaction. Bitcoin bill payments can take up to 1 hour or more.
You can use a blockchain explorer, such as [Blockchair](https://blockchair.com/) or [Tronscan](https://tronscan.org/#/), to monitor transactions. You will need a transaction ID, usually provided by the wallet, after the payment is sent.
### 7. Completing the order
Once the transaction has been confirmed by the payment service, you will receive a notification of successful payment. At this point, the status of your order will change to «Paid».
After confirmation, we will start processing your order.
### Recommendations
* Always ensure you send the payment to the correct address with the right currency and network.
* Keep the transaction ID and any other information about your payment for future reference.
* You can contact our specialists or payment service support if you have any questions during or after the payment process.
# Support and FAQ
You can find more information about CryptoCloud service in the knowledge base. There, you will find answers to many popular questions:
* [How can I add a project?](https://support.trybit.com/getting-started/add-project)
* [How to set up an added project?](https://support.trybit.com/getting-started/project-settings)
* [How to create an invoice?](https://support.trybit.com/payments/invoice-creation-methods)
* [What are your service fees?](https://support.trybit.com/general-information/fees)
* [What currencies does your service support?](https://support.trybit.com/general-information/currencies-networks)
* [What business types do you connect?](https://support.trybit.com/general-information/connection-requirements)
* [How does the payment process work for the customer?](https://support.trybit.com/general-information/payment-page)
* [How and how quickly do I withdraw funds?](https://support.trybit.com/withdrawals/withdrawal-request)
Contacts of our tech support specialists [are here](https://trybit.com/support).
Company website — .
# Request Authorization
### Authorization header
To authorize each API request, pass your API KEY in the `Authorization` header as follows:
```
Authorization: Token
```
### Example of a request with a token
An example of using the `Authorization` header in an API request:
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.trybit.com/v2/invoice/create \
-header "Authorization: Token eyJ0eXAi1iJKV1QiLCJhbGci1iJIAcI1NiJ9.eyJpZCI6MTMsImV4cCI6MTYzMTc4NjQyNn0.HQavV3z8dFnk56bX3MSY5X9lR6qVa9YhAoeTEH"
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
url = "https://api.trybit.com/v2/invoice/create"
headers = {
"Authorization": "Token eyJ0eXAi1iJKV1QiLCJhbGciOiJIAcI1NiJ9.eyJpZCI6MTMsImV4cCI6MTYzMTc4NjQyNn0.HQavV3z8dFnk56bX3MSY5X9lR6qVa9YhAoeTEH"
}
response = requests.post(url, headers=headers)
if response.status_code == 200:
print("Success:", response.json())
else:
print("Fail:", response.status_code, response.text)
```
{% endtab %}
{% tab title="JavaScript" %}
```javascript
const url = 'https://api.trybit.com/v2/invoice/create';
const headers = new Headers({
'Authorization': 'Token eyJ0eXAi1iJKV1QiLCJhbGciOiJIAcI1NiJ9.eyJpZCI6MTMsImV4cCI6MTYzMTc4NjQyNn0.HQavV3z8dFnk56bX3MSY5X9lR6qVa9YhAoeTEH'
});
fetch(url, { method: 'POST', headers })
.then(response => {
if (response.ok) {
return response.json();
} else {
return Promise.reject('Auth error');
}
})
.then(data => {
console.log('Success:', data);
})
.catch(error => {
console.error('Fail:', error);
});
```
{% endtab %}
{% tab title="PHP" %}
```php
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
You don't need to send a separate authorization request. API KEY should be transferred in the Authorization header.
{% endhint %}
### Possible errors
| Response code | Error key | Error description |
| ------------------ | ------------ | ----------------- |
| 400 | Bad request | Invalid request |
| Некорректный токен | Unauthorized | Invalid token |
### Example of a response with an error
```json
{
"status": "error",
"result": {
"authorization": "Unauthorized request."
}
}
```
# Invoice Creation
The method allows you to create an invoice for a customer using a POST request.
In order to create an invoice, you need to send a POST request.
### What the method allows you to do
* Creates a unique invoice
* Returns a payment link or payment details
* Allows you to pass additional data
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/create`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| ------------------------------------------ | ------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| shop\_id\* | string | NGpD44<...>KXRdQ | Unique identifier of the store from personal account |
| amount\* | float | 100 | Payment amount in USD |
| currency | string | USD |
Object of the selected cryptocurrency in the invoice.
Also contains the network object — information about the selected currency network.
project
dict
"project": {
"id": 0,
"name": "MyShop",
"fail": "https://test.com/failed-payment",
"success": "https://test.com/successful-payment",
"logo": "https://static.trybit.com/logo/logo.jpg"
}v
Object containing project information
test_mode
bool
false
Test invoice sign
# Invoice Cancellation
The method allows you to cancel a specific created invoice by sending a POST request.
### What the method allows you to do
* Cancels an invoice with the `created` status
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/merchant/canceled`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| -------------------------------------- | ------ | ------------ | ------------------------- |
| uuid\* | string | INV-89UX09KA | Unique invoice identifier |
### Request examples
These examples show how to send a request to cancel an invoice. Note that the invoice must have the `created` status.
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.trybit.com/v2/invoice/merchant/canceled \
-H "Authorization: Token " \
-H "Content-Type: application/json" \
-d '{"uuid":"INV-XXXXXXXX"}'
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
url = "https://api.trybit.com/v2/invoice/merchant/canceled"
headers = {
"Authorization": "Token "
}
data = {
"uuid": "INV-XXXXXXXX"
response = requests.post(url, headers=headers, json=data)
if response.status_code == 200:
print("Success:", response.json())
else:
print("Fail:", response.status_code, response.text)
```
{% endtab %}
{% tab title="JavaScript" %}
```javascript
fetch('https://api.trybit.com/v2/invoice/merchant/canceled', {
method: 'POST',
headers: {
'Authorization': 'Token ',
'Content-Type': 'application/json'
},
body: JSON.stringify({ uuid: 'INV-XXXXXXXX' })
})
.then(response => {
if (response.ok) {
return response.json();
} else {
throw new Error('Fail: ' + response.status + ' ' + response.statusText);
}
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));
```
{% endtab %}
{% tab title="PHP" %}
```php
"INV-XXXXXXXX")));
$headers = array(
"Authorization: Token ",
"Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($statusCode == 200) {
echo "Success: " . $response;
} else {
echo "Fail: " . $statusCode . " " . $response;
}
}
curl_close($ch);
?>
```
{% endtab %}
{% endtabs %}
### Response examples
A successful request returns a response with the status `success` and a `result` object.
{% tabs %}
{% tab title="200: OK – Invoice has been cancelled" %}
```json
{
"status": "success",
"result": [
"ok"
]
}
```
{% endtab %}
{% endtabs %}
### Response parameters
A successful request returns a response with the status `success` and a `result` object.
| Name | Type | Example | Description |
| ------ | ------ | ------- | ------------------------------------------------------ |
| status | string | success | Response status |
| result | string | ok | An object describing a successful response or an error |
# Invoice List
The method allows you to retrieve a list of all invoices by sending a POST request.
To get a list of all invoices, send a POST request to the following URL:
### What the method allows you to do
* Returns a list of all invoices
* Maximum number of records per request — 100
* By default, the response contains 10 records
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/merchant/list`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| --------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start\* | string | 01.01.2026 | Date in format «dd.mm.yyyyy» |
| end\* | string | 31.01.2026 | Date in format «dd.mm.yyyyy». Must be later or equal to start. |
| offset | int | 0 |
This is the index of the starting record from which data retrieval begins.
For example, if offset=10, the data will start from the 11th record.
|
| limit | int | 10 |
This is the number of the last record you want to retrieve.
For example, if limit=20, you will receive records up to and including the 20th, starting from the one specified in offset.
Object of the selected cryptocurrency in the invoice.
Also contains the network object — information about the selected currency network.
project
dict
"project": {
"id": 0,
"name": "MyShop",
"fail": "https://test.com/failed-payment",
"success": "https://test.com/successful-payment",
"logo": "https://static.trybit.com/logo/logo.jpg"
}
Object containing project information
test_mode
bool
false
Test invoice sign
received
float
0.00206
Amount credited to the balance in cryptocurrency
received_usd
float
0.26
Amount credited to the balance in USD
to_surcharge
float
0.001172
Amount remaining to be paid in cryptocurrency
to_surcharge_usd
float
0.08
Amount remaining to be paid in USD
# Invoice Information
The method allows you to retrieve specific invoices by their identifiers using a POST request.
### What the method allows you to do
* Returns complete information for the specified invoices.
* Maximum number of identifiers per request — 100.
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/merchant/info`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| --------------------------------------- | ----- | ------------ | ------------------------------------------------------ |
| uuids\* | array | INV-89UX09KA | List of invoice identifiers (INV-XXXXXXXX or XXXXXXXX) |
### Request examples
These examples show how to send a request to retrieve invoice information by INV number. Note that a single request must contain no more than 100 identifiers.
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.trybit.com/v2/invoice/merchant/info \
-H "Authorization: Token " \
-H "Content-Type: application/json" \
-d '{"uuids":["INV-XXXXXXXX","INV-YYYYYYYY"]}'
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
url = "https://api.trybit.com/v2/invoice/merchant/info"
headers = {
"Authorization": "Token "
}
data = {
"uuids": ["INV-XXXXXXXX", "INV-YYYYYYYY"]
}
response = requests.post(url, headers=headers, json=data)
if response.status_code == 200:
print("Success:", response.json())
else:
print("Fail:", response.status_code, response.text)
```
{% endtab %}
{% tab title="JavaScript" %}
```javascript
fetch('https://api.trybit.com/v2/invoice/merchant/info', {
method: 'POST',
headers: {
'Authorization': 'Token ',
'Content-Type': 'application/json'
},
body: JSON.stringify({
uuids: ['INV-XXXXXXXX', 'INV-YYYYYYYY']
})
})
.then(response => {
if (response.ok) {
return response.json();
} else {
throw new Error('Fail: ' + response.status + ' ' + response.statusText);
}
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));
```
{% endtab %}
{% tab title="PHP" %}
```php
array("INV-XXXXXXXX", "INV-YYYYYYYY")
)));
$headers = array(
"Authorization: Token ",
"Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($statusCode == 200) {
echo "Success: " . $response;
} else {
echo "Fail: " . $statusCode . " " . $response;
}
}
curl_close($ch);
?>
```
{% endtab %}
{% endtabs %}
### Response examples
A successful request returns a response with the status `success` and a `result` object.
{% tabs %}
{% tab title="200: OK – Invoice info" %}
```json
{
"status": "success",
"result": [
{
"uuid": "INV-DO8ETFVT",
"created": "2026-01-01 09:03:58.958133",
"address": "LiWRq0uckKZ8qj5dhvgBdWzEtAxr8KbpBW",
"currency": {
"id": 2,
"code": "LTC",
"fullcode": "LTC",
"network": {
"code": "litecoin",
"id": 2,
"icon": "https://cdn.trybit.com/img/network/LTC.svg",
"fullname": "Litecoin"
},
"name": "Litecoin",
"is_email_required": false,
"stablecoin": false,
"icon_base": "https://cdn.trybit.com/img/currency/LTC.svg",
"icon_network": "https://cdn.trybit.com/img/currency/LTC.svg",
"icon_qr": "https://cdn.trybit.com/img/stroke/LTC_STROKE.svg",
"order": 8
},
"date_finished": "2026-01-01 19:03:58.958133",
"expiry_date": "2026-01-02 09:03:57.493361",
"side_commission": "client",
"side_commission_cc": "merchant",
"type_payments": "crypto",
"status": "overpaid",
"invoice_status": "success",
"is_email_required": false,
"project": {
"id": 1,
"name": "Test",
"fail": "https://test.com/failed-payment",
"success": "https://test.com/successful-payment",
"logo": ""
},
"tx_list": [
""
],
"test_mode": false,
"type": "up",
"user_email": "",
"pay_url": "None",
"phone": "",
"order_id": "None",
"amount_in_crypto": null,
"amount_in_fiat": 0.1,
"amount": 0.01,
"amount_usd": 0.1,
"amount_to_pay": 0.01,
"amount_to_pay_usd": 0.69,
"amount_paid": 0.01,
"amount_paid_usd": 0.69,
"fee": 0.0,
"fee_usd": 0.0,
"service_fee": 0.00019,
"service_fee_usd": 0.01,
"received": 0.00981,
"received_usd": 0.68,
"to_surcharge": 0.0,
"to_surcharge_usd": 0.0
}
]
}
```
{% endtab %}
{% endtabs %}
### Response parameters
The `result` object contains:
| Name | Type | Example | Description |
| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uuid | string | INV-89UX09KA | Unique invoice identifier with the INV prefix |
| created | string | 2026-01-01 12:00:00.000000 | Invoice creation time in UTC+0 format: YYYY-MM-DD HH:MI:SS.FFFFFF |
| address | string | LiWRq0uck<...>Axr8KbpBW | Payment address |
| expiry\_date | string | 2026-01-02 12:00:00.000000 |
Invoice expiration date in UTC+0 format: YYYY-MM-DD HH:MI:SS.FFFFFF.
After the expiration time, the invoice status will change to canceled if payment has not been received.
|
| side\_commission | string | client | Transfer fee payer |
| side\_commission\_cc | string | client | Service fee payer |
| amount | float | 0.033366 | Invoice amount in the selected cryptocurrency |
| amount\_usd | float | 100.0 | Invoice amount in USD |
| amount\_in\_fiat | float | 100.0 | Invoice amount in the creation currency (depends on the `currency` parameter) |
| fee | float | 4.500000159168849e-06 | Transfer fee |
| fee\_usd | float | 0.01 | Transfer fee in USD |
| service\_fee | float | 0.000634 | Service fee |
| service\_fee\_usd | float | 1.9 | Service fee in USD |
| fiat\_currency | string | USD | Fiat currency code in which the invoice was created |
| status | string | created |
Invoice status
When a create-invoice request is sent, the status is always created.
Other possible statuses: paid (paid), partial (partially paid), overpaid (overpaid), and canceled (canceled).
|
| is\_email\_required | bool | false | Parameter for requiring the payer’s email in the invoice |
| link | string | pay.trybit.com/89UX09KA | Link to the invoice page |
| currency | dict |
"currency": {
"id": 3,
"code": "ETH",
"fullcode": "ETH",
"network": {
"code": "ERC20",
"id": 3,
"icon": "",
"fullname": "Ethereum"
},
"name": "Ethereum",
"is\_email\_required": false,
"stablecoin": false,
"icon\_base": "",
"icon\_network": "",
"icon\_qr": "",
"order": 9
}
|
Object of the selected cryptocurrency in the invoice.
Also contains the network object — information about the selected currency network.
|
| project | dict |
"project": {
"id": 0,
"name": "MyShop",
"fail": "",
"success": "",
"logo": ""
}
| Object containing project information |
| test\_mode | bool | false | Test invoice sign |
| received | float | 0.00206 | Amount credited to the balance in cryptocurrency |
| received\_usd | float | 0.26 | Amount credited to the balance in USD |
| to\_surcharge | float | 0.001172 | Amount remaining to be paid in cryptocurrency |
| to\_surcharge\_usd | float | 0.08 | Amount remaining to be paid in USD |
# Balance
The method allows you to retrieve your account balance by sending a POST request.
### What the method allows you to do
* Returns an array of your account balances.
### Endpoint
`POST` `https://api.trybit.com/v2/merchant/wallet/balance/all`
### Headers
Name
Type
Example
Description
Authorization*
string
Token eyJ0eXAiOiJK<...>4npi1ksS8tSY
Project API key
### Request Body
No request body is required.
### Request examples
These examples show how to send a request to retrieve the account balance. Note that the Request Body does not need to be filled in.
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.trybit.com/v2/merchant/wallet/balance/all \
-H "Authorization: Token "
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
url = "https://api.trybit.com/v2/merchant/wallet/balance/all"
headers = {
"Authorization": "Token "
}
response = requests.post(url, headers=headers)
if response.status_code == 200:
print("Success:", response.json())
else:
print("Fail:", response.status_code, response.text)
```
{% endtab %}
{% tab title="JavaScript" %}
```javascript
fetch('https://api.trybit.com/v2/merchant/wallet/balance/all', {
method: 'POST',
headers: {
'Authorization': 'Token '
}
})
.then(response => {
if (response.ok) {
return response.json();
} else {
throw new Error('Fail: ' + response.status + ' ' + response.statusText);
}
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));
```
{% endtab %}
{% tab title="PHP" %}
```php
",
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($statusCode == 200) {
echo "Success: " . $response;
} else {
echo "Fail: " . $statusCode . " " . $response;
}
}
curl_close($ch);
?>
```
{% endtab %}
{% endtabs %}
### Response examples
A successful request returns a response with the status `success` and a `result` object.
{% tabs %}
{% tab title="200: OK – Balance" %}
```json
{
"status": "success",
"result": [
{
"currency": {
"id": 4,
"code": "USDT_TRC20",
"short_code": "USDT",
"name": "Tether",
"is_email_required": false,
"stablecoin": true,
"icon_base": "https://cdn.trybit.com/img/currency/USDT.svg",
"icon_network": "https://cdn.trybit.com/img/currency_network/USDT_TRC.svg",
"icon_qr": "https://cdn.trybit.com/img/stroke/USDT_STROKE.svg",
"order": 1,
"obj_network": {
"code": "TRC20",
"id": 4,
"icon": "https://cdn.trybit.com/img/network/TRC20.svg",
"fullname": "Tron"
},
"enable": true
},
"balance_crypto": 10.0,
"balance_usd": 10.0,
"available_balance": 10.0,
"available_balance_usd": 10.0
},
…
]
}
```
{% endtab %}
{% endtabs %}
### Response parameters
The `result` object contains:
Balance in USD at the exchange rate at the time of the request
available_balance
float
10.0
Withdrawable balance in cryptocurrency
available_balance_usd
float
10.0
Withdrawable balance in USD
# Statistics
The method allows you to retrieve payment statistics by sending a POST request.
### What the method allows you to do
* Returns statistics on invoice statuses for the specified period.
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/merchant/statistics`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| --------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------ |
| start\* | string | 01.01.2026 | Date in format `«dd.mm.yyyyy»` |
| end\* | string | 31.01.2026 |
| Object containing values for the number of invoices |
| amount | dict |
"amount": {
"all": 214356.22712,
"created": 4.0,
"paid": 629.729137,
"overpaid": 36.82,
"partial": 11.4,
"canceled": 213674.277983
}
| Object containing values for amounts in USD |
| all | int, float | 907 / 214356.22712 | All invoices |
| created | int, float | 4 / 4.0 | Invoices with the “Created” status |
| paid | int, float | 90 / 629.729137 | Invoices with the “Paid” status |
| overpaid | int, float | 8 / 36.82 | Invoices with the “Overpaid” status |
| partial | int, float | 6 / 11.4 | Invoices with the “Partially paid” status |
| canceled | int, float | 799 / 213674.277983 | Invoices with the “Canceled” status |
# Funds Withdrawal
The method allows you to create a withdrawal request by sending a POST request.
### Authentication
A separate API key must be used for authentication. It can be generated in the «Security» section in your account settings. The key is displayed only once, so make sure to store it in a secure place and do not disclose it.
### What the method allows you to do
* Creates a withdrawal request in the specified currency.
* Minimum interval between requests — 12 seconds.
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/api/out/create`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | ------------------------------------------------------------ |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | API key from the «Security» section in your account settings |
### Request Body
Key parameters
| Name | Type | Example | Description |
| ------------------------------------------------ | ------ | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| currency\_code\* | string | ETH |