{ "openapi": "3.0.4", "info": { "title": "CryptoCoin API", "description": "This API allows you to create and track cryptocurrency transactions, including sending and receiving funds via the blockchain, as well as checking the balance of each cryptocurrency.\r\n
\r\n

✅ Features

\r\n

Create Authentication Token: Get an Authentication Token (this token guarantees anonymity, only it will be used for authentications)
Cryptocurrency Balance: Get the balance of a specific cryptocurrency or all cryptocurrencies
Tickers List: Get the list of tickers from the api.
Ticker information: Get more specific information from a ticker.
Create Transaction (IN/OUT): Creates a new crypto transaction to SEND/RECEIVE funds.
Payment QR code: Get the payment QR code in base64 or embeddable HTML.
Get wallet address for payment: Get the wallet address that the client must use to send funds.
Transaction Status: Return the current status of the transaction, the object is the same used for webhook.
Webhooks List: Get the list of registered webhooks.
Create Webhook: Create a webhook to get notified.
Delete Webhook: Delete a webhook.

\r\n

🪙 Supported Cryptocurrencies

\r\n

\r\n\r\n

\r\n

\r\n\r\n

\r\n

\r\n\r\n

\r\n

\r\n\r\n

\r\n

\r\n\r\n

", "contact": { "name": "Customer & Technical Support (contact@criptocoinapi.com)", "email": "contact@criptocoinapi.com" }, "version": "v1.0" }, "paths": { "/v1/ApiToken/Create": { "post": { "tags": [ "ApiToken" ], "summary": "Create Authentication Token", "description": "Create an Authentication Token (this token guarantees anonymity, only it will be used for authentications)", "responses": { "200": { "description": "Returns an authentication token (string) with no expiration" } } } }, "/v1/CryptoCurrency/ListTickers": { "get": { "tags": [ "CryptoCurrency" ], "summary": "Tickers List", "description": "Get the list of tickers from the api.", "responses": { "200": { "description": "Returns the list of api tickers." } } } }, "/v1/CryptoCurrency/GetInfo": { "get": { "tags": [ "CryptoCurrency" ], "summary": "Ticker information", "description": "Get more specific information from a ticker.", "parameters": [ { "name": "ticker", "in": "query", "description": "Cryptocurrency ticker to grab information (e.g. BTC, ERC20-ETH, BEP20-USDT).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the most specific information about a ticker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TickerInfoDTO" }, "example": {"ticker":"BTC","logoUrl":"https://logo.webp","usdPrice":0.0,"fixedCoinTax":0.0,"percentTax":0.0,"minimumCoinAmountTransaction":0.0,"miniumBlockchainConfirmations":0.0} } } } } } }, "/v1/CryptoCurrency/GetBalance": { "get": { "tags": [ "CryptoCurrency" ], "summary": "Cryptocurrency Balance", "description": "Get the balance of a specific cryptocurrency or all cryptocurrencies", "parameters": [ { "name": "ticker", "in": "query", "description": "Cryptocurrency ticker (e.g. \"BTC\", \"ERC20-ETH\", \"BEP20-BNB\"..), if the field is empty, it will return the balance of all cryptocurrencies", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the balance of the chosen cryptocurrency in \"ticker\"", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "example": {"BTC":0.001} } } } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Transaction/Create": { "post": { "tags": [ "Transaction" ], "summary": "Create Transaction (IN/OUT)", "description": "Creates a new crypto transaction to SEND/RECEIVE funds.", "requestBody": { "description": "Details of the parameters for creating a transaction", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTransactionDataDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionDataDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionDataDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTransactionDataDTO" } } } }, "responses": { "200": { "description": "Returns information about the new transaction created successfully!", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionResultDTO" }, "example": {"id":"0d565576-29d4-4218-b47f-c1542520a91a","trackId":"","coinAmount":1000.0,"registerDateUtc":"0001-01-01T00:00:00","paymentCode":"address_wallet","paymentQrCode":"iVBORw0KGgoAAAANSUhEUgAAA=="} } } } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Transaction/GetQrCode": { "get": { "tags": [ "Transaction" ], "summary": "Payment QR code", "description": "Get the payment QR code in base64 or embeddable HTML", "parameters": [ { "name": "Id", "in": "query", "description": "Internal transaction ID.", "schema": { "type": "string" } }, { "name": "trackId", "in": "query", "description": "Transaction tracking ID provided by the API consumer (optional).", "schema": { "type": "string" } }, { "name": "rawBase64", "in": "query", "description": "true: returns QR code as a base64 image. False/null: returns HTML for rendering.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Returns the QR code string in base64 (\"rawBase64\": true) or embeddable HTML" } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Transaction/GetPaymentAddress": { "get": { "tags": [ "Transaction" ], "summary": "Get wallet address for payment", "description": "Get the wallet address that the client must use to send funds.", "parameters": [ { "name": "Id", "in": "query", "description": "Internal transaction ID.", "schema": { "type": "string" } }, { "name": "trackId", "in": "query", "description": "Transaction tracking ID provided by the API consumer (optional).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns wallet address (string)." } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Transaction/Status": { "get": { "tags": [ "Transaction" ], "summary": "Transaction Status", "description": "Return the current status of the transaction, the object is the same used for webhook", "parameters": [ { "name": "Id", "in": "query", "description": "Internal transaction ID.", "schema": { "type": "string" } }, { "name": "trackId", "in": "query", "description": "Transaction tracking ID provided by the API consumer (optional).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return true if completed, false otherwise.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionStatusDTO" }, "example": {"trackId":"052ba3c7-f61d-4e9e-a0e8-0647fff5ee96","transactionId":"76e4cbcf-c875-4a22-91dd-0577c90ec306","completeDatetimeUtc":"2025-06-18T20:02:45.2017251Z","cancelDatetimeUtc":"2025-06-18T20:02:45.2017254Z","receivedCoinAmount":0.0,"transactionDirection":"IN","destinationAddress":"0x123..","paymentAddress":"0x123","sourceAddress":null,"coinTicker":"btc","usdFiatValue":0.0,"blockchainConfirmations":0,"eventType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusDTO" }, "example": {"trackId":"052ba3c7-f61d-4e9e-a0e8-0647fff5ee96","transactionId":"76e4cbcf-c875-4a22-91dd-0577c90ec306","completeDatetimeUtc":"2025-06-18T20:02:45.2017251Z","cancelDatetimeUtc":"2025-06-18T20:02:45.2017254Z","receivedCoinAmount":0.0,"transactionDirection":"IN","destinationAddress":"0x123..","paymentAddress":"0x123","sourceAddress":null,"coinTicker":"btc","usdFiatValue":0.0,"blockchainConfirmations":0,"eventType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusDTO" }, "example": {"trackId":"052ba3c7-f61d-4e9e-a0e8-0647fff5ee96","transactionId":"76e4cbcf-c875-4a22-91dd-0577c90ec306","completeDatetimeUtc":"2025-06-18T20:02:45.2017251Z","cancelDatetimeUtc":"2025-06-18T20:02:45.2017254Z","receivedCoinAmount":0.0,"transactionDirection":"IN","destinationAddress":"0x123..","paymentAddress":"0x123","sourceAddress":null,"coinTicker":"btc","usdFiatValue":0.0,"blockchainConfirmations":0,"eventType":0} } } } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Webhook/List": { "get": { "tags": [ "Webhook" ], "summary": "Webhooks List", "description": "Get the list of registered webhooks.", "responses": { "200": { "description": "Return the list of registered webhooks." } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Webhook/Create": { "post": { "tags": [ "Webhook" ], "summary": "Create Webhook", "description": "Create a webhook to get notified, we will send a POST request passing\nthe object TransactionStatusDTO in body, with content type as application/json.\nThe request will be sended always the transaction information status update", "parameters": [ { "name": "url", "in": "query", "description": "Webhook to be notified", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook created successfully!" } }, "security": [ { "CustomToken": [ ] } ] } }, "/v1/Webhook/Delete": { "delete": { "tags": [ "Webhook" ], "summary": "Delete Webhook", "description": "Delete a webhook", "parameters": [ { "name": "url", "in": "query", "description": "Webhook to be deleted", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook deleted successfully!" } }, "security": [ { "CustomToken": [ ] } ] } } }, "components": { "schemas": { "CreateTransactionDataDTO": { "required": [ "coinAmount", "isOut", "ticker" ], "type": "object", "properties": { "trackId": { "type": "string", "description": "Transaction tracking ID provided by the API consumer", "nullable": true }, "ticker": { "type": "string", "description": "Ticker of the cryptocurrency to be used (e.g., BTC, ERC20-ETH, BEP20-USDT).", "nullable": true }, "coinAmount": { "type": "number", "description": "Amount of the cryptocurrency to send or receive.\nValue must be in coin units (e.g., 0.002 BTC, not satoshis).", "format": "double" }, "isOut": { "type": "boolean", "description": "Direction of the transaction: true to send funds (outgoing), false to receive (incoming)." }, "destinationWalletAddress": { "type": "string", "description": "This field defines where the coins should go and is used for both \"IN\" (incoming) and \"OUT\" (outgoing) transactions.\n\n🔁 For \"OUT\" transactions (sending funds):\nYou are sending coins to another wallet address.\nThe amount will be deducted from your available coin balance associated with your API token.\nIn this case, DestinationWalletAddress must be the recipient wallet address — where you want the coins to be sent.\n\n🔁 For \"IN\" transactions (receiving funds):\nYou are receiving coins into the system’s payment wallet (e.g., a customer payment).\nOnce the funds are received, the DestinationWalletAddress determines how they are handled:\n\nIf you provide an address: The system will automatically forward the received coins to your wallet.\n\nIf left as null: The system will credit the amount to your API token balance. You can then create a separate \"OUT\" transaction later to send the funds to any wallet you choose.", "nullable": true } }, "additionalProperties": false, "description": "Data Transfer Object for creating a cryptocurrency transaction." }, "CreateTransactionResultDTO": { "type": "object", "properties": { "id": { "type": "string", "description": "New transaction ID", "format": "uuid", "nullable": true }, "trackId": { "type": "string", "description": "Transaction tracking ID provided by the API consumer", "nullable": true }, "coinAmount": { "type": "number", "description": "Transaction value", "format": "double", "nullable": true }, "registerDateUtc": { "type": "string", "description": "Transaction date", "format": "date-time", "nullable": true }, "paymentCode": { "type": "string", "description": "Wallet address to pay", "nullable": true }, "paymentQrCode": { "type": "string", "description": "QR Code image in base64", "nullable": true } }, "additionalProperties": false, "description": "Data Transfer Object for creating a cryptocurrency transaction." }, "TickerInfoDTO": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The unique identifier or symbol of the cryptocurrency (e.g., \"BTC\", \"ERC20-ETH\", \"BEP20-USDT\").", "nullable": true }, "logoUrl": { "type": "string", "description": "A URL or relative path pointing to the logo image associated with this ticker.", "nullable": true }, "usdPrice": { "type": "number", "description": "The current market price of the cryptocurrency, denominated in USD.", "format": "double", "nullable": true }, "fixedCoinTax": { "type": "number", "description": "A fixed transaction fee denominated in the native cryptocurrency.", "format": "double", "nullable": true }, "percentTax": { "type": "number", "description": "A variable transaction fee represented as a percentage of the transaction amount.", "format": "double", "nullable": true }, "minimumCoinAmountTransaction": { "type": "number", "description": "The minimum amount of this cryptocurrency required to initiate a transaction.", "format": "double", "nullable": true }, "miniumBlockchainConfirmations": { "type": "number", "description": "The minimum number of blockchain confirmations required before a transaction is considered valid.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Represents metadata and configuration details for a specific cryptocurrency ticker used within the payment gateway." }, "TransactionStatusDTO": { "required": [ "transactionId" ], "type": "object", "properties": { "trackId": { "type": "string", "description": "(Optional) Internal tracking ID defined by your system when the transaction was created.\nHelps correlate this webhook with your internal order or payment references.", "nullable": true }, "transactionId": { "type": "string", "description": "(Required) The unique identifier of the transaction within the CryptoCoin API system.\nUse this ID to query transaction details via the API if needed.", "nullable": true }, "completeDatetimeUtc": { "type": "string", "description": "The UTC date and time when the transaction was successfully confirmed on the blockchain.\nWill be null if the transaction is still pending or failed.", "format": "date-time", "nullable": true }, "cancelDatetimeUtc": { "type": "string", "description": "The UTC date and time when the transaction was cancelled or expired.\nWill be null if the transaction was not cancelled.", "format": "date-time", "nullable": true }, "receivedCoinAmount": { "type": "number", "description": "The total amount of cryptocurrency received (or sent) in this transaction.\nDenominated in the native unit of the coin (e.g., BTC, ETH, USDT).", "format": "double" }, "transactionDirection": { "type": "string", "description": "Indicates the direction of the transaction:\n`IN` for incoming payments or deposits,\n`OUT` for outgoing transfers initiated by your API token.", "nullable": true }, "destinationAddress": { "type": "string", "description": "The wallet address that received the funds (for OUT transactions),\nor the address where the system forwarded the funds (for IN with destination).", "nullable": true }, "paymentAddress": { "type": "string", "description": "The wallet address that receive the payment in case of transaction type is \"IN\"", "nullable": true }, "sourceAddress": { "type": "string", "description": "The wallet address that sent the funds (usually applicable for IN transactions).\nUseful for identifying the source of a deposit.", "nullable": true }, "coinTicker": { "type": "string", "description": "Ticker of the cryptocurrency involved (e.g., BTC, ERC20-ETH, BEP20-USDT).", "nullable": true }, "usdFiatValue": { "type": "number", "description": "Estimated american USD fiat value of the transaction at the time of execution.\nThis can be used for accounting or analytics purposes.", "format": "double", "nullable": true }, "blockchainConfirmations": { "type": "integer", "description": "Number of blockchain confirmations at the moment this webhook was triggered.", "format": "int32" }, "eventType": { "$ref": "#/components/schemas/WebhookOrQueryEventType" } }, "additionalProperties": false, "description": "Represents the payload sent by the system when the status of a blockchain transaction changes.\nThis webhook is triggered for both incoming and outgoing transactions,\nproviding full context and useful metadata for your application." }, "WebhookOrQueryEventType": { "enum": [ 0 ], "type": "integer", "format": "int32" } }, "securitySchemes": { "CustomToken": { "type": "apiKey", "description": "Custom scheme API key for authentication", "name": "Authorization", "in": "header" } } } }

✅​ Features

🪙 Supported Cryptocurrencies

✅ Features