CryptoMate

Introduction

Authentication

Errors

Management

Clients

Operations

Blockchains

Keys

Credentials

Configurations

Contracted products

Treasury

Accounts

Wallets

Tokens

Virtual Wallets

Holding

Configuration

Cards

Virtual Cards

Account

Transactions

Webhooks

Events

Simulate

API Layer

Production

Sandbox

Let us introduce you to the revolutionary world of CryptoMate APIs, a gateway to effortless global transactions. In this era of rapid technological advancement, harnessing the power of Blockchain technology has never been simpler. With CryptoMate APIs, you can unlock the true potential of this transformative technology while keeping your focus unwaveringly on providing an exceptional customer experience.Picture this: you have the opportunity to craft incredible applications in an astonishingly short span of time, all thanks to our groundbreaking APIs. Let me walk you through some captivating examples:Imagine seamlessly integrating crypto assets into your fintech wallet. With our ingenious MPC module, managing diverse wallets across different blockchains becomes as intuitive as invoking just two APIs. Yes, you heard that right - two APIs stand between you and an enhanced financial ecosystem.Or consider this: sending your customers NFTs as part of a loyalty program, with the ability to effortlessly track every intricate movement. This seemingly complex task becomes a breeze with our Media NFT module, requiring just two APIs. Loyalty meets simplicity.And for those seeking to embrace the future of commerce, imagine accepting crypto payments with unparalleled ease - a reality achieved by invoking a single API through our Payment module. This single act bridges the gap between traditional and digital currency transactions.Before embarking on your journey to integrate our API marvels, there's a crucial step: obtaining an API key. This key serves as a digital seal of authenticity, safeguarding your requests and ensuring a secure gateway to our suite of services. Obtaining it is as simple as signing up on our website, where possibilities await.Now, let's delve into the dynamic environments our APIs thrive in:Sandbox environment: Here, experimentation is the name of the game. It's the domain of testing and development, where every transaction carries no real-world implications. Your endeavors here shape the future without leaving a trace on the main blockchain.Production environment: This is where reality takes center stage. The transactions that unfold here are not merely simulations; they're tangible, real-world actions that imprint themselves on the main blockchain.Let's explore the core operations that anchor our platform:Wallets: Craft and manage accounts and wallets with unprecedented ease, empowering your users with seamless control over their digital assets.Media NFT: Immerse yourself in the world of NFTs, creating and managing these unique tokens to captivate your users and offer them a novel experience.Payments: Redefine transactions by simplifying crypto payments, empowering your users to engage in borderless commerce without the complexities that once stood in their way.Virtual Wallets: Create easily deposit addresses, concentrate capital, and manage it from a single place. Now, streamline your financial operations and maximize efficiency with our integrated solution.Cards: Issue virtual or physical cards to your clients. You may choose between debit or credit system based on your requirements.In conclusion, CryptoMate APIs are more than just a technical innovation - they're a gateway to an era of simplicity, empowerment, and boundless opportunity. It's time to embrace a future where global transactions are as effortless as invoking an API. Welcome to the world of limitless possibilities.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

Let us introduce you to the revolutionary world of CryptoMate APIs, a gateway to effortless global transactions. In this era of rapid technological advancement, harnessing the power of Blockchain technology has never been simpler. With CryptoMate APIs, you can unlock the true potential of this transformative technology while keeping your focus unwaveringly on providing an exceptional customer experience.

Picture this: you have the opportunity to craft incredible applications in an astonishingly short span of time, all thanks to our groundbreaking APIs. Let me walk you through some captivating examples:

Imagine seamlessly integrating crypto assets into your fintech wallet. With our ingenious MPC module, managing diverse wallets across different blockchains becomes as intuitive as invoking just two APIs. Yes, you heard that right - two APIs stand between you and an enhanced financial ecosystem.

Or consider this: sending your customers NFTs as part of a loyalty program, with the ability to effortlessly track every intricate movement. This seemingly complex task becomes a breeze with our Media NFT module, requiring just two APIs. Loyalty meets simplicity.

And for those seeking to embrace the future of commerce, imagine accepting crypto payments with unparalleled ease - a reality achieved by invoking a single API through our Payment module. This single act bridges the gap between traditional and digital currency transactions.

Before embarking on your journey to integrate our API marvels, there's a crucial step: obtaining an API key. This key serves as a digital seal of authenticity, safeguarding your requests and ensuring a secure gateway to our suite of services. Obtaining it is as simple as signing up on our website, where possibilities await.

Now, let's delve into the dynamic environments our APIs thrive in:

: Here, experimentation is the name of the game. It's the domain of testing and development, where every transaction carries no real-world implications. Your endeavors here shape the future without leaving a trace on the main blockchain.

: This is where reality takes center stage. The transactions that unfold here are not merely simulations; they're tangible, real-world actions that imprint themselves on the main blockchain.

Let's explore the core operations that anchor our platform:

: Craft and manage accounts and wallets with unprecedented ease, empowering your users with seamless control over their digital assets.

: Immerse yourself in the world of NFTs, creating and managing these unique tokens to captivate your users and offer them a novel experience.

: Redefine transactions by simplifying crypto payments, empowering your users to engage in borderless commerce without the complexities that once stood in their way.

 Create easily deposit addresses, concentrate capital, and manage it from a single place. Now, streamline your financial operations and maximize efficiency with our integrated solution.

Issue virtual or physical cards to your clients. You may choose between debit or credit system based on your requirements.

In conclusion, CryptoMate APIs are more than just a technical innovation - they're a gateway to an era of simplicity, empowerment, and boundless opportunity. It's time to embrace a future where global transactions are as effortless as invoking an API. Welcome to the world of limitless possibilities.

To ensure seamless and secure interactions, we&apos;ve implemented API keys. These keys grant authorized access to our services, safeguarding your application and data. Obtaining your unique API key is a straightforward process – simply sign up, generate your key in your account dashboard, and include it in your API requests&apos; headers. This extra layer of authentication guarantees a smooth and protected experience, enabling you to harness the power of our system with confidence. You can generate API keys programmatically through our Management API or seamlessly via our intuitive dashboard. But it doesn&apos;t stop there! Elevate control by assigning specific feature permissions to each API key. This means you decide which areas of our system your key can unlock. Whether you&apos;re creating, editing, or managing keys, our API-first approach empowers you to shape your experience. Use it is super easy, just add the header <code style="background-color:var(--tw-prose-code-bg);color:var(--tw-prose-code);font-size:0.75rem" class="slate-code">X-API-KEY</code> with the value of your API-KEY and done!.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

To ensure seamless and secure interactions, we've implemented API keys. These keys grant authorized access to our services, safeguarding your application and data. Obtaining your unique API key is a straightforward process – simply sign up, generate your key in your account dashboard, and include it in your API requests' headers. This extra layer of authentication guarantees a smooth and protected experience, enabling you to harness the power of our system with confidence. You can generate API keys programmatically through our Management API or seamlessly via our intuitive dashboard. But it doesn't stop there! Elevate control by assigning specific feature permissions to each API key. This means you decide which areas of our system your key can unlock. Whether you're creating, editing, or managing keys, our API-first approach empowers you to shape your experience. Use it is super easy, just add the header 

 with the value of your API-KEY and done!.

error_code

message

Example

In this guide, we will explore potential challenges that you might come across and discuss effective strategies for managing them. By addressing these issues, you can significantly enhance the efficiency of your development process.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2"><a href="https://cryptomate.me/docs/errors#error-response" target="_blank">Trace Request</a></h2>On every response and webhook transaction a header is sent to track it, the name of this header is <code class="slate-code">X-Trace-Id</code>. This information will be ask on any support request made so we can speed up the solution of any error ocurred.<h2 class="slate-h2"><a href="https://cryptomate.me/docs/errors#error-response" target="_blank">Error response</a></h2>If the request has not been successful, you will receive a JSON with the following attributes:<code style="color:rgb(63, 63, 70);font-size:14px" class="slate-code">error_code</code>: The error code that has occurred.<code style="color:rgb(63, 63, 70);font-size:14px" class="slate-code">message</code>: A message that describes the error.
<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

In this guide, we will explore potential challenges that you might come across and discuss effective strategies for managing them. By addressing these issues, you can significantly enhance the efficiency of your development process.

On every response and webhook transaction a header is sent to track it, the name of this header is 

This information will be ask on any support request made so we can speed up the solution of any error ocurred.

If the request has not been successful, you will receive a JSON with the following attributes:

The request executed had finished successfully.

200-201

The request is not valid, due to some unpredictable error. If you are using a POST, PUT or PATCH request, check that the body is valid. If you are using a GET request, check that the parameters are correct. If you are using a DELETE request, check the path.

The API Key is not authorized to do this operation. Check that your API Key had been correctly configured.

The requested resource does not exist. Some of the information needed to do this request was not found.

The request was not completed because an internal validation was not fulfilled. Check that the body of the request is valid.

Our APIs are currently experiencing issues. This is an error on our side, we will check as soon as possible. Please contact support and try again later.

The Management API is your all-in-one powerhouse for steering the ship of account management. It functions as a sophisticated toolkit, empowering users to seamlessly create, tweak, or bid farewell to clients, accounts, users, and access levels. Acting as a refined interface, it grants users granular control over the organizational account landscape, facilitating tasks such as spinning up new clients or tweaking existing configurations on the fly. Need to sculpt user accounts to fit the evolving needs of your operation? You got it. It doesn't stop there – the API lets you fine-tune access levels, ensuring a secure and compliant environment. And when it's time for some digital spring cleaning, the API's deletion functionalities let you tidy up by retiring entities that have overstayed their welcome. It's like having a backstage pass to the techy side of account management without the fuss.For using this API you need to use your API key that have <code class="slate-code">MANAGEMENT</code> permission.

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

Retrieves all the information of the company.
Required access level: Admin Access (Level 3)<div class="slate-div"></div>

Retrieves all the information of the company.


Required access level: Admin Access (Level 3)

Get client

Identifier used to authenticate a user for the use of the CryptoMate APIs.

x-api-key

name

last_name

email

social_reason

webhook_url

webhook_key

Updates the information of your companyRequired access level: Admin Access (Level 3)<div class="slate-div"></div>

Required access level: Admin Access (Level 3)

Update client

Modifies the client's webhook url.Required access level: Admin Access (Level 3)<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div >The webhook key need also to be set to guaranty that the caller of the endpoint is our platform.</div></div><div class="slate-div"></div><div class="slate-div"></div>

Subscribe webhook

Modifies the client's webhook key that indentify that the request that you are receiving came from our platform.
Required access level: Admin Access (Level 3)<div class="slate-div"></div><div class="slate-div"></div>

Modifies the client's webhook key that indentify that the request that you are receiving came from our platform.

Set webhook key

Set the address where you want to receive the payments.
Required access level: Admin Access (Level 3)<div class="slate-div"></div>

Set the address where you want to receive the payments.

Update payment treasury

payment_destination

The treasury module offers you a seamless way to integrate the functionalities of a decentralized wallet, along with the capability to send and receive your crypto assets. This module covers everything from setting up a single wallet to managing multiple ones, all without delving into the complexities of web3.0 terminology. This ensures a smoother integration and user experience overall.<div></div>

The treasury module offers you a seamless way to integrate the functionalities of a decentralized wallet, along with the capability to send and receive your crypto assets. This module covers everything from setting up a single wallet to managing multiple ones, all without delving into the complexities of web3.0 terminology. This ensures a smoother integration and user experience overall.

This module offers customers the possibility to generate <code>Virtual Wallets</code> on various blockchain networks to send, receive and record balances and movements. It simplifies the management of digital assets and allows to establish automated rules for user flows. All the assets will be stored on a <code>Holding Wallet</code> that will be created when the first <code>Virtual Wallet</code> is created. There is on

This module offers customers the possibility to generate 

 on various blockchain networks to send, receive and record balances and movements. It simplifies the management of digital assets and allows to establish automated rules for user flows. All the assets will be stored on a 

 for each blockchain. When a deposit is made to one of the addresses it will accredit it instantly. These 

, which represents the amount of tokens that belongs to those addresses. 

Virtual wallets are interfaces that allow users to interact with the blockchain in a more accessible and user-friendly way without the need to directly manage the private keys associated with their digital assets. This reduces the technical complexity and risks associated with the loss or mismanagement of these keys, making blockchain technology more accessible to the average user.

Virtual Wallets also have the capability to be deactivated, ensuring that they do not occupy space within the pool of available virtual wallets. This feature allows for better management and allocation of resources, ensuring that only active and necessary wallets consume system resources.

At the core of the Virtual Wallet infrastructure is the Holding Wallet. This is a unique wallet designated for each blockchain, where all users' digital assets are stored. The Holding Wallet is responsible for managing the actual funds and executing transactions on behalf of the Virtual Wallets. This centralized approach allows for greater security and efficiency in the management of digital assets.

Virtual Wallets display to users a virtual balance that reflects the amount of tokens allocated to their specific addresses. However, these real assets are centrally stored in the Holding Wallet. This virtual representation allows for more agile and secure management, eliminating the need for users to interact directly with the blockchain for each operation.

One of the key benefits of Virtual Wallets is the ability to perform instant transactions from the user's perspective. When a deposit is made to a Virtual Wallet address, the balance is updated immediately in the user interface, providing a seamless and delay-free experience. Meanwhile, the underlying transaction on the blockchain is processed in the background and may take a bit longer to confirm, depending on network congestion and conditions.

Virtual Wallets also offer advanced automation capabilities, allowing users to set customized rules for managing user flows. This can include setting up automatic transfers, alerts, and notifications, among other features that significantly enhance the user experience. Automation reduces the need for manual intervention, making digital asset management more efficient and secure.

The Holding Wallet plays a critical role in financial management. It allows for partial withdrawal of the balance, keeping a reserve ratio against the Virtual Wallets, which facilitates the handling of user funds to generate additional benefits. It is essential to maintain a guarantee fund within the Holding Wallet to ensure that customer withdrawals are always covered. Failing to do so would result in insufficient funds errors when attempting withdrawals.

Moreover, if assets are transferred from the Holding Wallet to a Virtual Wallet, the balance of the latter will be updated even if the Holding Wallet does not have sufficient funds to cover that amount. This mechanism can create leverage by effectively using capital beyond the immediate balance of the Holding Wallet.

The Cards section explains to the user, how to manage card information associated with their accounts. Users can add, update, and remove cards, as well as retrieve details such as the card number and expiration date. This section provides essential functionality for handling payment methods within the application.

The Cards section explains to the user, how to manage card information associated with their accounts. Users can add, update, and remove cards, as well as retrieve details such as the card number and expiration date. This section provides essential functionality for handling payment methods within the application.

Webhooks provide real-time notifications for API events, enabling your platform to receive timely updates about specific activities. Our system sends these notifications to a designated endpoint within your hosted environment, which is configured to adeptly receive and process them.Leverage webhooks to promptly obtain information about critical API events. These events include occurrences external to your system, such as a new deposit in an MPC walle

Webhooks provide real-time notifications for API events, enabling your platform to receive timely updates about specific activities. Our system sends these notifications to a designated endpoint within your hosted environment, which is configured to adeptly receive and process them.

Leverage webhooks to promptly obtain information about critical API events. These events include occurrences external to your system, such as a new deposit in an MPC wallet or a card transaction at a point-of-sale (POS) terminal.To seamlessly receive and process webhook-enabled events, you need to establish and configure a webhook endpoint within your environment.

Each webhook request consists of a common part and a custom payload specific to the event being communicated. The common part includes standard information such as the event type, sub-type, status and a unique Id of of the notification, while the custom payload contains detailed data relevant to the specific event.