Learn how to integrate Kyrrex pay products. Here you can explore our guides and examples.
\nOur API uses token-based authentication to ensure secure access. Each request must include a valid token in the header.
\nRequests to our API should be made using standard HTTP methods, such as GET, POST, and DELETE. Each endpoint details the required method, parameters, and possible responses.
\nOur API responses are formatted in JSON, providing a clear and consistent structure for handling data. Each endpoint's documentation includes examples of successful responses and potential error messages.
\nIn case of errors, the API will return appropriate HTTP status codes along with a message describing the error. Common error codes include:
\n400 Bad Request: The request was invalid or cannot be served.
\n401 Unauthorized: Authentication failed or user does not have permissions for the desired action.
\n404 Not Found: The requested resource could not be found.
\n500 Internal Server Error: An error occurred on the server.
\nIf you have any problems or questions, feel free to write to kpay@kyrrex.com. We will answer all your questions as quickly as possible.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42711896","collectionId":"35bca5ca-f5f0-47bd-ac9f-e78d0a5a0946","publishedId":"2sAYdkJUnX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-01T09:09:06.000Z"},"item":[{"name":"High Level User Flow","item":[],"id":"e5b7b97b-07d6-4e7a-b433-d9bd22cbc19c","description":"Merchant registers in KyrrexPay-system
\nMerchant reaches \"Advanced\" verification status by KyrrexPay security checks passing
\nMerchant configurates business-account (receiving assets, auto-сonvertion settings, underpayment limits, default asset, auto-witdhrawals (API only) and default fee-payee)
\nMerchant creates an invoice
\nMerchant gives invoice-link to client
\nClient fills invoice with client's email and selects asset to be used for payment (if it's not pre-defined by a merchant)
\nClient sees the payment amount, fees and deposit address
\nClient pays the invoice from a 3-rd party side (Binance, Bybit, blockchain-transaction, etc.)
\nMerchant receives payment with correct amount or lower than expected but in range of underpayment limit
- (invoice is \"Done\")
9.1.1 Merchant receives payment with amount lower than expected
- (invoice is \"Wrong\")
9.1.2 Merchant accepts payment for a \"Wrong\"-status invoice
- (invoice is \"Done\")
9.1.3 Merchant declines payment for a \"Wrong\"-status invoice
- (webhook \"Refunded\")
9.2.1 Merchant receives payment with amount higher than expected
- (invoice is \"Done\" with \"Overpayment\" mark)
(optionally) Merchant swaps received amount to any supported asset
\nMerchant withdwars assets to desirable 3-rd party side (Binance, Bybit, blockchain-transaction, etc.)
\n(optionally) Merchant reaches \"Enhanced\" verification status by SumSub KYB checks passing
\n(optionally) Merchant adds his fiat-requisites into the system
\n(optionally) Merchant withdraws assets to his added fiat-requisites with crypto-fiat swapping on the backend-side
\nOn the dashboard page user can see the primary operable information about his company and personal account operations functionality.
There will be the following:
Revenue amounts and Transactions quantity charts
\nTotal company balance
\nInvoice creation button
\n\"Exchange\"-button for assets swapping
\n\"Withdraw\"-button for assets withdrawing
\nAccount settings link
\nAPI Keys link
\nLIst of company assets with available balances
\nUser can select what chat should be displayed by using \"Revenue\"/\"Transactions\" selector.
\n\"Revenue\" chart will display total company revenue for selected period, asset and invoice-type and will display it's via graphical view in more detail.
\n\"Transactions\" chart will display total company invoices quantity for selected period and invoice-type and will display it via graphical view in more detail.
\nUser also can proceed to swapping functionality page and assets withdrawal funcitonality page by clicking on the corresponding buttons.
User can proceed to invoice creation options by clicking on the invoice cretaion button and see ivnoice-types dropdown expanded.
User can proceed to account settings and retrieve API Keys in a fast way by clicking on the corresponding buttons.
User can see the list of company assets, their balances and their USDT-equivalent as well.
User also can execute the desirable asset swaping or withdrawal by clicking on it's corresponding buttons.
Users with admin and accountant rights have full-access to 'Invoices' page functionality and can see, filter and export invoice history into CSV-reports. They also can create new invoices.
\nUsers with manager and support rights have access to see all invoices history, create new invoices and filter them. They also cannot export invoices into CSV-report
\nUser also can see the invoices list and the their following information on the page:
\ninvoices quantity
\npayment ID (internal ID for invoice tracking)
\nClient Email (invoice's payee email)
\nInvoice amount (amount that is expected for invoice ot be received)
\nReceived amount (amount that was actually received for invoice from a client)
\nDate and time (invoice creation date and time)
\nStatus
\nStatus can be the following:
\n-'Created' - for invoices that were created, but client's email is not provided (optionally: and payment method is not selected)
\n-'Pending' - for created invoices with alreadyentered client's email and assigned payment method
\n-‘Processing’ - for invoices that has started deposit receiving and blockchain transaction completion is waiting
\n-'Done' - for fully paid invoices, for invoices with payment lower than expected but in range of underpayment-limit, for invoices with overpayment, for previously \"Wrong\"-invoices that were accepted
\n-'Wrong' - for invoices paid with amount lower than expected and/or lower than underpayment-limit
\n-'Refunded' - for previously \"Wrong\"-invoices that were declined
\n-'Closed' - for expired invoices
\nUser can also open invoice's additional info page and see the following elements there:
\nInvoice expected amount/received amount comparison display
\nClient's email-address
\nInvoice status
\nInvoice ID
\nInvoice content (list of items with their prices)
\nInvoice amount (expected)
\nReceived amount (net)
\nInvoice transactions list with their details:
\nType (Deposit, Fees, Autoswap)
\nAmount (transaction's volume)
\nTransaction's date and time
\nTransaction's status
\nInvoice transactions table
\nInvoice details:
\nInvoice creation date and time
\nInvoice completion date and time
\nInvoice Type
\nButton for client-oriented invoice-link copying
\nUser can copy the invoice's URL and use it to resend to the end-user client.
\nUser is able to see the invoice's transaciton details by expanding it's details-section. The following information will be provided:
\nFor \"Deposit\" type:
\nInvoice currency amount (to bring the understanding of invoice currency transaction volume regarding the payment currency)
\nRate (to understand the calculation rate for the \"Invoice currency amount\")
\nService transaction ID (if smth will go wrong with your deposit - we'll have ability to help you)
\nHash (to track deposit on blockchain-side)
\nReceiver (your invoice address)
\nFor \"Fees\" type:
\nInvoice currency amount (to bring the understanding of invoice currency transaction volume regarding the payment currency)
\nRate (to understand the calculation rate for the \"Invoice currency amount\")
\nFor \"Autoswap\" type:
\nRate (to understand the swapping rate)
\nService transaction ID (if smth will go wrong with your swap - we'll have ability to help you)
\nInvoices filtering and CSV-export
\nUser can also see the filtering and export buttons above the invoices list.
\nUser can filter invoices list by clicking on the filters-button.
Filtering is available by the following points:
Searching by Invoice ID or client's email
\nDate-range (\"from\" datepicker - \"to\" datepicker)
\nCurrency
\nStatus
\nUser can export invoices history by clicking on the export-button and will be redirected to export's modal window to select the date-frames for which transactions should be exported. Date-frames can be entered manually or via datepicker.
Datepicker has both calendar-view date-picker and pre-defined timeframe presets.
Data will be exported into the CSV-formatted file and will contain the following info:
\nInvoice ID
\nClient email
\nInvoice Currency
\nPayment Currency
\nInvoice Amount
\nPayment Amount
\nStatus
\nType
\nDate
\nLink
\nItems & prices.
\nOutcoming transactions
\nUser with full-access rights can see the info abount outcoming transactions by proceeding on the Transactions page. The following information can be seen:
\ntransactions quantity
\ntransaction ID
\nType (Withdrawal, swap, autoswap)
\nCurrency (for swaps it's from-currency)
\nAmount (for swaps it's from-amount)
\nDate and time
\nStatus
\nStatus can be the following:
- 'Processing' for transaction that is in progress
- 'Done' for finished transactions
- 'Expired' for transaction that is stucked on blockchain-side
User can also expand additional info section and see the following elements there:
\nFor withdrawals:
\nlink to hash on the blockscan-side
\nSender wallet address
\nReceiver wallet address
\nFor swaps:
\nSwap to currency
\nSwap amount (amount received after the swap-operation)
\nAverage swap rate
\nUser can also see the \"Repeat transaction\" button for each transaction details section. With it's click user can proceed to withdrawal or swap page regarding to transaction type and see asset(s) and amount are predefined with previous transaction data.
\n","_postman_id":"079bd5e3-d24f-442c-885e-d5aaac0eff91"},{"name":"\"Settings\" page","item":[{"name":"\"Profile\" tab","item":[],"id":"c70a1b1f-76fe-45ca-9b49-473cee6a9bed","description":"- current admin's account info
- beneficial owner info
- company's Contact person info
- Business company's info
- Business address company's info
User can edit info on the 'Profile' tab (TBD) by clicking on the corresponding sub-section pencil-button. After that user will see the form with seb-section fields. After edits entering and form submitting updated info will be applied for company.
User also can copy his own account ID by clicking on the corresponding button in the 'Account' sub-section
User can set what assets should be available for clients to set as payment asset for their invoice.
To do that user just need to activate/deactivate checkboxes on the 'Accept Tokens' sub-section on the 'Project' tab.
Income payments auto-convertation into USDT can also be enabled by activating/deactivating toggle-buttons.
User can copy public and private tokens to use them for system integration with client's services. (e.g. invoice creation procedure.
Tokens can be seen/hide as needed by clicking on the corresponding eye-buttons near them.
User can also set webhook URL by entering it into the 'Webhook URL' field and confirming it's adding via 'Save' button.
\nUser can see all company's employees on the 'Permisions' tab.
All users corresponding roles are displayed in the 'Role' column:
- Manager
- Accountant
All users statuses are displayed in the 'Status' column:
- 'Active' for invited user who acivated his account
- 'Inactive' for invited user who hasn't acivated his account
- (other statuses TBD...)
User can copy any company user's ID by clicking on the corresponding button near desired ID.
User also can create new user for his company.
Users with Admin rights can access the API-settings page by clicking on the \"Tokens\" tab ot the Settings page.
They also can access this page by clicking on the 'API Key' button on the Dashboard page.
Users with Admin rights can access the payment-settings page by clicking on the corresponding tab ot the Settings page.
They also can access this page by clicking on the 'Account Settings' button on the Dashboard page.
- tokens accepted by company via invoices
- tokens convertation into USDT for invoice incoming payments
- public and private tokens
- invoice-logs receiving webhook settings
Users with Admin rights can access the company Settings page by clicking on the corresponding button at the page header.
\nPage allows to see and manage settings for company Profile, company users Permissions and tools for company interaction with other services. These settings can be found in corresponding tabs on the Settings page:
\n'Profile' tab - company appearance, contacts and legal status settings.
\n'Tokens' tab - tools for company interaction with other services by API.
\n'Payment' tab - company incoming financial operations settings
\n'Security' tab - tools for current user's account protection
\n'Employees' tab - functionality for company employees adding and management
\n'Notifications' tab - operational email-notifications settings
\nAfter merchant side user selected \"Regular invoice\" as invoice type to be created, the corresponding page is opened.
Here user can see the following elements:
Invoice currency selection dropdown field - to selet in what currency your invoice items are offered
\ninvoice content form:
\nDescription - for item name or service description
\nPrice - separate for each item. You can set positive numbers with different precisions depending on selected Invoice currency (eur 2, usd 2, btc 6, eth 6, usdt 2, usdc 2, ton 4, sol 4, ltc 8, bnb 8, bch 8, trx 6).
You also can set item's price as 0 (e.g. for promo or gifted items) or negative price (e.g. to display discount), but the final sum of all item prices should be >0.00 and equal to minimal deposit amount of the cheapest possible Payment Currency (no need to worry about this right now - we’ve built in validation messages that will guide you along the way)
Items adding button - add as much as you need
\nItems deletion button near already added ones - but leave at least 1 item in the list
\nPayment currency dropdown field - to select in what currency you want to receive invoince payment.
You can predefine any asset that is enabled for accepting by your company on the \"Settings/Payment\" page.
You can also select the ‘All available’ option to leave the decision to the client, however, he won’t be able to select assets whose minimum deposit amounts exceed the total sum of all invoice item prices (at least one will be available - otherwise merchant will be unable to create invoice at all)
Who Pays Transaction Fees - for buyer selected: buyer will have to pay invoice amount + fees, merchant will receive 100% of invoice amount as a NET.
For merchant selected: buyer will have to pay invoice amount only, merchant will receive 100% of invoice amount as a GROSS and fees will be paid from this amount.
Receive display - pre-calculation to understand what NET-amount will be received by merchant according to selected invoice currency and fees payee
\nRedirect URL - for the link you want a client to be redirected after the successfully invoice payment and it's transition to \"Done\" status. To use entered link you need to turn the switcher into \"Enable for this invoice\" on invoice creation page.
You can also use a default link set on the \"Settings/Payment\" page by turning the switcher into \"Disable for this invoice\" on invoice creation page.
If no redirection link is provided on the \"Settings/Payment\" page and switcher value is \"Disable for this invoice\" on invoice creation page - no redirection will be performed for \"Done\"-invoices.
After merchant-side user selected \"Any Amount invoice\" as invoice type to be created, the corresponding page is opened.
Here user can see the following elements:
Payment currency dropdown field - to select in what currency you want to receive invoince payment.
You can predefine any asset that is enabled for accepting by your company on the \"Settings/Payment\" page.
You can also select the ‘All available’ option to leave the decision to the client, however, he won’t be able to select assets whose minimum deposit amounts exceed the total sum of all invoice item prices (at least one will be available - otherwise merchant will be unable to create invoice at all)
invoice content form:
\nWho Pays Transaction Fees - for buyer selected: buyer will have to pay invoice amount + fees, merchant will receive 100% of invoice amount as a NET.
For merchant selected: buyer will have to pay invoice amount only, merchant will receive 100% of invoice amount as a GROSS and fees will be paid from this amount.
Redirect URL - for the link you want a client to be redirected after the successfully invoice payment and it's transition to \"Done\" status. To use entered link you need to turn the switcher into \"Enable for this invoice\" on invoice creation page.
You can also use a default link set on the \"Settings/Payment\" page by turning the switcher into \"Disable for this invoice\" on invoice creation page.
If no redirection link is provided on the \"Settings/Payment\" page and switcher value is \"Disable for this invoice\" on invoice creation page - no redirection will be performed for \"Done\"-invoices.
After merchant side user selected \"Business invoice\" as invoice type to be created, the corresponding page is opened.
Here user can see the following elements:
invoice content form:
\nSeller info section with it's info adding button:
\nCompany name
\nAddress
\nPhone number
\nWebsite
\nTax ID
\nBuyer info section with it's info adding button:
\nFull Name
\nCompany Name
\nAddress
\nPhone Number
\nTax ID
\nDetails section
\nDescription - for item name or service description
\nPrice - separate for each item. You can set positive numbers with different precisions depending on selected Invoice currency (eur 2, usd 2, btc 6, eth 6, usdt 2, usdc 2, ton 4, sol 4, ltc 8, bnb 8, bch 8, trx 6).
You also can set item's price as 0 (e.g. for promo or gifted items) or negative price (e.g. to display discount), but the final sum of all item prices should be >0.00 and equal to minimal deposit amount of the cheapest possible Payment Currency (no need to worry about this right now - we’ve built in validation messages that will guide you along the way)
Items adding button - add as much as you need
\nItems deletion button near already added ones - but leave at least 1 item in the list
\nSubtotal - sum of all items prices
\ntaxes adding button - to add any tax-items into the invoice items list. Add as much as you need
\nDescription - for tax purpose description
\ntax volume- separate for each tax
\nNotes to Buyer - optional field that allows you to provide any information for a client. It's value will be displayed for a client on invoice payment page and on invoice's billing summary PDF-document.
\nInternal Notes - optional field to mark invoice with any merchant-side required data. It's value will be displayed on internal invoice details page for a merchant only.
\nInvoice Number - legal invoice number provided by a merchant for invoice's billing summary document. Can contain any symbol(s) but should be unique within merchant account invoices.
\nIssue Date - legal info for invoice's billing summary document.
\nDue Date - another legal info for invoice's billing summary document.
\nInvoice currency selection dropdown field - to selet in what currency your invoice items are offered.
\nPayment currency dropdown field - to select in what currency you want to receive invoince payment.
You can predefine any asset that is enabled for accepting by your company on the \"Settings/Payment\" page.
You can also select the ‘All available’ option to leave the decision to the client, however, he won’t be able to select assets whose minimum deposit amounts exceed the total sum of all invoice item prices (at least one will be available - otherwise merchant will be unable to create invoice at all)
Who Pays Transaction Fees - for buyer selected: buyer will have to pay invoice amount + fees, merchant will receive 100% of invoice amount as a NET.
For merchant selected: buyer will have to pay invoice amount only, merchant will receive 100% of invoice amount as a GROSS and fees will be paid from this amount.
Receive display - pre-calculation to understand what NET-amount will be received by merchant according to selected invoice currency and fees payee
\nRedirect URL - for the link you want a client to be redirected after the successfully invoice payment and it's transition to \"Done\" status. To use entered link you need to turn the switcher into \"Enable for this invoice\" on invoice creation page.
You can also use a default link set on the \"Settings/Payment\" page by turning the switcher into \"Disable for this invoice\" on invoice creation page.
If no redirection link is provided on the \"Settings/Payment\" page and switcher value is \"Disable for this invoice\" on invoice creation page - no redirection will be performed for \"Done\"-invoices.
Business invoice has also the following unique features:
\nInvoice's billing summary document PDF export - merchant can export billing summary document PDF with all the information that is provided at the moment of the export.
\nPreview - merchant can review current version of billing summary document with all the information that is provided at the moment of the export.
\nSave Draft - merchant can fill business-invoice form with any data that is common for his routine operations and re-use it later as a template. Draft saving is available if at least one business-invoice creation form field is customized.
\nInvoice has been created (POST-request executed, invoice status: \"Created\")
\nInvoice url-address is transfered to a client
\nClient opens invoice (GET-request, invoice status: \"Created\")
\nClient fills invoice with his email and optionally payment currency (PATCH-request, invoice status: \"Pending\")
Payment address is assigning to invoice (invoice status: \"Pending\")
Client sends payment for invoice
\nPayment receiving is initiated by a blockchain (invoice status: \"Processing\")
\nPayment is received (invoice status: \"Done\", \"Wrong\", \"Refunded\" according to received amount)
8a. Payment is not received in time (invoice status: \"Expired\")
In more details:
\nWhen invoice has been created merchant can see it's details page opened. The newly created invoice also can be found in invoices list on the \"Invoices\" page.
\nThe next step is to copy invoice's link by the corresponding button on the invoice details page and send this link to a client.
\nClient opens invoice by provided link, provides his email to identify him as an invoice payee and selects payment currency if it wasn't pre-defined by a merchant during the invoice creation.
\nWhen it's done, invoice receives it's crypto-address regarding to selected payment currency, all invoiceCurrency-paymentCurrency rate based calculations are executed and client has all available info to start payment process.
\nMerchant's sided user is able to create invoice by clicking on corresponding button on \"Dashboard\" page. He also can create invoice by proceeding to 'Invoices' page and click the '+ Create Invoice' button.
\nAfter that user will see invoice types dropdown expanded where he can select one of the following invoice types:
\nRegular invoice - you know what service/item exactly will be offered and it has fixed price.
(e.g. you need to sell a table or receive monthly subscription payment)
Any Amount invoice - you offer something without fixed price and it's name can be provided or not on your choice.
(e.g. you want to allow client top-up his balance on your service or you need to receive donation)
Business Invoice - as a legal person you need to receive incoming transactions from a physical or legal-person.
(invoice reporting number, date/time, full sender and received info, requisites, taxes description, currency, etc)
When invoice-type is selected and items list is filled user has ability to confirm invoice creation and will be redirected to the newly created invoice's additional info page.
\nOn the newly created invoice's additional info page user is able to copy the invoice's client-oriented link by a \"Copy link\" button and send it to the client's end user.
\nClient's end user is able to open the invoice payment form by opening the invoice link.
Invoice payment form content depends on invoice-type.
For Regular invoice-type client user is able to see the merhcant's company name, invoice items-list, invoice's total price, payment token selection field (or pre-defined token if it was set by merchant during the invoice creation), client's email field.
He can also see the merhcant's company logo, payment info-block and support-link to have a connection with merhcant in case of any concerns.
Client user is able to select any desirable token to be set as an invoice payment currency (if it wasn't pre-defined by a merchant during the invoice creation) and enter his email for further invoice transactions updates to be received.
When the form is confirmed client user will be redirected to the second page of invoice payment form where client user is able to see the calculations of invoice currency convertation into payment currency, exchange-rate and fees-inclusion (if client was set as a fees-payee by a merchant during the invoice creation).
Client user is also can see the crypto-address (and tag-field for required assets) for invoice payment to be made. Crypto-address is available both in text and QR-core formats.
\nFor Any Amount invoice-type client user is able to see the invoice payment calculator to have ability to calculate payment currency amount to be paid to receive corresponding invoice currency's amount to it's account on merchant's service.
\nUser can select payment currency (if it's not predefined by a merchant during the invoice creation), enter desirable amount to be paid or leave it empty and enter his email for further invoice transactions updates to be received.
User also can see the pre-estimated invoice currency's amount to be received, exchange-rate and fees for selected payment currency and entered amount (if it's entered).
When form is confirmed client user will be redirected to the second page of invoice payment form where client user is able to see the invoice payment calculator to have ability to calculate payment currency amount to be paid to receive some desirable invoice currency's amount into it's account on merchant's service, but with previously defined and non-editable payment currency.
Business invoice-type client's UI has only minor differences from a Regular invoice. In particular, on the right-hand side, instead of the list of products, the user will see the billing summary document preview with all legal information that was provided by a merchant during the invoice creation. This document preview will be gradually updated with payment details as the client processes the invoice:
\nuser's selected payment currency OR previously predefined by a merchant during the invoice creation
\npayment currency's network
\ndeposit address
\ntag (only for assets that require it)
\ninvoice currency/payment currency exchange rate that was actual for the moment of invoice filling by a client
\ncrypto-amount as a payment currency amount to be paid for invoice
\nUser will also be able to see the \"Download PDF\" button above the billing summary document during the whole invoice client's-side flow to have ability to download the document for a legal purposes, accounting, etc.
\nWhen invoice transaction receiving process will be started by the KyrrexPay-service, invoice payment page will be changed with corresponding status pages.
It will also be changed to ‘You invoice has expired' page if invoice payment transaction won't be received within the invoice-payment period - 30 minutes for all asets (excluding BTC - 120 minutes)
Webhooks can have the following statuses:
\nprocessing - 2x webhooks for initiated withdrawal and transaction received by blockchain
\ndone - withdrawal completed on Paidlys side and blockchain side
\nrejected - withdrawal has been blocked by AML/TMS checks and/or failed on blockchain side
\nWebhook body for processing #1:
\n{\n \"type\": \"withdrawal\", // webhook's type\n \"status\": \"processing\", // webhook's status\n \"asset\": \"usdt\", // withdrawn asset\n \"dchain\": \"trc20usdt\", //withdrawn asset+network\n \"amount\": 5, // withdrawn amount\n \"fee\": \"3.0\", // withdawal fees\n \"to\": \"TNyG6gPkBsF8S8Sy6deirNCVVydVFTFK7c\", // receiver address\n \"txHash\": \"\", // blockchain-address, empty for procesing#1 webhook\n \"uid\": \"156-77704488\" // internal uuid from withdrawal api-call response\n}\n\nWebhook body for processing #2:
\n{\n \"type\": \"withdrawal\", // webhook's type\n \"status\": \"processing\", // webhook's status\n \"asset\": \"usdt\", // withdrawn asset\n \"dchain\": \"trc20usdt\", //withdrawn asset+network\n \"amount\": 5, // withdrawn amount\n \"fee\": \"3.0\", // withdawal fees\n \"to\": \"TNyG6gPkBsF8S8Sy6deirNCVVydVFTFK7c\", // receiver address\n \"txHash\": \"https://tronscan.org/#/transaction/\", // blockchain-address, available for procesing#2 webhook\n \"uid\": \"156-77704488\" // internal uuid from withdrawal api-call response\n}\n\nWebhook body for done:
\n{\n \"type\": \"withdrawal\", // webhook's type\n \"status\": \"done\", // webhook's status\n \"asset\": \"usdt\", // withdrawn asset\n \"dchain\": \"trc20usdt\", //withdrawn asset+network\n \"amount\": 5, // withdrawn amount\n \"fee\": \"3.0\", // withdawal fees\n \"to\": \"TNyG6gPkBsF8S8Sy6deirNCVVydVFTFK7c\", // receiver address\n \"txHash\": \"https://tronscan.org/#/transaction/1e4cc555a36ec5cc4bac0c54050b12d0b0c202baa3b952522b88cd32384104ae\", // blockchain-side transaction-ID\n \"uid\": \"156-77704488\" // internal uuid from withdrawal api-call response\n}\n\nWebhook body for rejected:
\n{\n \"type\": \"withdrawal\", // webhook's type\n \"status\": \"rejected\", // webhook's status\n \"asset\": \"usdt\", // withdrawn asset\n \"dchain\": \"trc20usdt\", //withdrawn asset+network\n \"amount\": 5, // withdrawn amount\n \"fee\": \"3.0\", // withdawal fees\n \"to\": \"TNyG6gPkBsF8S8Sy6deirNCVVydVFTFK7c\", // receiver address\n \"uid\": \"156-77704488\" // internal uuid from withdrawal api-call response\n}\n\nWebhooks authenticity check:
\nEvery webhook contains \"Signature\" header generated by the following function:
\nprivate generateWebhookSignature(secretKey: string, payload: any): string {\n const hmac = createHmac('sha512', secretKey.trim());\n hmac.update(JSON.stringify(payload));\n return hmac.digest('hex');\n }\n\nwhere secretKey: \"%merchant's secret key from Settings/Tokens page on UI-side%\"
\n","_postman_id":"37cb9df1-d2a5-453a-8e75-ee5c8e4117f8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","id":"266b567c-8006-47e8-8474-d0f111870972","name":"API","type":"folder"}}}],"id":"7e896ada-f30f-4334-953f-d101427e3ccf","_postman_id":"7e896ada-f30f-4334-953f-d101427e3ccf","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","id":"266b567c-8006-47e8-8474-d0f111870972","name":"API","type":"folder"}}},{"name":"Invoices","item":[{"name":"Create Invoice","item":[],"id":"5f666e69-761f-47d8-ab24-fba11117a686","description":"Invoice has been created
\nBody:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"created\",\n \"message\": \"Invoice created\"\n}\n\nExample:
\nInvoice has been opened by a client, filled with client's email-address and payment currency is selected (only if invoice has been created without predefined payment currency).
Payment address is provided to a client. No deposits are received from a client.
Body:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"pending\",\n \"message\": \"User started payment process, but hasn't paid yet\"\n}\n\nExample:
\nPayment initiation information from blockchain has been received.
Invoice is waiting for transaction to be completed
Body:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"processing\",\n \"message\": \"The client has made a payment, transaction confirmation is pending\"\n}\n\nExample:
\nTransaction has been successfully received for invoice, but it's amount is lower than expected invoice amount to be received.
\nBody:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"wrong\",\n \"message\": \"The payment amount is lower than the amount stated on the invoice\"\n}\n\nExample:
\nPreviously \"Wrong\"-statused invoice has been marked as refunded by a merchant to cancel the invoice and return already received funds to a client
\nBody:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"refunded\",\n \"message\": \"Invoice refunded\"\n}\n\nExample:
\nInvoice payment has been successfully received. It's amount is equal or greater than expected invoice amount.
\nBody:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"done\",\n \"message\": \"Invoice paid\"\n}\n\nExample:
\nInvoice with \"Pending\"-status hasn't been paid within required time.
Also invoice with \"Processing\"-status didn't receive payment within required time.
Body:
\n{\n \"invoiceId\": \"96850db7-41dd-4ce7-bacd-10371f96100a\",\n \"status\": \"closed\",\n \"message\": \"Invoice closed\"\n}\n\nExample:
\nAll webhooks are sending via POST-method and contain JSON-body with the following structure:
\n{\n \"invoiceId\": \"%invoice_id%\",\n \"status\": \"%status_name%\",\n \"message\": \"%user_readable_description%\"\n}\n\nWebhooks authenticity check:
\nEvery webhook contains \"Signature\" header generated by the following function:
\nprivate async sendWebhookNotification(\n webhookUrl: string,\n payload: any,\n secretKey: string,\n ): Promise<void> {\n const signature = this.generateWebhookSignature(secretKey, payload);\n await axios.post(webhookUrl, payload, {\n headers: {\n 'Content-Type': 'application/json',\n signature: signature,\n },\n });\n }\n private generateWebhookSignature(secretKey: string, payload: any): string {\n const hmac = createHmac('sha512', secretKey.trim());\n hmac.update(JSON.stringify(payload));\n return hmac.digest('hex');\n }\n\nwhere secretKey: \"%merchant's secret key from Settings/Tokens page on UI-side%\"
\n","_postman_id":"1a9ba1f3-b55f-458b-b670-70794833f94a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","id":"266b567c-8006-47e8-8474-d0f111870972","name":"API","type":"folder"}}}],"id":"e5df5a7a-fbbd-45e1-b6f6-53bb77a1bfd7","description":"KyrrexPay Webhooks utilizes Signature Token for signing Requests which sends to Webhook Targets. Webhooks are divided into general and webhooks related to payment pages. You can get your Signature Token on Tokens Project page in page Settings for general webhook settings.
\nIn order to receive webhooks from our service, you need to insert the URL of your webhook-receiver into the \"Webhook URL\" field on the Settings/Tokens page or execute the following PUT-request:
\ncurl ^\"https://my.pay.kyrrex.com/api/company/settings/webhook-url^\" ^\n -X ^\"PUT^\" ^\n -H ^\"authorization: Bearer %merchant_public_token% (can be found in merchant's account/Settings/Tokens/Public_Token)\" ^\n -H ^\"content-type: application/json^\" ^\n --data-raw ^\"^{^\\^\"webHookUrl^\\^\":^\\^\"%webhook_url_value%^\\^\"^}^\"\n\nSecurity Tip!!!
\nWe recommend using the function below to hash the payload using the private key from your personal account. For each request, compare it with the hash that came in 'x-kpay-sig', so that in case of hacking, attackers cannot steal your funds.
\n private async sendWebhookNotification(\n webhookUrl: string,\n payload: any,\n secretKey: string,\n ): Promise<void> {\n const signature = this.generateWebhookSignature(secretKey, payload);\n await axios.post(webhookUrl, payload, {\n headers: {\n 'Content-Type': 'application/json',\n signature: signature,\n },\n });\n }\n private generateWebhookSignature(secretKey: string, payload: any): string {\n const hmac = createHmac('sha512', secretKey.trim());\n hmac.update(JSON.stringify(payload));\n return hmac.digest('hex');\n }\n\nThis endpoint retrieves the list of auto withdrawal settings for crypto-assets. It is useful for companies to manage their automated withdrawal processes efficiently.
\nAuthorization via public token
\ncurl --location 'https://my.pay.kyrrex.com/api/company/auto-withdrawals' \\\n--header 'Authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'Content-Type: application/json'\n\nThe response will include the following fields:
\nautoWithdrawals:
assetId: name of the asset to be withdrawn
amount: The autowithdrawal treshold
isEnabled: true - enabled, false - disabled
withdrawalTag: tag for autoWithdrawal receiving address. Actual for tag consistent assets only. Can be null for non-required.
withdrawalAddress: address for autoWithdrawal to be received
This endpoint allows users to update the auto-withdrawal settings for specific assets in their account. It is particularly useful for enabling or disabling automatic withdrawals and specifying withdrawal addresses for different asset types.
\nassets: An object that contains the settings for different assets.
\nassetName: An object representing the specific asset (in this case, TON).
\nisEnabled: A boolean value indicating whether automatic withdrawals are enabled (true) or disabled (false).
withdrawalTag: tag for receiving address if it requires it. Can be \"null\" for non-required tag assets
\nwithdrawalAddress: A string that specifies the withdrawal address for the asset.
\ncurl --location --request PATCH 'https://my.pay.kyrrex.com/api/company/auto-withdrawals' \\\n--header 'Authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"assets\": {\n \"ton\": {\n \"amount\": %int_amount%, \n \"isEnabled\": true, \n \"withdrawalTag\": %tag%, \n \"withdrawalAddress\": \"%address%\" \n }\n }\n}'\n\nThis endpoint is used to execute autoWithdrawals for crypto-assets
\ncURL:
\ncurl --location 'https://my.pay.kyrrex.com/api/transactions/withdraw' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"items\": [\n {\n \"amount\": %int_amount%, \n \"tag\": %receiver_tag%, \n \"to\": \"%receiver_address%\", \n \"asset\": \"%asset_name%\" \n }\n ]\n}'\n\nThis request allows merchant to withdraw funds to multiple addresses within one API-call.
\nHeaders:
\n\"items\" (array, required) - a list of single withdrawals that will be executed within the call. Add as much withdrawal-items as you need.
\"asset\" (string, required) - asset+network name in which withdrawal should be executed.
Can be one of crypto-assets and networks supported by a system (currently: btc, eth, trc20usdt, usdterc20, solusdt, bep20usdt, sol, ton, usdc, solusdc, bep20usdc, bnb, ltc, trx, bch)
\"to\" (string, required) - receiver's address.
(Warning: You will receive a validation error if the recipient's address format differs from the defined asset standard. However, if the address follows the same standard as the asset but belongs to a different network, a loss of funds may occur)
\"amount\" (number, required) - net-amount that will be sent and received by a receiver-address
Note 1: any item's amount should not be lower than minimal withdrawal amount for defined \"asset\"-parameter
Note 2: \"amount\"-parameter is net-amount. Network-fees will be applied for each withdrawal item separately
Note 3: all item-amounts sum together with network-fees should not be bigger than defined \"asset\"-parameter available balance
Note 4: if the only one withdrawal-item will be provided - single withdrawal will be executed
curl --location 'https://my.pay.kyrrex.com/api/transactions/withdraw' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"items\": [\n {\n \"amount\": 12,\n \"to\": \"THFH4F2B8NcRrfRzrHMqZ2pJihMmwcuzpF\",\n \"asset\": \"trc20usdt\"\n },\n {\n \"amount\": 15,\n \"to\": \"TQqoPSppzKMdAYGcFVwdtJSDA67xsumGzG\",\n \"tag\": \"\",\n \"asset\": \"trc20usdt\"\n },\n {\n \"amount\": 23.99,\n \"to\": \"TMKCSXKTTZXTwSN5YRNFFHmMMXP8EkfDHU\",\n \"tag\": \"\",\n \"asset\": \"trc20usdt\"\n }\n ]\n}'\n\n[\n {\n \"message\": \"Transaction was successfully accepted by WL.\",\n \"success\": true,\n \"uid\": \"XXX-XXXXXXXX\"\n },\n {\n \"message\": \"Transaction was successfully accepted by WL.\",\n \"success\": true,\n \"uid\": \"XXX-XXXXXXXX\"\n },\n {\n \"message\": \"Transaction was successfully accepted by WL.\",\n \"success\": true,\n \"uid\": \"XXX-XXXXXXXX\"\n }\n]\n\nThis endpoint allows to set underpayment limit value for invoices to be marked as \"Done\" when received amount is lower than expected on set value.
Value can be set as exact amount and/or as invoice expected amount's percentage
curl --location --request PATCH 'https://my.pay.kyrrex.com/api/company/underpayment-limits' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"assets\": {\n \"btc\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"eth\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"usdt\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"sol\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"ton\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"usdc\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"bnb\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"ltc\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"near\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"trx\": {\n \"static\": 0,\n \"percentage\": 0\n },\n \"bch\": {\n \"static\": 0,\n \"percentage\": 0\n }\n }\n}'\n\nThis endpoint allows to get and review the current underpayment limits settings.
\ncurl --location 'https://my.pay.kyrrex.com/api/company/underpayment-limits' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side'\n\nThis endpoint creates a new invoice under merchant's account
\nHeaders:
\n\"invoiceCurrency\" (string,required) - invoice items price currency.
Can be eur, usd, one of crypto-assets supported by a system (currently: usdt, usdc, btc, eth, ton, sol, bnb, bch, ltc, trx)
\"items\" (object, required) - list of invoce items, each item should contain name and price. \"items\" object can contain as much items as needed
\"name\" (string, required) - any desirable item name
\"price\" (number, required) - any desirable item price specified in invoiceCurrency.
Can have any precision, but will be standartized or rounded to the following values:
- usd (2)
- eur (2)
- usdt (2)
- usdc (2)
- btc (6)
- eth (6)
- ton (4)
- sol (4)
- bnb (8)
- bch (8)
- ltc (8)
- trx (6)
Price of any item(s) can be zero or negative if total price of all invoice items is greater than 0
\"isMerchantPaysFee\" (boolean, non-required) - fee payee selector.
- false - client pays invoice total invoice amount + fees, merchant receives full total invoice amount
- true - client pays invoice total amount only, merchant receives total invoice amount excluding fee-amount
\"paymentCurrency\" (string, non-required) - currency that merchant want to receive from a client. Can be one of crypto-assets that are enabled by a merchant for accepting on Settings/Payment/Accept_Assets page.
If parameter is not provided or null-value is received - payment currency choice will be left to a client
\"redirectURL\" (string, non-required) - URL that will be automatically opened after invoice's \"Done\"-status reaching. If string-value is provided - this value will be used for redirection. If \"null\"-value is provided or parameter is absent - default value from Settings/Payment page will be used.
\ncurl --location 'https://my.pay.kyrrex.com/api/invoices/v1/regular' \\\n--header 'Authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"invoiceCurrency\": \"eur\",\n \"items\": [ \n {\n \"name\": \"Coffee\",\n \"price\": 10.99\n },\n {\n \"name\": \"Sugar\",\n \"price\": 1\n },\n {\n \"name\": \"Regular client discount\",\n \"price\": -3\n },\n {\n \"name\": \"Coffee gift (1+1 promo)\",\n \"price\": 0\n }\n ], \n \"isMerchantPaysFee\": false,\n \"paymentCurrency\": \"usdc\",\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\"\n}'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\nwrong - deposit is successfully received, but it's amount is lower than expected (lower than invoice total amount)
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nrefunded - previously \"wrong\"-statused invoice has been rejected by merchant
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, prices, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
{\n \"id\": \"invoice_id\",\n \"status\": \"created\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"company\": {\n \"name\": \"%company_name\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Coffee\",\n \"price\": \"10\"\n },\n {\n \"name\": \"Sugar\",\n \"price\": \"1\"\n },\n {\n \"name\": \"Regular client discount\",\n \"price\": \"-3\"\n }\n ],\n \"paymentCurrency\": \"usdc\",\n \"isMerchantPaysFee\": false,\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\"\n }\n}\n\nThis endpoint fills regular invoice with client's info, like email-address and paymentAsset (if it's not pre-defined by a merchant during the invoice creation)
\nHeaders:
\nAuthorization is not-required as invoice-info is provided to a non-registered client and uses it's email to identify his person as an invoice-payee
\n\"email\" (string, required) - client's email. Should meet the standard email-format as clientemail@service.domain
\"asset\" (string, required) - asset's name+network (temporary combined) in which client want to pay invoice. Will be set as \"paymentCurrency\" parameter value.
Should be one of the following values: btc, eth, trc20usdt, usdterc20, sol, ton, usdc, bnb, ltc, trx, bch.
Parameter is ignored if paymentCurrency parameter was previously provided during the invoice creation or it's value was null
curl --location 'https://pay.my.kyrrex.com/api/invoices/v1/regular/%invoice_id%/proceed' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"paymentCurrency\": \"sol\",\n \"clientEmail\": \"client@example.com\"\n}'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link:
https://pay.my.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\nwrong - deposit is successfully received, but it's amount is lower than expected (lower than invoice total amount)
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nrefunded - previously \"wrong\"-statused invoice has been rejected by merchant
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, prices, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
\"clientEmail\" - client's email, provided with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
\"address\" - payment address according to merchant pre-definition during the invoice cretaion POST-request execution OR client choice during the invoice filling with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
id - our address internal id
address - address itself in text-format
tag - address-related tag. If asset is not \"ton\" -> tag should be \"null\"
asset - asset name
\"paymentDetails\" - rate-based calculations of invoice fees in paymentCurrency. Used to calculate gross-amount that should be received for invoice.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
rate - invoiceCurrency -> paymentCurrency rate
invoiceFee - fees in paymentCurrency
\"expiredAt\" - date and time for invoice expected expiration-time.
Should have 30 minutes delay with \"createdAt\" parameter value for all assets except BTC - it's deilay is 120 minutes.
if expiredAt time is reached and no deposits were received - invoice receives \"Expired\"-status.
Note: parameter was previously unavailable for invoices with \"Created\"-status as expiration applies for payment window only that requires address to be assigned for invoice
{\n \"id\": \"%invoice_id%\",\n \"status\": \"%invoice_status%\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"company\": {\n \"name\": \"%company_name%\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Coffee\",\n \"price\": \"1000\"\n },\n {\n \"name\": \"Sugar\",\n \"price\": \"1\"\n },\n {\n \"name\": \"Regular client discount\",\n \"price\": \"-3\"\n }\n ],\n \"paymentCurrency\": \"trc20usdt\",\n \"isMerchantPaysFee\": false\n },\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\",\n \"clientEmail\": \"client_mail@service.domain\",\n \"address\": {\n \"id\": \"%payment_address_id%\",\n \"address\": \"%payment_address%\",\n \"tag\": null,\n \"asset\": \"trc20usdt\"\n },\n \"paymentDetails\": {\n \"rate\": \"1.16843920\",\n \"invoiceFee\": \"12.728032\"\n },\n \"expiredAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\"\n}\n\nThis endpoint allows to receive invoice info. For client it's necessary to see his invoice. For merchant it's necessary to have invoice info on his \"Invoices\" page
\nHeaders:
\nAuthorization is not-required as invoice-info is provided to a non-registered client and uses it's email to identify his person as an invoice-payee
\ncurl --location 'https://my.pay.kyrrex.com/api/invoices/v1/regular/%invoice_id%' \\\n--header 'Content-Type: application/json'\n\nResponse for invoice's GET-request will differ regarding to invoice's status and his body's corresponding content.
\nFull invoice body framework is the following:
\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\nwrong - deposit is successfully received, but it's amount is lower than expected (lower than invoice total amount)
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nrefunded - previously \"wrong\"-statused invoice has been rejected by merchant
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, prices, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
\"clientEmail\" - client's email, provided with PATCH-request.
Parameter is unavailable for invoices with \"Created\"-status.
\"address\" - payment address according to merchant pre-definition during the invoice cretaion POST-request execution OR client choice during the invoice filling with PATCH-request.
Parameter is unavailable for invoices with \"Created\"-status.
id - our address internal id
address - address itself in text-format
tag - address-related tag. If asset is not \"ton\" -> tag should be \"null\"
asset - asset name
\"paymentDetails\" - rate-based calculations of invoice fees in paymentCurrency. Used to calculate gross-amount that should be received for invoice.
Parameter is unavailable for invoices with \"Created\"-status.
rate - invoiceCurrency -> paymentCurrency rate
invoiceFee - fees in paymentCurrency
\"invoiceTransactions\" - list of invoice transactions.
Parameter is unavailable until at least one transaction has occurred in the system for this invoice.
Content for invoiceTransactions can be dynamically added as new transactions are created: deposits, autoswaps.
Objects content TBD
\"expiredAt\" - date and time for invoice expected expiration-time.
Should have 30 minutes delay with \"createdAt\" parameter value for all assets except BTC - it's deilay is 120 minutes.
if expiredAt time is reached and \"invoiceTransactions\" has zero deposits or absent - invoice receives \"Expired\"-status.
Parameter is unavailable for invoices with \"Created\"-status as expiration applies for payment window only that requires address to be assigned for invoice
{\n \"id\": \"%invoice_id%\",\n \"status\": \"%invoice_status%\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"company\": {\n \"name\": \"%company_name%\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Coffee\",\n \"price\": \"1000\"\n },\n {\n \"name\": \"Sugar\",\n \"price\": \"1\"\n },\n {\n \"name\": \"Regular client discount\",\n \"price\": \"-3\"\n }\n ],\n \"paymentCurrency\": \"trc20usdt\",\n \"isMerchantPaysFee\": false\n },\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\",\n \"clientEmail\": \"client_mail@service.domain\",\n \"address\": {\n \"id\": \"%payment_address_id%\",\n \"address\": \"%payment_address%\",\n \"tag\": null,\n \"asset\": \"trc20usdt\"\n },\n \"paymentDetails\": {\n \"rate\": \"1.16843920\",\n \"invoiceFee\": \"12.728032\"\n },\n \"invoiceTransactions\": [\n {\n \"id\": \"%transaction_id%\",\n \"amount\": \"34.1054\",\n \"from\": \"usdt\",\n \"txHash\": \"https://tronscan.org/#/transaction/%tx_id%\",\n \"companyId\": \"%company_id%\",\n \"invoiceId\": \"%invoice_id%\",\n \"addressId\": \"%payment_address_id%\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\"\n }\n ],\n \"expiredAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\"\n}\n\nThis endpoint creates a new AnyAmount invoice under merchant's account
\nHeaders:
\n\"items\" (object, required) - item or service provided by invoice.
\"items\" object can contain as much items as needed (but best practice for AnyAmount invoice is the only one item,service or purpose)
\"name\" (string, required) - any desirable item name
(Note: items don't require \"price\" for AnyAmount invoices as their concent is to let client decide what price should be paid by himself)
\"isMerchantPaysFee\" (boolean, non-required) - fee payee selector.
- false - client pays invoice total invoice amount + fees, merchant receives full total invoice amount
- true - client pays invoice total amount only, merchant receives total invoice amount excluding fee-amount
\"paymentCurrency\" (string, non-required) - currency that merchant want to receive from a client. Can be one of crypto-assets that are enabled by a merchant for accepting on Settings/Payment/Accept_Assets page.
If parameter is not provided or null-value is received - payment currency choice will be left to a client
\"redirectURL\" (string, non-required) - URL that will be automatically opened after invoice's \"Done\"-status reaching. If string-value is provided - this value will be used for redirection. If \"null\"-value is provided or parameter is absent - default value from Settings/Payment page will be used.
curl --location 'https://my.pay.kyrrex.com/api/invoices/v1/unlimited' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--data '{\n \"items\": [\n {\n \"name\": \"Product 1\"\n }\n ],\n \"isMerchantPaysFee\": null,\n \"paymentCurrency\": null,\n \"redirectURL\": \"https://google.com\"\n }'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
(Note: \"Wrong\" and \"Refunded\" statues are not appliable for AnyAmount-invoices as such invoices don't have defined expected amount to be received, what means that underpayment and it's refunding are impossible)
\"createdAt\" - invoice creation date and time
\"type\" - invoice type. Can be regular, unlimited or business
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
{\n \"id\": \"invoice_id\",\n \"status\": \"created\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"type\": \"unlimited\",\n \"company\": {\n \"name\": \"%company_name\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Product 1\"\n }\n ],\n \"paymentCurrency\": \"usdc\",\n \"isMerchantPaysFee\": false,\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\"\n }\n}\n\nThis endpoint fills AnyAmount invoice with client's info, like email-address and paymentAsset (if it's not pre-defined by a merchant during the invoice creation)
\nHeaders:
\nAuthorization is not-required as invoice-info is provided to a non-registered client and uses it's email to identify his person as an invoice-payee
\n\"clientEmail\" (string, required) - client's email. Should meet the standard email-format as clientemail@service.domain
\"paymentCurrency\" (string, required) - asset's name+network (temporary combined) in which client want to pay invoice. Will be set as \"paymentCurrency\" parameter value.
Should be one of the following values: btc, eth, trc20usdt, usdterc20, sol, ton, usdc, bnb, ltc, trx, bch.
Parameter is ignored if paymentCurrency parameter was previously provided during the invoice creation
\"paymentAmount\" (number, required) - amount that is entered by a client to receive a reference of amount to be received in invoiceCurrency (required for FE-side correct work, can have any desirabe value for API-only invoice processing)
\"invoiceCurrency\" (string, non-required) - invoice currency for payment amount reference to be calculated (required for FE-side correct work, can be ignored for API-only invoice processing)
curl --location 'https://my.pay.kyrrex.com/api/invoices/v1/unlimited/%invoice_id%/proceed' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"paymentCurrency\": \"usdc\",\n \"clientEmail\": \"client@example.com\",\n \"paymentAmount\": 100,\n \"invoiceCurrency\": \"eur\"\n}'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"type\" - invoice type. Can be regular, unlimited or business
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
\"clientEmail\" - client's email, provided with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
\"address\" - payment address according to merchant pre-definition during the invoice cretaion POST-request execution OR client choice during the invoice filling with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
id - our address internal id
address - address itself in text-format
tag - address-related tag. If asset is not \"ton\" -> tag should be \"null\"
asset - asset name
\"paymentDetails\" - rate-based calculations of invoice fees in paymentCurrency. Used to calculate gross-amount that should be received for invoice.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
rate - invoiceCurrency -> paymentCurrency rate
invoiceFee - fees in paymentCurrency
\"expiredAt\" - date and time for invoice expected expiration-time.
Should have 30 minutes delay with \"createdAt\" parameter value for all assets except BTC - it's deilay is 120 minutes.
if expiredAt time is reached and no deposits were received - invoice receives \"Expired\"-status.
Note: parameter was previously unavailable for invoices with \"Created\"-status as expiration applies for payment window only that requires address to be assigned for invoice
{\n \"id\": \"%invoice_id%\",\n \"status\": \"%invoice_status%\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"type\": \"unlimited\",\n \"company\": {\n \"name\": \"%company_name%\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"items\": [\n {\n \"name\": \"Product 1\"\n }\n ],\n \"paymentCurrency\": \"trc20usdt\",\n \"isMerchantPaysFee\": false,\n \"paymentAmount\": \"100\"\n },\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\",\n \"clientEmail\": \"client_mail@service.domain\",\n \"address\": {\n \"id\": \"%payment_address_id%\",\n \"address\": \"%payment_address%\",\n \"tag\": null,\n \"asset\": \"trc20usdt\",\n \"qrCodeURL\": \"string link to address QR-code generated\",\n \"qrCodeBase64\": \"string link to address QR-code generated in Base64\"\n },\n \"paymentDetails\": {\n \"rate\": \"1.16843920\",\n \"invoiceFee\": \"12.728032\"\n },\n \"expiredAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\"\n}\n\nThis endpoint creates a new business invoice under merchant's account
\nHeaders:
\n\"invoiceCurrency\" (string,required) - invoice items price currency.
Can be eur, usd, one of crypto-assets supported by a system (currently: usdt, usdc, btc, eth, ton, sol, bnb, bch, ltc, trx)
\"items\" (object, required) - list of invoce items, each item should contain name and price. \"items\" object can contain as much items as needed
\"description\" (string, required) - any desirable item name
\"price\" (number, required) - any desirable item price specified in invoiceCurrency.
Can have any precision, but will be standartized or rounded to the following values:
- usd (2)
- eur (2)
- usdt (2)
- usdc (2)
- btc (6)
- eth (6)
- ton (4)
- sol (4)
- bnb (8)
- bch (8)
- ltc (8)
- trx (6)
Price of any item(s) can be zero or negative if total price of all invoice items is greater than 0
\"isMerchantPaysFee\" (boolean, non-required) - fee payee selector.
- false - client pays invoice total invoice amount + fees, merchant receives full total invoice amount
- true - client pays invoice total amount only, merchant receives total invoice amount excluding fee-amount
\"paymentCurrency\" (string, non-required) - currency that merchant want to receive from a client. Can be one of crypto-assets that are enabled by a merchant for accepting on Settings/Payment/Accept_Assets page.
If parameter is not provided or null-value is received - payment currency choice will be left to a client
\"invoiceNumber\" (string,required) - invoice legal number. Can contain any symbols and should be unique for each business invoice.
\"seller\" (array, required) - seller's info legal block:
name (string, required) - company name
address (string,required) - company address
phone (string, required) - company phone
taxId (string, non-required) - company tax payee id
\"buyer\" (string, required) - buyer's info legal block:
name (string, required) - client's name
email (string, required) - client's email (legal entity, doesn't replace emailAddress from a client during the invoice filling witl client's data)
address (string, required) - client's address
phone (string, required) - client's phone
taxid (string, non-required) - client's tax payee id
\"taxes\" (object, non-required) - additional taxs included into invoice:
name (string, required) - tax name
amount (number, required) - tax amount
\"notesToBuyer\" (string, ) - notes that will be provided to a client (buyer) during his invoice processing
\"internalNotes\" (string, non-required) - internal invoice-related information. Will be available for merchant on \"Invoices\"/invoice details page
\"issueDate\" (string, non-required) - invoice subject creation legal date
\"dueDate\" (string, non-required) - invoice subject expiration legal date
\"redirectURL\" (string, non-required) - URL that will be automatically opened after invoice's \"Done\"-status reaching. If string-value is provided - this value will be used for redirection. If \"null\"-value is provided or parameter is absent - default value from Settings/Payment page will be used.
curl --location 'https://my.pay.kyrrex.com/api/invoices/v1/business' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--data-raw '{\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"description\": \"Product 1\",\n \"price\": 100.50\n },\n {\n \"description\": \"Product 2\",\n \"price\": 1.00\n }\n ],\n \"isMerchantPaysFee\": true,\n \"paymentCurrency\": \"usdt\",\n \"invoiceNumber\": \"INV-123\",\n \"seller\": {\n \"name\": \"Company Name\",\n \"address\": \"123 Business St, City, Country\",\n \"phone\": \"+1234567890\",\n \"taxId\": \"TAX123456\"\n },\n \"buyer\": {\n \"name\": \"Customer Name\",\n \"email\": \"customer@example.com\",\n \"address\": \"456 Customer Ave, City, Country\",\n \"phone\": \"+0987654321\",\n \"taxId\": \"CUST789012\"\n },\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"amount\": 21.00\n }\n ],\n \"notesToBuyer\": \"Thank you for your business!\",\n \"internalNotes\": \"Internal notes for accounting\",\n \"issueDate\": \"2024-01-15\",\n \"dueDate\": \"2024-02-15\",\n \"redirectURL\": \"https://google.com\"\n }'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\nwrong - deposit is successfully received, but it's amount is lower than expected (lower than invoice total amount)
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nrefunded - previously \"wrong\"-statused invoice has been rejected by merchant
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"type\" - invoice type. Can be regular, unlimited or business
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, prices, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"invoiceNumber\" - invoice's legal number
\"seller\" - invoice's seller info block
\"buyer\" - invoice's buyer info block
\"taxes\" - invoice's taxes
\"notesToBuyer\" - info that will be provided for a client during the invoice processing
\"internalNotes\" - info that will be displayed ofr merchant on invoice details page via \"Invoices\" page
\"issueDate\" - invoice legal subject issue date
dueDate\" - invoice legal subject expiration date
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
{\n \"id\": \"%invoice_id%\",\n \"status\": \"created\",\n \"createdAt\": \"2026-02-16T13:23:26.816Z\",\n \"type\": \"Business\",\n \"company\": {\n \"name\": \"%company_name%\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Product 1\",\n \"price\": \"1000.5\"\n },\n {\n \"name\": \"Product 2\",\n \"price\": \"1\"\n }\n ],\n \"paymentCurrency\": \"usdt\",\n \"isMerchantPaysFee\": true\n },\n \"invoiceNumber\": \"INV-123\",\n \"seller\": {\n \"name\": \"Company Name\",\n \"address\": \"123 Business St, City, Country\",\n \"phone\": \"+1234567890\",\n \"taxId\": \"TAX123456\"\n },\n \"buyer\": {\n \"name\": \"Customer Name\",\n \"email\": \"customer@example.com\",\n \"address\": \"456 Customer Ave, City, Country\",\n \"phone\": \"+0987654321\",\n \"taxId\": \"CUST789012\"\n },\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"amount\": 21\n }\n ],\n \"notesToBuyer\": \"Thank you for your business!\",\n \"internalNotes\": \"Internal notes for accounting\",\n \"issueDate\": \"2024-01-15\",\n \"dueDate\": \"2024-02-15\",\n \"redirectURL\": \"https://google.com\"\n}\n\nThis endpoint fills business invoice with client's info, like email-address and paymentAsset (if it's not pre-defined by a merchant during the invoice creation)
\nHeaders:
\nAuthorization is not-required as invoice-info is provided to a non-registered client and uses it's email to identify his person as an invoice-payee
\n\"clientEmail\" (string, required) - client's email. Should meet the standard email-format as clientemail@service.domain
\"paymentCurrency\" (string, required) - asset's name+network (temporary combined) in which client want to pay invoice. Will be set as \"paymentCurrency\" parameter value.
Should be one of the following values: btc, eth, trc20usdt, usdterc20, sol, ton, usdc, bnb, ltc, trx, bch.
Parameter is ignored if paymentCurrency parameter was previously provided during the invoice creation
curl --location 'https://my.pay.kyrrex.com/api/invoices/v1/business/%invoice_id%/proceed' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"paymentCurrency\": \"trc20usdt\",\n \"clientEmail\": \"client@example.com\"\n}'\n\n\"id\" - invoice identifier. Can be used to open invoice on frontend-side by the following link: https://pay.kyrrex.com/%invoice_id%
\"status\"- dispalys current invoice state. Can be the following:
created - invoice has been created by a merchant but hasn't been filled with client's info (email, payment currency and it's network)
\npending - client has filled invoice with his info and received the payment address for deposit to be made. Deposit is still not received by invoice
\nprocessing - deposit receving procedure has started and in progress
\nwrong - deposit is successfully received, but it's amount is lower than expected (lower than invoice total amount)
\ndone - deposit is successfully received. One of the following statements has been reached:
\ndeposit amount equals or is greater than expected
\npreviously \"wrong\"-statused invoice has been accepted by merchant
\ndeposit amount is lower that expected by a sum, covered by underpayment limit
\nrefunded - previously \"wrong\"-statused invoice has been rejected by merchant
\nfailed - deposit receiving is failed by the system due to techical issues
\nexpired - previously \"pending\"-statused invoice hasn't received payment till expiration time
\n\"createdAt\" - invoice creation date and time
\"type\" - invoice type. Can be regular, unlimited or business
\"company\" - merchant's company information
name
\nlogourl - link to company's logo location
\nassets - list of assets settings applied for merchant's company. Displays whether asset is acceptable by a company and can be used as a paymentCurrency parameter value or not
\"invoiceContent\" - list of primary invoice information like items list, prices, fees payee, invoice currency and payment currency (can be null for \"created\"-statuses invoices)
\"invoiceNumber\" - invoice's legal number
\"seller\" - invoice's seller info block
\"buyer\" - invoice's buyer info block
\"taxes\" - invoice's taxes
\"notesToBuyer\" - info that will be provided for a client during the invoice processing
\"internalNotes\" - info that will be displayed ofr merchant on invoice details page via \"Invoices\" page
\"issueDate\" - invoice legal subject issue date
dueDate\" - invoice legal subject expiration date
\"redirectURL\" - URL that will be automatically opened after invoice's \"Done\"-status reaching.
\"null\"-value means that redirect won't be executed (because if \"null\" was provided only by invoice creation POST-endpoint, default value should have been used).
\"clientEmail\" - client's email, provided with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
\"address\" - payment address according to merchant pre-definition during the invoice cretaion POST-request execution OR client choice during the invoice filling with PATCH-request.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
id - our address internal id
address - address itself in text-format
tag - address-related tag. If asset is not \"ton\" -> tag should be \"null\"
asset - asset name
\"paymentDetails\" - rate-based calculations of invoice fees in paymentCurrency. Used to calculate gross-amount that should be received for invoice.
Note: parameter was previously unavailable for invoices with \"Created\"-status.
rate - invoiceCurrency -> paymentCurrency rate
invoiceFee - fees in paymentCurrency
\"expiredAt\" - date and time for invoice expected expiration-time.
Should have 30 minutes delay with \"createdAt\" parameter value for all assets except BTC - it's deilay is 120 minutes.
if expiredAt time is reached and no deposits were received - invoice receives \"Expired\"-status.
Note: parameter was previously unavailable for invoices with \"Created\"-status as expiration applies for payment window only that requires address to be assigned for invoice
{\n \"id\": \"%invoice_id%\",\n \"status\": \"%invoice_status%\",\n \"createdAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\",\n \"type\": \"regular\",\n \"company\": {\n \"name\": \"%company_name%\",\n \"logoUrl\": \"%logo_url%\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bnb\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"ltc\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"near\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"trx\",\n \"isAllowed\": false\n },\n {\n \"asset\": \"bch\",\n \"isAllowed\": false\n }\n ]\n },\n \"invoiceContent\": {\n \"invoiceCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Coffee\",\n \"price\": \"1000\"\n },\n {\n \"name\": \"Sugar\",\n \"price\": \"1\"\n },\n {\n \"name\": \"Regular client discount\",\n \"price\": \"-3\"\n }\n ],\n \"paymentCurrency\": \"trc20usdt\",\n \"isMerchantPaysFee\": false\n },\n \"invoiceNumber\": \"hki,dw\",\n \"seller\": {\n \"name\": \"Company Name\",\n \"phone\": \"+1234567890\",\n \"taxId\": \"TAX123456\",\n \"address\": \"123 Business St, City, Country\"\n },\n \"buyer\": {\n \"name\": \"Customer Name\",\n \"email\": \"customer@example.com\",\n \"phone\": \"+0987654321\",\n \"taxId\": \"CUST789012\",\n \"address\": \"456 Customer Ave, City, Country\"\n },\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"amount\": 21\n }\n ],\n \"notesToBuyer\": \"Thank you for your business!\",\n \"internalNotes\": \"Internal notes for accounting\",\n \"issueDate\": \"2024-01-15\",\n \"dueDate\": \"2024-02-15\",\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\",\n \"clientEmail\": \"client_mail@service.domain\",\n \"address\": {\n \"id\": \"%payment_address_id%\",\n \"address\": \"%payment_address%\",\n \"tag\": null,\n \"asset\": \"trc20usdt\",\n \"qrCodeURL\": \"string link to address QR-code generated\",\n \"qrCodeBase64\": \"string link to address QR-code generated in Base64\"\n },\n \"paymentDetails\": {\n \"rate\": \"1.16843920\",\n \"invoiceFee\": \"12.728032\"\n },\n \"expiredAt\": \"YYYY-MM-DDTHH:MM:SS.000Z\"\n}\n\nThis endpoint is used to create a new invoice.
\nfiatAmount (number): The amount in fiat currency for the invoice.
fiatCurrency (string): The fiat currency in which the invoice amount is specified. Available values: \"eur\", \"usd\"
items (array, optional): An array of items included in the invoice, where each item has a name (string) and price (number).
isUnlimited (boolean): Indicates whether the invoice is unlimited.
curl --location 'https://my.pay.kyrrex.com/api/invoices' \\\n--header 'Authorization: Bearer %merchant_public_token% (can be found in merchant'\\''s account/Settings/Tokens/Public_Token) on FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"fiatAmount\": 100,\n \"fiatCurrency\": \"eur\",\n \"items\": [\n {\n \"name\": \"Coffee\",\n \"price\": 50\n }, {\n \"name\": \"Sugar\",\n \"price\": 50\n }\n ],\n \"isUnlimited\": false\n}'\n\nThe response to this request will contain the details of the created invoice, including the invoice ID, status, and payment details.
\n{\n \"invoiceUrl\": \"https://pay.my.kyrrex.com/%invoice_id%\",\n \"customInvoice\": {\n \"id\": \"%invoice_id%\",\n \"items\": [\n {\n \"name\": \"test\",\n \"asset\": \"eur\",\n \"price\": 100\n }\n ],\n \"invoiceCurrency\": \"eur\",\n \"fiatAmount\": 100,\n \"cryptoAmount\": null,\n \"paymentCurrency\": null,\n \"isMerchantPaysFee\": false\n }\n}\n\nAfter client fills invoice with his email and selects an assset, the new invoice body updates appear with the customInvoice object:
\n{\n \"id\": \"%invoice_id%\",\n \"status\": \"pending\",\n \"externalStatus\": null,\n \"fee\": \"%fee-samount%\",\n \"swapFee\": null,\n \"fxRisksFee\": null,\n \"depositFee\": null,\n \"offRampFee\": null,\n \"withdrawalFee\": null,\n \"paymentScenario\": null,\n \"email\": \"%client_emain@service.domain%\",\n \"fiatAmount\": \"100\",\n \"fiatCurrency\": \"eur\",\n \"cryptoAmount\": \"117.630000\",\n \"cryptoCurrency\": \"%selected_crypto_currency%\",\n \"receivedAmount\": \"0\",\n \"rate\": \"0.8501232678738417\",\n \"items\": [\n {\n \"name\": \"test\",\n \"asset\": \"eur\",\n \"price\": 100\n }\n ],\n \"isUnlimited\": false,\n \"submerchantId\": null,\n \"terminalId\": null,\n \"createdAt\": \"2025-07-04T13:36:20.723Z\",\n \"expiredAt\": \"2025-07-04T14:08:31.439Z\",\n \"isMerchantPaysFee\": false,\n \"priceIn\": \"eur\",\n \"company\": {\n \"id\": \"%comapny_id%\",\n \"name\": \"companyName\",\n \"assets\": [\n {\n \"asset\": \"btc\",\n \"isAllowed\": true,\n \"isAutoConversionAllowed\": false\n },\n {\n \"asset\": \"eth\",\n \"isAllowed\": true,\n \"isAutoConversionAllowed\": false\n },\n {\n \"asset\": \"usdt\",\n \"isAllowed\": true,\n \"isAutoConversionAllowed\": false\n },\n {\n \"asset\": \"sol\",\n \"isAllowed\": false,\n \"isAutoConversionAllowed\": false\n },\n {\n \"asset\": \"ton\",\n \"isAllowed\": false,\n \"isAutoConversionAllowed\": false\n },\n {\n \"asset\": \"usdc\",\n \"isAllowed\": false,\n \"isAutoConversionAllowed\": false\n }\n ],\n \"logoId\": null,\n \"logoUrl\": null,\n \"deletedAt\": null\n },\n \"address\": {\n \"id\": \"%address_id%\",\n \"address\": \"%address_value%\",\n \"tag\": null,\n \"asset\": \"%selected_asset%\",\n \"companyId\": null,\n \"externalId\": null,\n \"isBlocked\": false,\n \"isMerchant\": false,\n \"isRotating\": false,\n \"expiredAt\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"deletedAt\": null\n },\n \"invoiceTransactions\": [],\n \"minDeposit\": \"10.0\",\n \"logoUrl\": null,\n \"totalAmountWithFees\": \"119.828283\",\n \"customInvoice\": {\n \"id\": \"%invoice_id%\",\n \"items\": [\n {\n \"name\": \"test\",\n \"asset\": \"eur\",\n \"price\": 100\n }\n ],\n \"invoiceCurrency\": \"eur\",\n \"fiatAmount\": \"100\",\n \"cryptoAmount\": \"117.630000\",\n \"paymentCurrency\": \"trc20usdt\",\n \"isMerchantPaysFee\": false,\n \"email\": \"client_email@service.domain\",\n \"fees\": \"2.198282828282828\",\n \"rate\": \"0.8501232678738417\",\n \"address\": {\n \"address\": \"%address_value%\",\n \"tag\": null,\n \"asset\": \"%selected_asset%\"\n },\n \"totalAmountGross\": \"119.828283\"\n }\n}\n\nThis endpoint creates invoice priced in crypto
\nHeaders:
\n\"fiatAmount\" parameter IS ABSENT
\n\"cryptoAmount\" parameter IS PRESENT
\n\"priceIn\" parameter has crypto-asset ticker-value (e.g. \"usdt\", \"btc\", \"eth\")
\ncurl --location 'https://my.pay.kyrrex.com/api/invoices' \\\n--header 'Authorization: Bearer %merchant_public_token% (can be found in merchant'\\''s account/Settings/Tokens/Public_Token)' \\\n--header 'content-type: application/json' \\\n--data '{\n \"cryptoAmount\": 100,\n \"fiatCurrency\": \"eur\",\n \"cryptoCurrency\": \"usdt\",\n \"priceIn\": \"usdt\",\n \"items\": [\n {\n \"name\": \"awd100\",\n \"price\": 100,\n \"asset\": \"usdt\"\n }\n ],\n \"isMerchantPaysFee\": false,\n \"isUnlimited\": false\n}'\n\n{\n \"invoiceUrl\": \"https://pay.my.kyrrex.com/%invoice_id%\"\n}\n\nThis endpoint updates the notification settings for a company.
\n\"Authorization\": StartFragmentBearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-sideEndFragment
\nmerchantPaymentReceived (boolean): true - to receive emails by merchant about payment receiving, false - to not receive them
\nmerchantTransactionFailed (boolean): true - to receive emails by merchant about payment failure , false - to not receive them
\ncustomerPaymentReceived (boolean): true - to receive emails by customer about payment receiving, false - to not receive them
\ncustomerTransactionFailed (boolean): true - to receive emails by customer about payment failure , false - to not receive them
\ncurl --location --request PATCH 'https://my.pay.kyrrex.com/api/company' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"notification\": {\n \"merchantPaymentReceived\": false,\n \"merchantTransactionFailed\": true,\n \"customerPaymentReceived\": false,\n \"customerTransactionFailed\": true\n }\n}'\n\nThe response from this endpoint will include current merchant's company info with the following \"notifications\" block:
\n{\n //different company's info before the notifications block...\n \"notification\": {\n \"merchantPaymentReceived\": false,\n \"merchantTransactionFailed\": true,\n \"customerPaymentReceived\": false,\n \"customerTransactionFailed\": true\n },\n //different company's info after the notifications block...\n}\n\nThis enpoint allows to set the default redirection URL that will make \"Done\"-statused invoice be redirected to provided link.
\nThat setting will be applied for newly created invoices with absent \"redirectURL\" parameter or parameter value is null within the invoice creation POST-request.
\n\"redirectURL\" (string, required) - URL-formatted link-address.
If null value is provided - redirection will be executed using \"redirectURL\" parameter provided for the invoice creation POST-request.
Note: if no link provided for the invoice creation POST-request and Settings \"redirectURL\" value is null - redirection won't be executed, client will see \"Done\"-statues invoice details page permanently.
curl --location --request PUT 'https://my.pay.kyrrex.com/api/company/settings/redirect-url' \\\n--header 'authorization: Bearer %merchant_public_key%\" //can be found on the Settings/Tokens page on the FE-side' \\\n--header 'content-type: application/json' \\\n--data '{\n \"redirectURL\": \"%url_for_DONE_statused_invoices_redirection%\"\n}'\n\nAll the company payment settings wil be returned with \"redirectURL\" parameter's actual value
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","id":"266b567c-8006-47e8-8474-d0f111870972","name":"API","type":"folder"}},"urlObject":{"protocol":"https","path":["api","company","settings","redirect-url"],"host":["my","pay","kyrrex","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1242cdd4-3cff-48e5-95ce-b690ae0ad055"}],"id":"d22ae750-9b5f-4924-9c63-bae9b06af3c4","_postman_id":"d22ae750-9b5f-4924-9c63-bae9b06af3c4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","id":"266b567c-8006-47e8-8474-d0f111870972","name":"API","type":"folder"}}}],"id":"266b567c-8006-47e8-8474-d0f111870972","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"bfcf5f0c-cd36-4c34-a846-41db185156cd","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"a1233a58-6968-42f7-ab57-5a7bc1f31e98","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"266b567c-8006-47e8-8474-d0f111870972","description":""}],"variable":[{"key":"publicToken","value":"","type":"default"}]}