You need to obtain public and secret keys in your personal account before using this API.
\nBase url: https://ocp.onchainpay.io/api-gateway
Public key should be passed in header x-api-public-key
Secret key is used for creating signature of your request. Signature should be passed in header x-api-signature
Example of a key pair:
\npublic:
\na9biVHtyP71VxuItAd88tuN+WyNGxVR41j9lGLj7zc0DjtGHkNRAKQWS/fiCnJPomY9i+hETCLiQvR5l+siKug==
secret:
\nRbWMG0rT6NSDQPKXs44gau/97OTsMW1+EakuQA8gb+IwjIUAdx56Fl3Oa7a8dw5L3soWK/o6UFfqlzh/6LXPDA==
If you want to use your own key pair and send requests through this documentation, you can edit collection variables of this documentation (https://learning.postman.com/docs/sending-requests/variables/#defining-collection-variables)
\nYou need to specify your secret key, apply SHA256 encryption to your payload and convert the result to HEX format
You should pass nonce parameter in the payload of every request to this API. nonce is a number that must be incremented from previous requests every time. Otherwise the request will fail.
We will use Unix TimeStamp as the nonce value for sending requests in this document.
NodeJSLet's say we want to get price rate of ETH/USDT (method /price-rate)
1. Build request payload
\nconst payload = { from: 'ETH', to: 'USDT' };\n\n2. Add nonce parameter to the payload in order to avoid request duplication.
By using unix timestamp as nonce parameter we will meet the requirements of using number and its incrementing for every new request.
payload.nonce = Date.now(); // 1643881172430\n\n3. Create string from payload and used it in a process of creating signature.
\nconst stringPayload = JSON.stringify(payload); // {\"from\":\"ETH\",\"to\":\"USDT\",\"nonce\":1643881172430}\n\n4. Create signature:
\nExample with crypto-js module:
const CryptoJS = require(\"crypto-js\"); \nconst sign = CryptoJS.HmacSHA256(stringPayload, __PRIVATE_KEY__).toString(CryptoJS.enc.Hex)\n\nExample with crypto module:
const crypto = require('crypto'); \nconst sign = crypto.createHmac('SHA256', __PRIVATE_KEY__).update(stringPayload).digest('hex');\n\n5. Send request with required headers:
\nconst axios = require('axios'); // lib for HTTP requests\nconst response = await axios.post(__BASE_URL__ + '/price-rate', stringPayload, \n{ \n headers: \n {\n 'x-api-public-key': __PUBLIC_KEY__, \n 'x-api-signature': sign \n } \n});\n\n6. Response:
\nconsole.log(response.data); // {\"success\":true,\"response\":\"2751.51000000\"}\n\nSchema of success response:
\n{\n \"success\":true,\n \"response\": ...\n}\n\nSchema of error response:
\n{\n \"success\":false,\n \"error\": {\"name\": \"...\",\"message\": \"...\",\"code\": ...},\n \"requestId\": \"...\"\n}\n\nError is presented in response payload
\nYou can configure notifications to be sent to any system that accepts incoming webhooks over the HTTP/HTTPS protocol. To do this, you must specify the Webhook URL when creating an order, to which notifications about the order will be sent.
\nIf you do not respond with the status 200, then we will send 6 request: with 10 seconds interval, then 5 with 30 minutes interval, then 4 with 2 hour interval, then 3 with 12 hour interval.
\nIf Webhook URL was provided within API method, it will have following additional headers:
\nx-api-public-key - public key, which was used in origin request with provided Webhook URLx-api-signature - signature that was made with same algorithm from \"Creating request signature\" section\"successWebhook\": \"https://example.com/success-webhook-url\"
\n\"errorWebhook\": \"https://example.com/error-webhook-url\"
\n{\n \"id\": \"d01d03e2-15dc-b03a-b34e-46cad2345b92\",\n \"advancedBalanceId\": \"c6e7d8dc-ce10-637d-147b-2dda3015b8a4\",\n \"currency\": \"ETH\",\n \"network\": \"etehereum\",\n \"link\": \"https://ocp.onchainpay.io/merchant/checkout/7e7a9d52-f260-429f-b943-8af3c91c9ea1\",\n \"status\": \"processed\",\n \"order\": \"#123456789\",\n \"description\": \"Order #123456789\",\n \"address\": \"0x000000000c8950e52aa315030efedc861da658e2\",\n \"addressId\": \"8eae79cf-1db2-4858-9023-aca473d805e2\",\n \"tag\": \"velit ex quis\",\n \"amount\": \"0.84\",\n \"received\": \"0.86\",\n \"transactions\": [\n {\n \"id\": \"f0b22f11-007c-4f65-bb9b-265432ab64c3\",\n \"status\": \"processed\",\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.0001\",\n \"tx\": \"0x8fb0d40678d1bb4b6c0b2095c18d9280aa8ccf966e778e6b209f4f71c7f1e835\",\n \"confirmations\": \"15\",\n \"sender\": \"0xcD62a4E08513f16F86C1c0AF0860DD6b3De1B83d\",\n \"priceUSD\": \"212.90000000\",\n \"amountUSD\": \"0.02129\"\n },\n {\n \"id\": \"a2a7ed3b-a8af-42c4-900c-d21e1d9eda3c\",\n \"status\": \"processed\",\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.0006\",\n \"tx\": \"0x60032c394fcc7a103bc2826f9b81e5086be90628331e1ce163e1c576c64baf06\",\n \"confirmations\": \"15\",\n \"sender\": \"0x54936CE809bBccC7f1378c7ec88F5504cE49605C\",\n \"priceUSD\": \"212.70000000\",\n \"amountUSD\": \"0.12762\"\n }\n ],\n \"orphanDeposits\": [\n {\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"organizationId\": \"1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39\",\n \"orderId\": \"d01d03e2-15dc-b03a-b34e-46cad2345b92\",\n \"stage\": \"WITHDRAWAL\",\n \"status\": \"PROCESSED\",\n \"message\": null,\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.00000001\",\n \"canWithdrawal\": true,\n \"inTransaction\": {\n \"addressType\": \"PAY_IN\",\n \"addressId\": \"8519ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"outTransaction\": {\n \"withdrawalId\": \"4429ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"createdAt\": \"2023-05-30T14:10:27.283Z\"\n }\n ],\n \"successWebhook\": \"https://example.com/success-webhook-url\",\n \"errorWebhook\": \"https://example.com/error-webhook-url\",\n \"returnUrl\": \"null\",\n \"expiresAt\": \"2021-05-23T15:00:00Z\",\n \"createdAt\": \"2021-05-23T15:00:00Z\",\n \"updatedAt\": \"2021-05-23T15:00:00Z\"\n}\nWhen the withdrawal is completed, a webhook with the status of this payment is sent to the webhookUrl specified when creating the withdrawal.
addressId - personal address to which the deposit cameuserId - the ID of the user who owns the personal address{\n \"id\": \"fd1dbab8-06c2-4e0e-88fb-32f5e97cc0e2\",\n \"addressId\": \"a3018d42-aa59-42f3-a0f9-6d47e461d344\",\n \"amount\": \"0.32\",\n \"currency\": \"USDT\",\n \"network\": \"tron\",\n \"status\": \"processed\",\n \"tx\": \"46f4c1bafd9925de3d61d8a86d83851e73e\",\n \"createdAt\": \"2023-03-21T13:50:48.603Z\",\n \"updatedAt\": \"2023-03-21T13:51:14.018Z\"\n}\n\nPossible values for status:
error - error occured during withdrawal processingprocessed - successful withdrawalWhen the status of a billing link changes, a webhook is sent to the address specified when the link was created.
\n{\n \"id\": \"9085a4bd-0099-4f8a-9dc5-9a717ab1d93b\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"clientId\": \"qw12\",\n \"clientName\": null,\n \"clientEmail\": \"site@domain.com\",\n \"webhookUrl\": \"https://site.com/webhook\",\n \"returnUrl\": null,\n \"address\": \"0xf038f6b\",\n \"currency\": \"USDC\",\n \"network\": \"ethereum\",\n \"status\": \"SUCCESS\",\n \"createdAt\": \"2023-03-02T10:10:21.064Z\",\n \"updatedAt\": \"2023-03-02T10:13:25.509Z\"\n}\n\nWhen the subscription status changes or when a payment is made, a webhook is sent to the address specified when the subscription was created.
\n{\n \"id\": \"d5743dea-5a78-4096-ae07-95b1f10bc5dd\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"billingLinkId\": \"e7e7a111-2d24-4aa3-afae-540f313c738b\",\n \"title\": \"Flixnet/monthly\",\n \"description\": \"Flixnet monthly subscription / HD quality\",\n \"currency\": \"USDT\",\n \"amount\": \"2.0000000\",\n \"spendInterval\": 120,\n \"message\": null,\n \"webhookUrl\": \"https://site.com/webhook\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2023-02-27T11:50:53.710Z\",\n \"updatedAt\": \"2023-03-01T19:29:04.090Z\",\n \"paymentEvent\": {\n \"id\": \"9c06e989-9d19-461b-bd94-e94032012407\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"billingLinkId\": \"e7e7a111-2d24-4aa3-afae-540f313c738b\",\n \"amount\": \"2\",\n \"status\": \"PROCESSED\",\n \"tx\": \"0xdabd91e979122bb78d0a5cf1e5174dff3e10b906a31adbfd625ff80cca14e8c2\",\n \"createdAt\": \"2023-03-01T13:11:57.662Z\",\n \"updatedAt\": \"2023-03-01T13:14:32.868Z\"\n }\n}\n\nWhen the subscription status changes, a webhook with the subscription object is sent. In this case, paymentEvent is filled only if the webhook event is related to making a payment.
Possible values for status:
ACTIVE - subscription active/renewedERROR - subscription payment failedDECLINE - unable to complete the payment (e.g. lack of money)CANCEL - subscription canceledThe status comment can be contained in the message field
After the payment is made, a webhook is sent with the object of this payment in the paymentEvent field. Possible values of the paymentEvent.status field:
PROCESSED - successful paymentERROR - unsuccessful paymentWhen a payment is completed, a webhook with the status of this payment (the same object as in the paymentEvent field of the webhook with the subscription status) is sent to the address specified during the payment request.
{\n \"id\": \"2fa68ddf-2479-47cb-9e66-ae91139c3063\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"billingLinkId\": \"6196a1f2-b6b5-40a5-a672-f1ffd70fdd7d\",\n \"amount\": \"0.005\",\n \"status\": \"PROCESSED\",\n \"tx\": \"0x5b9b3b55b366266025e\",\n \"createdAt\": \"2023-03-02T06:58:00.365Z\",\n \"updatedAt\": \"2023-03-02T07:01:50.693Z\"\n}\n\nPossible values for status:
PROCESSED - successful paymentERROR - unsuccessful paymentWhen the operation status changes, a webhook is sent to the address specified when the operation was created
\n{\n \"id\": \"816a19eb-be39-4eaa-9392-6fda708f24d8\",\n \"clientId\": \"...\",\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"currency\": \"USDT\",\n \"networkFrom\": \"bsc\",\n \"networkTo\": \"tron\",\n \"status\": \"PENDING\",\n \"rejectMessage\": null,\n \"addressFromId\": \"fa475cfa-15e8-c31d-7469-5f1168052cd6\",\n \"addressToId\": \"607976c9-0270-59a3-a528-0d92489c3fc8\",\n \"amount\": \"10000\",\n \"amountUSD\": \"10000\",\n \"blockchainFee\": \"1.80\",\n \"blockchainFeeUSD\": \"1.80\",\n \"serviceFeeUSD\": \"1.50\",\n \"webhookUrl\": \"https://my-show.com/...\",\n \"createdAt\": \"2022-02-02T06:07:34.067Z\"\n}\n\nAvailable statuses
\nWhen the swap status changes, a webhook is sent to the address specified when the swap was created
\n{\n \"id\": \"816a19eb-be39-4eaa-9392-6fda708f24d8\",\n \"clientId\": \"...\",\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"currencyFrom\": \"TRX\",\n \"currencyTo\": \"USDT\",\n \"networkFrom\": \"tron\",\n \"networkTo\": \"bsc\",\n \"status\": \"PENDING\",\n \"rejectMessage\": null,\n \"addressFromId\": \"fa475cfa-15e8-c31d-7469-5f1168052cd6\",\n \"addressToId\": \"607976c9-0270-59a3-a528-0d92489c3fc8\",\n \"amountFrom\": \"100000\",\n \"amountTo\": \"10000\",\n \"price\": \"0.1\",\n \"serviceBlockchainFeeSource\": \"ADDRESS\",\n \"serviceBlockchainFee\": \"1.80\",\n \"serviceBlockchainFeeUSD\": \"1.80\",\n \"providerBlockchainFeeSource\": \"AMOUNT\",\n \"providerBlockchainFee\": \"1.80\",\n \"providerBlockchainFeeUSD\": \"1.80\",\n \"serviceFeeSource\": \"ADVANCE\",\n \"serviceFee\": \"1.80\",\n \"serviceFeeUSD\": \"1.80\",\n \"webhookUrl\": \"https://my-show.com/...\",\n \"createdAt\": \"2022-02-02T06:07:34.067Z\"\n}\n\nAvailable statuses
\nWhen the payment is completed, a webhook with the status of this payment is sent to the URL depositWebhookUrl specified when creating the user.
addressId - personal address to which the deposit cameuserId - ID of the user who owns the personal address{\n \"id\": \"2fa68ddf-2479-47cb-9e66-ae91139c3063\",\n \"addressId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"userId\": \"6196a1f2-b6b5-40a5-a672-f1ffd70fdd7d\",\n \"amount\": \"0.005\",\n \"currency\": \"USDT\",\n \"network\": \"bsc\",\n \"status\": \"PROCESSED\",\n \"tx\": \"0x5b9b3b55b366266025e\",\n \"createdAt\": \"2023-03-02T06:58:00.365Z\",\n \"updatedAt\": \"2023-03-02T07:01:50.693Z\"\n}\n\nPossible values of status:
PROCESSED - successful depositПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\", \n \"clientId\": \"123321\",\n \"clientEmail\": \"test@test.com\",\n \"clientName\": \"test1\",\n \"returnUrl\": \"https://example.com\",\n \"webhookUrl\": \"https://example.com\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/create-subscriber-billing-link","description":"Make link for billing link creation.
\nAfter binding user's address to the service - a webhook will be sent to provided webhookUrl
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"d4c5a6ad-9085-427c-bb3b-7c7dd9fb447d\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/get-billing-link","description":"Get information about billing link.
\n","urlObject":{"path":["recurrents","get-billing-link"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"2dede773-4994-423c-8c77-9ab15c3328b2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"123321\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/get-billing-links-by-subscriber","description":"Get billing links through external id.
\n","urlObject":{"path":["recurrents","get-billing-links-by-subscriber"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"3836c477-7aa3-4033-ab74-daee52c4aef1","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"7650dd72-2126-4043-8ab4-dbcda85a2215\",\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/disable-subscriber-billing-link","description":"Block subscriber billing link.
\n","urlObject":{"path":["recurrents","disable-subscriber-billing-link"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"edc80ab7-e0f7-479d-97bd-cb39418ae600","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"billingLinkId\": \"d4c5a6ad-9085-427c-bb3b-7c7dd9fb447d\",\n \"title\": \"Flixnet/monthly\",\n \"description\": \"Flixnet monthly subscription / HD quality\",\n \"spendInterval\": -3,\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"webhookUrl\": \"https://site.com/webhook\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription","description":"Create subscription (periodical payments) to provided billing link.
\nYou can receive webhooks on your provided webhookUrl about subscription statuses and payments.
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"id\": \"0bdcfd8d-5b99-4a8f-8ead-1affb6bc5090\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/get-subscription","description":"Get subscription by its id.
\n","urlObject":{"path":["recurrents","get-subscription"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"c91b7780-f509-41ed-b405-51bad52e6f6a","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"id\": \"0bdcfd8d-5b99-4a8f-8ead-1affb6bc5090\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/cancel-subscription","description":"Cancel subscription by its id.
\n","urlObject":{"path":["recurrents","cancel-subscription"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"f7d1f14b-e35a-4a40-822c-7f4685b5e83e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\",\n \"billingLinkId\": \"6196a1f2-b6b5-40a5-a672-f1ffd70fdd7d\",\n \"amount\": \"0.005\",\n \"webhookUrl\": \"https://site.com/webhook\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrents/make-payment","description":"Make one-time payment with specific billing link.
\nStatus PENDING is returned in the answer. After finalization transaction you can receive a webhook on your webhookUrl provided earlier.
Here is general flow of using \"Recurrent\" methods and connecting your subscribers to the service.
\nmerchantIdwebhookUrl provided in 3rd stepFrom now on, you can use billing link by two following options:
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"currency\": \"USDT\",\n \"networkFrom\": \"bsc\",\n \"networkTo\": \"tron\",\n \"amount\": \"10000\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/bridge/fee-token","description":"The method allows you to get information about the commission for the operation
\n","urlObject":{"path":["bridge","fee-token"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"0e0fc629-5cb9-445f-8dc9-08734317183b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"clientId\": \"external system identifier to avoid duplication\",\n \"addressFromId\": \"fa475cfa-15e8-c31d-7469-5f1168052cd6\",\n \"addressToId\": \"607976c9-0270-59a3-a528-0d92489c3fc8\",\n \"feeToken\": \"...\",\n \"webhookUrl\": \"https://my-show.com/...\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/bridge/create","description":"The method allows you to initiate an asset exchange operation between networks
\nAvailable statuses
\n","urlObject":{"path":["bridge","create"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"60c1a9aa-7aed-4510-90dd-4a7704a53a72","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"816a19eb-be39-4eaa-9392-6fda708f24d8\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/bridge/get","description":"The method allows you to get information on the operation of the asset exchange between networks
\nAvailable statuses
\n","urlObject":{"path":["bridge","get"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"00b274bb-bec6-4b98-aea5-4d140292310d","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/bridge/limit","description":"Request to receive the upper/lower limit of the allowable amount for the operation. The limit is specified in USD
\n","urlObject":{"path":["bridge","limit"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"23102ec9-155d-48e5-9285-a45445e0de16","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"A crosschain bridge is an asset exchange between networks. For example, you have USDT on the Ethereum network, and you want them to be on the Tron network.
\nTo conduct an asset exchange between networks, you need to make sure that this service is available in the networks you have chosen. To do this, request list of available coins, find the coin you need, it will have a list of networks networks, make sure that the flag allowCrosschainBridge for the networks you need is set to true
Find out the allowable limit for the transaction amount. Please note that the limit amounts are indicated in USD, the rates of such stablecoins as USDT, BUSD etc do not differ significantly from the rate of USD, and if you want to exchange another coin, then you will need to get the exchange rate to USD to make sure that your amount meets the specified limits.
\nRequest fee preview to get a token, it will need to be specified when requesting transaction creation as feeToken.
The operation is not executed immediately after the request, you must wait 1-3 minutes. You can find out the operation execution status yourself, or you can specify the URL to receive the webhook in the webhookUrl field when creating.
Available statuses
\n","_postman_id":"9729a565-5820-44ac-b222-d34ad10c0ccc"},{"name":"Crosschain swap","item":[{"name":"Commission preview","id":"1eb19a91-5101-4113-9bbd-e8b91467e181","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"currencyFrom\": \"TRX\",\n \"currencyTo\": \"USDT\",\n \"networkFrom\": \"tron\",\n \"networkTo\": \"bsc\",\n \"amount\": \"10000\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/swaps/fee-token","description":"The method allows you to get information about the commission for the exchange
\nBlockchain fee charging source (serviceBlockchainFeeSource) can have 2 values ADDRESS (taken from address balance) and ADVANCE (taken from advance balance)
The provider fee for providing the service (providerBlockchainFeeSource) is always taken from the specified amount and has the value AMOUNT
The service fee for providing the service (serviceFeeSource) is taken from the advance balance and has the value ADVANCE
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"clientId\": \"идентификатор внешней системы для избежания дублирования\",\n \"addressFromId\": \"fa475cfa-15e8-c31d-7469-5f1168052cd6\",\n \"addressToId\": \"607976c9-0270-59a3-a528-0d92489c3fc8\",\n \"feeToken\": \"...\",\n \"webhookUrl\": \"https://my-show.com/...\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/swaps/create","description":"The method allows you to initiate an asset swap operation
\nAvailable statuses
\n","urlObject":{"path":["swaps","create"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"9c1fd2c6-4d86-48e9-b3d2-5f2f87d5c01e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"816a19eb-be39-4eaa-9392-6fda708f24d8\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/swaps/get","description":"The method allows you to get information on the asset swap operation
\nAvailable statuses
\n","urlObject":{"path":["swaps","get"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"9a206e8c-89d8-4d09-9130-3174f6306007","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/swaps/limit","description":"Request to receive the upper/lower limit of the allowable amount for the operation. The limit is specified in USD
\n","urlObject":{"path":["swaps","limit"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"86993820-1c4a-481e-a210-0ad95b68c3ec","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Crosschain swap is the exchange of one asset for another.
\nTo carry out an asset swap, you need to make sure that this service is available in the networks you have chosen. To do this, request list of available coins, find the coin you need, it will have a list of networks networks, make sure that the network of the asset you want to swap the allowCrosschainSwapFrom flag is wound true, and the network of the asset you want to receive has allowCrosschainSwapTo equal to true.
For example:
You have ETH in the Ethereum network, in the list of available coins you should find the ETH coin, then in the list of networks find the ethereum network it should have \"allowCrosschainSwapFrom \": true
{\n \"success\": true,\n \"response\": [\n ...\n {\n \"currency\": \"ETH\",\n ...\n \"networks\": [\n ...\n {\n \"name\": \"ethereum\",\n ...\n \"allowCrosschainSwapFrom\": true,\n ...\n }\n ...\n ]\n },\n ...\n ]\n}\n\nYou want to swap it for USDT on the Tron network, in the list of available coins you should find the USDT coin, then in the networks list, find the tron network, it should have \"allowCrosschainSwapTo\": true
{\n \"success\": true,\n \"response\": [\n ...\n {\n \"currency\": \"USDT\",\n ...\n \"networks\": [\n ...\n {\n \"name\": \"tron\",\n ...\n \"allowCrosschainSwapTo\": true,\n ...\n }\n ...\n ]\n },\n ...\n ]\n}\n\nFind out the allowable limit for the transaction amount. Please note that the limit amounts are indicated in USD, the rates of such stablecoins as USDT, BUSD etc do not differ significantly from the rate of USD, and if you want to exchange another coin, then you will need to get the exchange rate to USD to make sure that your amount meets the specified limits.
\nRequest fee preview to get a token, it will need to be specified when requesting transaction creation as feeToken.
The operation is not executed immediately after the request, you must wait 1-3 minutes. You can find out the operation execution status yourself, or you can specify the URL to receive the webhook in the webhookUrl field when creating.
Available statuses
\n","_postman_id":"c889eef1-7a0c-4c84-aedf-065bdc6a5af8"},{"name":"Personal addresses","item":[{"name":"Create user","id":"e0405f99-8a54-49fd-a08d-6d60ff965317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"123337\",\n \"clientEmail\": \"test123337@test.com\",\n \"clientName\": \"test123337\",\n \"depositWebhookUrl\": \"https://example.com/deposit/123337\",\n \"createAddresses\": true,\n \"groupByBlockchain\": true,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/personal-addresses/create-user","description":"This method provides functionality of:
\nclienId. The sent parameter values overwrite the previous data.When depositing, a webhook, is sent to the user's personal address, to the depositWebhookUrl specified in the request. When withdrawing (the common method of \"Make withdrawal\" / make-withdrawal) from a personal address, a status of this withdrawal will be in response.
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"9eec79cc-ee20-436b-acdb-78621afb3ab3\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/personal-addresses/get-user","description":"Get user data by providing its identificator (you can provide external user id as well)
\n","urlObject":{"path":["personal-addresses","get-user"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"528dce42-323e-4d64-bcb4-0023cb60b938","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"e8d8ccc4-37bd-4b44-8e4c-79997e5240fc\",\n \"currency\": \"USDT\",\n \"network\": \"tron\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/personal-addresses/get-user-address","description":"By using this method you can:
\nisActive: truerenewAddress. The new address will have isActive: true, previously generated addresses with the same coin and network will have isActive: falseNote: At any time, a user can have only one active address in particular coin and network. Deposits and withdrawals work at all addresses, regardless of the parameter isActive
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"1c98d228-652e-40ee-969b-618640ef7a4c\",\n \"isActive\": true,\n \"currency\": [\"USDT\"],\n \"network\": [\"bsc\"],\n \"balance\": {\n \"from\": \"0\",\n \"to\": \"0.5\"\n },\n \"offset\": 0,\n \"limit\": 20,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/personal-addresses/get-user-addresses","description":"The method allows you to get all the user's personal addresses. Deposits and withdrawals are available for all addresses, but the user should only see addresses with isActive: true.
Thus, if necessary, you can generate a new address for a user in a certain coin and network, then all previous addresses in this coin and network will have the parameter isActive: false (read more in the previous method \"Get/Renew personal address\")
This section allows external services to create personal addresses for their users
\n","_postman_id":"4a8a14a1-6a99-4b32-b1e3-1a1881e9d793"},{"name":"Partner API","item":[{"name":"Create user","id":"109b9959-1342-4d2f-a04f-b9717e99a351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"my@email.com\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/create-user","description":"The method allows you to create a user. If a user with such an email is already registered, the method will return the corresponding error.
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-user","description":"The method allows you to get the user
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"limit\": 1,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-users","description":"The method allows you to get all users
\nPublic key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"limit\": 1,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/create-user-organization","description":"The method allows you to get all users
\nPublic key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"a2d12df2-cd2c-4f6f-a2af-e52540f945fa\",\n \"offset\": 0,\n \"limit\": 1,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-user-organizations","description":"The method allows you to get all users
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"a2d12df2-cd2c-4f6f-a2af-e52540f945fa\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-organization-advanced-balances","description":"The method allows you to get user's advanced balances
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"advancedBalanceId\": \"ef83f386-2772-43d0-8e55-215191a9f381\",\n \"amount\": \"4.25\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/top-up-advanced-balance","description":"The method allows you to top up the user's advance balance (check the availability of the method in support)
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-default-tariffs","description":"The method allows you to get all the general rates on the service. If an individual tariff is not specified for the user, then the general tariff for all users is applied when the commission is deducted
\nThe response contains an array of tariff objects:
\nParameter action can take the following values:
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"action\": \"WALLET_DEPOSIT\",\n \"amount\": \"0.02\",\n \"minAmount\": \"0.1\",\n \"maxAmount\": \"50\",\n \"comment\": \"tariff for John\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/set-user-tariff","description":"The method allows you to create or update an individual tariff.
\nIf a tariff already exists for this userId and action, then the rest of the specified data will overwrite this tariff
The response contains an array of tariff objects:
\nParameter action can take the following values:
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-user-tariffs","description":"The method allows you to get all individual tariffs. If an individual tariff is specified for the user, the commission for the specified operation will be charged according to the individual tariff
\nThe response contains an array of tariff objects:
\nParameter action can take the following values:
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"tariffId\": \"605f43f8-6ad3-4cc9-90ae-18409e313b2f\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/delete-user-tariff","description":"The method allows you to delete an individual tariff.
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"alias\": \"Integration key\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/create-api-keys","description":"The method allows you to create an API key for the user
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"offset\": 0,\n \"limit\": 5,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/get-api-keys","description":"The method allows you to get user's API keys
\nThe keys parameter is an array of the following objects:
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"d49a143d-3fe5-4a4b-b57c-5e1b72f15df9\",\n \"organizationId\": \"a87e538d-b62b-48eb-bb47-bf3a15662f12\",\n \"keyId\": \"6ca909da-a1b7-4899-a011-21f9cffe9273\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/delete-api-keys","description":"The method allows you to delete the user's API key
\nThis section allows partners to manage their users
\n","_postman_id":"baed19d5-2ae2-4edb-b3ae-41492593d016"},{"name":"KYT","item":[{"name":"Check transaction risks","id":"94a96002-cbf4-48a4-a3a4-65b1936a1487","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-public-key","value":"Publick key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tx\": \"0xaf49223f7ebd12a0413cd26614e924231eec601a24d6ae164428de23ace0ba4f\",\n \"currency\": \"ETH\",\n \"outputAddress\": \"0x0DAe5343dee0Ec2301926D5837A8A82E6c5A257a\",\n \"direction\": \"received\",\n \"network\": \"ethereum\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/kyt/check-transfer","description":"The method allows you to check the risks of a completed transaction.
\nThis request can be executed for several seconds. It is not recommended to set timeout less than 15 seconds.
\nThe level parameter can take the following values:
white - no riskgreen - low riskyellow - medium riskred - high riskblack - severe riskPublick key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"BTC\",\n \"address\": \"bc1q4gdgnnd7l7uf46celj2mfjednhw0ugvzlnf4s8\",\n \"network\": \"bitcoin\",\n \"amount\": \"100\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/kyt/check-withdrawal-address","description":"The method allows you to check the risks of withdrawal before making it.
\nThis request can be executed for several seconds. It is not recommended to set timeout less than 15 seconds.
\nThe level parameter can take the following values:
white - no riskgreen - low riskyellow - medium riskred - high riskblack - severe riskПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"ETH\",\n \"address\": \"0xd90e2f925DA726b50C4Ed8D0Fb90Ad053324F31b\",\n \"network\": \"ethereum\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/kyt/withdrawal-address-screening","description":"Метод позволяет проверить риски вывода, перед его совершением.
\nДанный запрос может выполняться несколько секунд. Не рекомендуется ставить timeout меньше 15 секунд.
\nПараметр level может принимать следующие значения:
white - нет рискаgreen - минимальный рискyellow - средний рискred - высокий рискblack - критический рискThis section allows you to check the risks of various actions with coins.
\n","_postman_id":"04e11d68-f16e-4211-bba3-2bd52682463e"},{"name":"Orphan deposits","item":[{"name":"Get deposit by ID","id":"06331348-5325-4dae-8cf2-b91378db97c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/orphan-deposits/get-deposit","description":"The method allows you to get an orphan deposit by its ID.
\nПубличный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"orderId\": \"4db8ba00-20f8-4e3f-8292-301dd66618af\",\n \"txId\": \"0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"stage\": \"WITHDRAWAL\",\n \"status\": \"PROCESSED\",\n \"limit\": 1,\n \"offset\": 0,\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/partner/api/orphan-deposits/get-deposits","description":"The method allows you to get a list of all orphan deposits.
\nEndFragment
\nDeposits coming to addresses created for another coin or network are called orphan deposits.
\nFor example:\nYou created an order to pay 123 USDT on the BSC network, gave the payer a payment link. Instead of USDT on the BSC network, he sent USDC on the ETH network to this address. In this case, we will notify you about this deposit and you will have to decide what to do with these coins.
\nUpon receipt of an orphan deposit to the address occupied by the order in the body of the order webhook.\nIn other cases, data on the orphan's deposit will be sent to the URL specified in the organization's settings.
\nThe orphan deposit has 2 stages:\nDEPOSIT - when receiving and waiting for confirmations\nWITHDRAWAL - when creating an orphan deposit output
List of available statuses:\nPENDING - waiting for confirmations\nPROCESSED - success\nERROR - an error in the process\nREJECTED - rejected by the system
Withdrawal can be made with an orphan deposit in the DEPOSIT stage and the status PROCESSED. You can also focus on the field canWithdrawal
Orphan deposit body example:
\n{\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"organizationId\": \"1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39\",\n \"orderId\": \"4db8ba00-20f8-4e3f-8292-301dd66618af\",\n \"stage\": \"WITHDRAWAL\",\n \"status\": \"PROCESSED\",\n \"message\": null,\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.00000001\",\n \"canWithdrawal\": true,\n \"inTransaction\": {\n \"addressType\": \"PAY_IN\",\n \"addressId\": \"8519ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"outTransaction\": {\n \"withdrawalId\": \"4429ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"createdAt\": \"2023-05-30T14:10:27.283Z\"\n}\n\nPublic key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"nonce\": 1\n}"},"url":"https://ocp.onchainpay.io/api-gateway/test-signature","description":"You can test your signature in x-api-signature within this method.
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tx\": \"4d6014ee656009f154823aa15fe4ce20178b975a82b85c7db635adbc1d79b365\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/find-tx","description":"The method allows you to find an operation in the system by the address of the transaction in the blockchain
\nThe response will indicate the type of operation, the direction of the transaction, the address that was used for the operation and the body of the operation in the record from the type
\nAvailable types of operations:
\nAvailable transaction directions:
\nAddress body example:
\n{\n \"id\": \"cf95ea41-20c5-4528-b689-c21f4da6359f\", // address identifier\n \"type\": \"PAY_IN\" // address type: PAY_IN, PERSONAL, PAY_OUT, BUSINESS, RECURRENT\n}\n\nThere can be multiple entries in the result body, so the result is represented as an array:
\nResponse body example:
\n{\n \"success\": true,\n \"response\": [\n {\n \"type\": \"OUT\",\n \"source\": \"WITHDRAWAL\",\n \"address\": {\n ... // address body\n },\n \"result\": {\n ... // body for WITHDRAWAL\n }\n },\n {\n \"type\": \"IN\",\n \"source\": \"DEPOSIT\",\n \"address\": {\n ... // address body\n },\n \"result\": {\n ... // body for DEPOSIT\n }\n }\n ]\n}\n\nAn example of the body of the PERSONAL_DEPOSIT operation:
{ // body is identical to the body sent in the webhook\n \"id\": \"2fa68ddf-2479-47cb-9e66-ae91139c3063\", // personal deposit identifier\n \"addressId\": \"dcb1a9fe-4b8d-40f6-baf6-241dc88436d9\", // recipient address identifier\n \"userId\": \"6196a1f2-b6b5-40a5-a672-f1ffd70fdd7d\", // user ID in the system for which the address was created\n \"amount\": \"0.005\", // deposit amount\n \"currency\": \"USDT\", // deposit coin\n \"network\": \"bsc\", // deposit networks\n \"status\": \"PROCESSED\", // status, available values: PROCESSED\n \"tx\": \"0x5b9b3b55b366266025e...\", // blockchain transaction address\n \"createdAt\": \"2023-03-02T06:58:00.365Z\",\n \"updatedAt\": \"2023-03-02T07:01:50.693Z\"\n}\n\nAn example of a DEPOSIT operation body:
{ // body is identical to the body sent in the webhook\n \"id\": \"2fa68ddf-2479-47cb-9e66-ae91139c3063\", // record ID\n \"status\": \"processed\", // status, available values: processed, error, rejected, pending\n \"addressType\": \"BUSINESS\", // address type: PAY_IN, PERSONAL, PAY_OUT, BUSINESS, RECURRENT\n \"addressFrom\": \"0x5b9b3b55b366266025e...\", // sender address in blockchain\n \"addressTo\": \"0x3f4e3d79a244189e25e...\", // address of the recipient in the blockchain\n \"type\": \"deposit\", // operation type: withdrawal, deposit\n \"amount\": \"0.005\", // deposit amount\n \"currency\": \"USDT\", // deposit coin\n \"network\": \"bsc\", // deposit networks\n \"txId\": \"0x5b9b3b55b366266025e...\", // blockchain transaction address\n \"alias\": \"My address\", // address name specified when creating\n \"comment\": null, // operation comment\n \"createdAt\": \"2023-03-02T06:58:00.365Z\",\n \"updatedAt\": \"2023-03-02T07:01:50.693Z\"\n}\n\nAn example of a WITHDRAWAL operation body:
{ // response body is identical to the response body when receiving output data\n \"id\": \"2a2d464b-231a-baf3-6f8a-7b9dc0f8cef7\", // output identifier in the system\n \"advancedBalanceId\": \"017f444f-a6ce-487f-0f80-9777199a6ff5\", // advance balance identifier\n \"addressId\": \"5bcb11d2-cfe8-3a09-0c51-dd7be7243c5d\", // sender address identifier\n \"currency\": \"ETH\", // sending coin\n \"network\": \"ethereum\", // sending network\n \"tx\": \"0x00000000000000000000c8950e52aa3...\", // blockchain transaction address\n \"status\": \"processed\", // output status: init, error, pending, processed, rejected\n \"address\": \"0x000000000c8950e52aa315030efedc861da658e2\", // address of the recipient in the blockchain\n \"tag\": null,\n \"amount\": \"2.12345\", // withdrawal amount\n \"feeAmount\": \"0.005\", // fee amount\n \"createdAt\": \"2023-03-02T07:01:50.693Z\"\n}\n\nAn example of the body of the ORDER operation:
{ // response body is identical to the response body of the request for obtaining information about the order\n \"id\": \"d01d03e2-15dc-b03a-b34e-46cad2345b92\", // order id\n \"advancedBalanceId\": \"c6e7d8dc-ce10-637d-147b-2dda3015b8a4\", // advance balance id\n \"currency\": \"ETH\", // payment coin\n \"network\": \"etehereum\", // payment network\n \"link\": \"https://ocp.onchain...\", // payment link\n \"status\": \"processed\", // status: init, error, processed, pending, expired, partial\n \"order\": \"#123456789\",\n \"description\": \"Order #123456789\",\n \"address\": \"0x000000000c8950e52aa315030efedc861da658e2\", // address for receiving payment\n \"addressId\": \"8eae79cf-1db2-4858-9023-aca473d805e2\", // system address id\n \"tag\": null, // address tag\n \"amount\": \"0.84\", // payment amount\n \"received\": \"0.86\", // amount received\n \"transactions\": [\n {\n \"id\": \"f0b22f11-007c-4f65-bb9b-265432ab64c3\",\n \"status\": \"processed\",\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.0001\",\n \"tx\": \"0x8fb0d40678d1bb4b6c0b2095c18d9280aa8ccf966e778e6b209f4f71c7f1e835\",\n \"confirmations\": \"15\",\n \"sender\": \"0xcD62a4E08513f16F86C1c0AF0860DD6b3De1B83d\",\n \"priceUSD\": \"212.90000000\",\n \"amountUSD\": \"0.02129\"\n },\n {\n \"id\": \"a2a7ed3b-a8af-42c4-900c-d21e1d9eda3c\",\n \"status\": \"processed\",\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.0006\",\n \"tx\": \"0x60032c394fcc7a103bc2826f9b81e5086be90628331e1ce163e1c576c64baf06\",\n \"confirmations\": \"15\",\n \"sender\": \"0x54936CE809bBccC7f1378c7ec88F5504cE49605C\",\n \"priceUSD\": \"212.70000000\",\n \"amountUSD\": \"0.12762\"\n }\n ],\n \"orphanDeposits\": [\n {\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"organizationId\": \"1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39\",\n \"orderId\": \"d01d03e2-15dc-b03a-b34e-46cad2345b92\",\n \"stage\": \"WITHDRAWAL\",\n \"status\": \"PROCESSED\",\n \"message\": null,\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.00000001\",\n \"canWithdrawal\": true,\n \"inTransaction\": {\n \"addressType\": \"PAY_IN\",\n \"addressId\": \"8519ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"outTransaction\": {\n \"withdrawalId\": \"4429ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"createdAt\": \"2023-05-30T14:10:27.283Z\"\n }\n ],\n \"successWebhook\": \"https://example.com/success-webhook-url\",\n \"errorWebhook\": \"https://example.com/error-webhook-url\",\n \"returnUrl\": \"null\",\n \"expiresAt\": \"2021-05-23T15:00:00Z\",\n \"createdAt\": \"2021-05-23T15:00:00Z\",\n \"updatedAt\": \"2021-05-23T15:00:00Z\"\n}\n\nAn example of the body of the INVOICE operation:
{ // response body is identical to the response body of the request for obtaining account data\n \"id\": \"fe31e1f3-bd23-4c89-bced-7fecc60cbb34\", // Account ID\n \"advancedBalanceId\": \"1cabe6ba-52b8-42bf-88a4-b3c953c3fd36\", // advance balance ID\n \"orderId\": \"ae31e1f3-bd23-4c89-bced-7fecc60cbb31\", //Order ID (before the INIT status will be null)\n \"orderLink\": \"https://ocp.onchainpay.io/...\", // order link (before INIT status will be null)\n \"invoiceLink\": \"https://ocp.onchainpay.io/...\", // invoice link\n \"status\": \"PENDING\", // account status (CREATED - created, INIT - coin selected for payment, PENDING - user made a transaction, PROCESSED - paid, PARTIAL - partial payment, ERROR - error, EXPIRED - account has expired)\n \"order\": \"Order #1234\",\n \"description\": \"Buy 1 Bitcoin\",\n \"currency\": \"USD\",\n \"amount\": \"3000\",\n \"receivedCurrency\": \"USDT\", // selected coin for payment (before INIT status will be null)\n \"receivedAmount\": \"123\", // amount received\n \"includeFee\": true,\n \"insurancePercent\": \"2\",\n \"slippagePercent\": \"3.5\",\n \"webhookURL\": \"https://my-shop.com/api/webhooks\",\n \"returnURL\": \"https://my-shop.com/\",\n \"currencies\": [\n {\n \"currency\": \"USDT\",\n \"networks\": [\n {\n \"name\": \"tron\",\n \"amount\": \"3030.123\" // final amount payable for USDT on the tron network\n },\n {\n \"name\": \"bsc\",\n \"amount\": \"3030.123\"\n }\n ]\n }\n ],\n \"expiresAt\": \"2022-12-16T08:36:38.130Z\",\n \"createdAt\": \"2022-12-16T07:36:38.130Z\"\n}\n\nAn example of the body of the ORPHAN_DEPOSIT operation:
{ // response body is identical to the response body of the request to receive deposit data\n \"id\": \"7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1\",\n \"organizationId\": \"1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39\",\n \"orderId\": \"4db8ba00-20f8-4e3f-8292-301dd66618af\",\n \"stage\": \"WITHDRAWAL\",\n \"status\": \"PROCESSED\",\n \"message\": null,\n \"currency\": \"BNB\",\n \"network\": \"bsc\",\n \"amount\": \"0.00000001\",\n \"canWithdrawal\": true,\n \"inTransaction\": {\n \"addressType\": \"PAY_IN\",\n \"addressId\": \"8519ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"outTransaction\": {\n \"withdrawalId\": \"4429ba89-68d5-4914-9a0f-d99e77dc88ea\",\n \"address\": \"0x68f8a74b5fD0b687369536607214acfA3b1572Ff\",\n \"txId\": \"0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362\",\n \"amount\": \"0.00000001\",\n \"status\": \"processed\",\n \"createdAt\": \"2023-05-30T14:10:27.276Z\"\n },\n \"createdAt\": \"2023-05-30T14:10:27.283Z\"\n}\n\nPublic key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}"},"url":"https://ocp.onchainpay.io/api-gateway/available-currencies","description":"Get list of available currencies for depositing/withdrawing
\n","urlObject":{"path":["available-currencies"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"ad028dfa-dfb3-41da-a88f-b4bc6b3304dc","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}"},"url":"https://ocp.onchainpay.io/api-gateway/advanced-balances","description":"Get list of advanced balances of user
\n","urlObject":{"path":["advanced-balances"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"691ab21a-e18d-4d5e-9eae-335d00771d33","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/advanced-balance","description":"Get info about advanced balance by its id
\n","urlObject":{"path":["advanced-balance"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"820cb987-f876-4725-8d1b-15d466ea5aaa","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"network\": \"tron\",\n \"currency\": \"USDT\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/advanced-balance-deposit-address","description":"Get payment address for deposit to your advanced balance
\n","urlObject":{"path":["advanced-balance-deposit-address"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"e20139b9-7334-4b0e-9684-bc11430bcd17","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/account-addresses","description":"Get list with info about balances of addresses
\n","urlObject":{"path":["account-addresses"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"abbe699f-f4d4-4171-8b99-3b64d033089b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"network\": \"tron\",\n \"currency\": \"USDT\",\n \"alias\": \"Main\",\n \"comment\": \"My main address\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/business-address","description":"The method allows you to create business addresses in this account.
\n","urlObject":{"path":["business-address"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"5662c2fd-e287-473a-9647-b6ce2adedabe","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"<Напишите свой публичный ключ>","description":"Публичный ключ","type":"text"},{"key":"x-api-signature","value":"<подпись (не используйте это поле)>","description":"Подпись запроса","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"network\": \"tron\",\n \"currency\": \"USDT\",\n \"alias\": \"Main\",\n \"comment\": \"My main address\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/business-address"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"response\": {\n \"id\": \"9ede7ed6-570e-40b2-851e-264607981131\",\n \"currency\": \"USDT\",\n \"network\": \"tron\",\n \"address\": \"TRMDELhFonKarCBwz6wjr7VKg6hDPGRxwZ\",\n \"tag\": null,\n \"alias\": \"Main\",\n \"comment\": \"My main address\"\n }\n}"}],"_postman_id":"f07eff42-0a2b-42f0-9c3d-3809cb177f98"},{"name":"Get business addresses","id":"d2464b1d-5ba0-4f37-bfc6-8f13de92fca8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/business-addresses","description":"The method allows you to get business addresses and their balances for this account.
\n","urlObject":{"path":["business-addresses"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"15de7208-bbc3-4618-9dfd-02427379eeb8","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"<Напишите свой публичный ключ>","description":"Публичный ключ","type":"text"},{"key":"x-api-signature","value":"<подпись (не используйте это поле)>","description":"Подпись запроса","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"20ae341d-79a3-1363-eb50-d6b16d8da33b\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/business-addresses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"response\": [\n {\n \"id\": \"d4e24f64-4834-4cee-a473-4b33317b9521\",\n \"advancedBalanceId\": \"20ae341d-79a3-1363-eb50-d6b16d8da33b\",\n \"currency\": \"USDT\",\n \"network\": \"bsc\",\n \"address\": \"0xb2bf61BDF1e795D307CE16848aeBE94943D0a0Ba\",\n \"tag\": \"\",\n \"balance\": \"0\",\n \"alias\": \"test\",\n \"comment\": \"test\"\n }\n ]\n}"}],"_postman_id":"d2464b1d-5ba0-4f37-bfc6-8f13de92fca8"},{"name":"Get recurrent addresses","id":"f75e5823-6b03-4059-af22-27bfe94b6653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrent-addresses","description":"The method allows you to get recurrent addresses and their balances for this account.
\n","urlObject":{"path":["recurrent-addresses"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"b6641a37-137b-4abd-8b66-cae5bec60603","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"<Напишите свой публичный ключ>","description":"Публичный ключ","type":"text"},{"key":"x-api-signature","value":"<подпись (не используйте это поле)>","description":"Подпись запроса","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/recurrent-addresses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"response\": [\n {\n \"id\": \"d4e24f64-4834-4cee-a473-4b33317b9521\",\n \"advancedBalanceId\": \"20ae341d-79a3-1363-eb50-d6b16d8da33b\",\n \"currency\": \"USDT\",\n \"network\": \"bsc\",\n \"address\": \"0xb2bf61BDF1e795D307CE16848aeBE94943D0a0Ba\",\n \"tag\": \"\",\n \"balance\": \"0\",\n \"alias\": \"test\",\n \"comment\": \"test\"\n }\n ]\n}"}],"_postman_id":"f75e5823-6b03-4059-af22-27bfe94b6653"},{"name":"Get payout address","id":"5e6d68f1-ee8c-45b2-90fa-116aa0b4b620","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USDT\",\n \"network\": \"bsc\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/payout-address","description":"The method allows you to get a payout address in the specified coin and network.
\n","urlObject":{"path":["payout-address"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"0887e2e6-0a29-4b34-8892-7bf0604b442b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/payout-balances","description":"The method allows you to get all the payout balances on this account.
\n","urlObject":{"path":["payout-balances"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"4ea05006-d0b5-47a2-ae77-b111b237b4b7","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"currency\": \"ETH\",\n \"network\": \"ethereum\",\n \"amount\": \"0.84\",\n \"order\": \"#123456789\",\n \"lifetime\": 43200,\n \"description\": \"Order #123456789\",\n \"successWebhook\": \"https://example.com/success-webhook-url\",\n \"errorWebhook\": \"https://example.com/error-webhook-url\",\n \"returnUrl\": \"https://example.com/\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/make-order","description":"Create order and get address for payments
\nTo explicitly specify the theme of the page or language, you can specify the query parameters theme to specify the theme, and lang to specify the language
\nAvailable themes: dark,light
Available languages for the following countries:ru - Russiaen - Englandkr - Korealv - Latvialt - Lithuaniade - Germanypl - Polandtp - Portugaltr - Türkiyeua - Ukrainefi - Finlandfr - Franceee - Estoniajp - Japanbg - Bulgariagr - Greecees - Spainit - Italycn - Chinabn - Bangladesh
Example:https://pay.onchainpay.io/316a59ea-be39-4eaa-9392-6fda708f24d8?theme=light&lang=en?theme=light&lang=en - query parameterstheme=light - themelang=en - language
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"7650dd72-2126-4043-8ab4-dbcda85a2215\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/order","description":"Get information about order
\n","urlObject":{"path":["order"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"1c9e3830-31e5-4d89-96e5-f9e6af4fed56","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"limit\": 10,\n \"status\": [\"processed\"],\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/orders","description":"Get all orders.
\nArray status can contain following values: init, error, processed, pending, refund, expired, partial
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"316a59ea-be39-4eaa-9392-6fda708f24d8\",\n \"addressId\": \"77d8e55c-86ad-4f5b-81ff-1ff3580b31b8\",\n \"amount\": \"1.5\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/fee-token","description":"You should fetch withdrawal fee amount before actual withdrawal and use token parameter
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"3f840884-2a80-1395-4650-80ebf3eb169a\",\n \"addressId\": \"151d4e81-1e0c-c2fc-f682-6d988310d598\",\n \"address\": \"0x000000000c8950e52aa315030efedc861da658e2\",\n \"amount\": \"2.12345\",\n \"feeToken\": \"U2FsdGVkX1+WRN3rqgcenyQXTL+QxDym5VbGP/QU46wtFfX62CIgjfwTb2OltZ05xuANV2vAn1CCVhQiyJjoM7WXOhGKFwIJl3Wk7fuF4LY7xgMaqEPJXIJNNw2tzvf9jl6nWVpP+B3Nqoa+pGP3mK8g6uxIxOlv2y2UsE4e/Efk61XKowoIiBW3aIyrm792Ae5+hp8QAOneysVPkMslh17q06Dp2vUzn4cEZrqtQYlpBlulnbbSXBEN/V01PBsaxfuwk7O2OjztcWbNR6WYmuAO3Ux22CHizzqeOKamBvkljINKFUynpvP3+gUeVCoVAN1xbziZeot6JraNjPtFkNbzIqyvowy0Im4nw8wYABel9sLRKMjRiD17oBYuCnFo/ZO9ERcu5hviLNUCWmvXZGM8KI2rWCdYxiaENnHM2DjmqY3sHpu5EUsoW7+YvrYxf3igCn3ifRztxD0vsYScwc8bwRxyjLIoQw4KLWXpZeloJcPjn7AEl/pGE0eCrBmIxeLW/T57U1MZW3fj+LTrY3fjrq8eRtYMwfJ9jyIq46wCDo2yFdQQnQ/+DWtW7LzV\",\n \"tag\": \"exercitation magn\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/make-withdrawal","description":"Make withdrawal from address balance. You need to pass feeToken parameter from previous method (Get withdrawal fee)
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"3f840884-2a80-1395-4650-80ebf3eb169a\",\n \"addressId\": \"151d4e81-1e0c-c2fc-f682-6d988310d598\",\n \"address\": \"0x000000000c8950e52aa315030efedc861da658e2\",\n \"amount\": \"2.12345\",\n \"feeToken\": \"U2FsdGVkX1+WRN3rqgcenyQXTL+QxDym5VbGP/QU46wtFfX62CIgjfwTb2OltZ05xuANV2vAn1CCVhQiyJjoM7WXOhGKFwIJl3Wk7fuF4LY7xgMaqEPJXIJNNw2tzvf9jl6nWVpP+B3Nqoa+pGP3mK8g6uxIxOlv2y2UsE4e/Efk61XKowoIiBW3aIyrm792Ae5+hp8QAOneysVPkMslh17q06Dp2vUzn4cEZrqtQYlpBlulnbbSXBEN/V01PBsaxfuwk7O2OjztcWbNR6WYmuAO3Ux22CHizzqeOKamBvkljINKFUynpvP3+gUeVCoVAN1xbziZeot6JraNjPtFkNbzIqyvowy0Im4nw8wYABel9sLRKMjRiD17oBYuCnFo/ZO9ERcu5hviLNUCWmvXZGM8KI2rWCdYxiaENnHM2DjmqY3sHpu5EUsoW7+YvrYxf3igCn3ifRztxD0vsYScwc8bwRxyjLIoQw4KLWXpZeloJcPjn7AEl/pGE0eCrBmIxeLW/T57U1MZW3fj+LTrY3fjrq8eRtYMwfJ9jyIq46wCDo2yFdQQnQ/+DWtW7LzV\",\n \"webhookUrl\": \"https://ij.je/http/201323005?dev_withdraw\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/make-withdrawal-async","description":"Make withdrawal from address balance. You need to pass feeToken parameter from previous method (Get withdrawal fee)
Unlike the usual withdrawal method, the withdrawal status can only be PENDING in the response. After the transaction is completed in the blockchain, the withdrawal status will be updated to PROCESSED (or ERROR in case of any error). After receiving one of the final statuses, a webhook will be sent to the webhookUrl specified in the initial request
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"withdrawalId\": \"3f840884-2a80-1395-4650-80ebf3eb169a\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/get-withdrawal","description":"The method allows you to obtain information on a previously made conclusion
\n","urlObject":{"path":["get-withdrawal"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"a4b2e68a-5f1b-4a86-8382-f0e6caabbbcb","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advancedBalanceId\": \"1cabe6ba-52b8-42bf-88a4-b3c953c3fd36\", // ID авансового баланса\n \"order\": \"Order #1234\", // Идентификатор платежа во внешней системе\n \"description\": \"Buy 1 Bitcoin\", // Описание платежа\n \"currency\": \"USD\", // Валюта счета\n \"amount\": \"3000\", // Сумма счета \n \"includeFee\": true, // Включать комиссию сети в конечную сумму оплаты\n \"insurancePercent\": \"2\", // Можете указать свой процент к конечной сумме оплаты\n // Это параметр отвечает за процент проскальзывания конечной суммы оплаты от текущего курса\n // При переходе по ссылке счета пользователю будут показаны конечные суммы в выбранных монетах/сетях\n // если за время выбора пользователем монеты/сети для оплаты курс измениться больше процента, который\n // вы указали в этом параметрке, то сумма будет пересчитана по текущему курсу\n \"slippagePercent\": \"3.5\",\n \"webhookURL\": \"https://my-shop.com/api/webhooks\", // Ссылка для отправки вебхуков об изменении статуса счета\n \"returnURL\": \"https://my-shop.com/\", // Ссылка для возврата обратно в магазин\n \"lifetime\": 60, // время жизни счета (не ордера) в минутах\n \"currencies\": [ // Список доступных для оплаты монет/сетей\n [\"USDT\", \"bsc\"], // Указываются в формате [CURRENCY, NETWORK]\n [\"USDT\", \"tron\"],\n [\"BTC\", \"bitcoin\"]\n ],\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/make-invoice","description":"The method allows you to issue an invoice for payment.
\nTo explicitly specify the theme of the page or language, you can specify the query parameters theme to specify the theme, and lang to specify the language
\nAvailable themes: dark,light
Available languages for the following countries:ru - Russiaen - Englandkr - Korealv - Latvialt - Lithuaniade - Germanypl - Polandtp - Portugaltr - Türkiyeua - Ukrainefi - Finlandfr - Franceee - Estoniajp - Japanbg - Bulgariagr - Greecees - Spainit - Italycn - Chinabn - Bangladesh
Example:https://invoice.onchainpay.io/316a59ea-be39-4eaa-9392-6fda708f24d8?theme=light&lang=en?theme=light&lang=en - query parameterstheme=light - themelang=en - language
Публичный ключ
\n","type":"text"},{"key":"x-api-signature","value":"Подпись запроса
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceId\": \"abbee03a-e54a-4568-9023-d266e1eb76ef\", \n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/get-invoice","description":"The method allows you to get information about the invoice.
\n","urlObject":{"path":["get-invoice"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"0220b660-2b2e-4745-a3de-23b88d928464","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"<Напишите свой публичный ключ>","description":"Публичный ключ","type":"text"},{"key":"x-api-signature","value":"<подпись>","description":"Подпись запроса","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceId\": \"fe31e1f3-bd23-4c89-bced-7fecc60cbb34\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/get-invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"response\": {\n \"id\": \"fe31e1f3-bd23-4c89-bced-7fecc60cbb34\", // Invoice ID\n \"advancedBalanceId\": \"1cabe6ba-52b8-42bf-88a4-b3c953c3fd36\", // Advanced balance ID\n \"orderId\": \"ae31e1f3-bd23-4c89-bced-7fecc60cbb31\", // Order ID (before INIT status will be null)\n \"orderLink\": \"https://ocp.onchainpay.io/...\", // order link (before INIT status will be null)\n \"invoiceLink\": \"https://ocp.onchainpay.io/...\", // invoice link\n \"status\": \"PENDING\", // invoice status (CREATED - created, INIT - coin selected for payment, PENDING - user send a transaction, PROCESSED - paid, PARTIAL - partial payment, ERROR - error, EXPIRED - invoice expired)\n \"order\": \"Order #1234\",\n \"description\": \"Buy 1 Bitcoin\",\n \"currency\": \"USD\",\n \"amount\": \"3000\",\n \"receivedCurrency\": \"USDT\", // selected coin for payment (before INIT status will be null)\n \"receivedAmount\": \"123\", // amount received\n \"includeFee\": true,\n \"insurancePercent\": \"2\",\n \"slippagePercent\": \"3.5\",\n \"webhookURL\": \"https://my-shop.com/api/webhooks\",\n \"returnURL\": \"https://my-shop.com/\",\n \"currencies\": [\n {\n \"currency\": \"USDT\",\n \"networks\": [\n {\n \"name\": \"tron\",\n \"amount\": \"3030.123\" // final amount payable for USDT on the tron network\n },\n {\n \"name\": \"bsc\",\n \"amount\": \"3030.123\"\n }\n ]\n }\n ],\n \"expiresAt\": \"2022-12-16T08:36:38.130Z\",\n \"createdAt\": \"2022-12-16T07:36:38.130Z\"\n }\n}"},{"id":"5db5cb01-be3c-4744-a44b-8b76853df20a","name":"Get invoice information","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"limit\": 10,\n \"status\": [\"INIT\"],\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/get-invoices","description":"Get all invoices.
\nArray status can contain following values: CREATED, REJECTED, INIT, PROCESSED, PENDING, PARTIAL, EXPIRED
Public key
\n","type":"text"},{"key":"x-api-signature","value":"Signature
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"from\": \"ETH\",\n \"to\": \"USDT\",\n \"nonce\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://ocp.onchainpay.io/api-gateway/price-rate","description":"Get price rate from one currency to another
\n","urlObject":{"path":["price-rate"],"host":["https://ocp.onchainpay.io/api-gateway"],"query":[],"variable":[]}},"response":[{"id":"af364042-623e-4e2e-b1fe-eb0239e007b0","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"x-api-public-key","value":"