CryptoMate

Introduction

Guides

Treasury

Virtual Wallets

Cards

API Keys & Access Security

Errors

Management

Webhooks

Events

Simulate

API Layer

Production

Sandbox

<p class="slate-p " >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.</p><p class="slate-p " >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:</p><p class="slate-p " >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.</p><p class="slate-p " >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.</p><p class="slate-p " >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.</p><p class="slate-p " >Before embarking on your journey to integrate our API marvels, there&apos;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.</p><p class="slate-p " >Now, let&apos;s delve into the dynamic environments our APIs thrive in:</p><p class="slate-p " ><em class="slate-italic">Sandbox environment</em>: Here, experimentation is the name of the game. It&apos;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.</p><p class="slate-p " ><em class="slate-italic">Production environment</em>: This is where reality takes center stage. The transactions that unfold here are not merely simulations; they&apos;re tangible, real-world actions that imprint themselves on the main blockchain.</p><p class="slate-p " >Let&apos;s explore the core operations that anchor our platform:</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Wallets</strong></span>: Craft and manage accounts and wallets with unprecedented ease, empowering your users with seamless control over their digital assets.</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Media NFT</strong></span>: Immerse yourself in the world of NFTs, creating and managing these unique tokens to captivate your users and offer them a novel experience.</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Payments</strong></span>: Redefine transactions by simplifying crypto payments, empowering your users to engage in borderless commerce without the complexities that once stood in their way.</p><p class="slate-p " ><strong class="slate-bold">Virtual Wallets:</strong> 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.</p><p class="slate-p " ><strong class="slate-bold">Cards: </strong>Issue virtual or physical cards to your clients. You may choose between debit or credit system based on your requirements.</p><p class="slate-p " >In conclusion, CryptoMate APIs are more than just a technical innovation - they&apos;re a gateway to an era of simplicity, empowerment, and boundless opportunity. It&apos;s time to embrace a future where global transactions are as effortless as invoking an API. Welcome to the world of limitless possibilities.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p>

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.

<p class="slate-p " >To ensure secure, reliable, and controlled access to our platform, all API interactions are authenticated using <strong class="slate-bold">API keys</strong>. An API key uniquely identifies your application and authorizes it to interact with our services, providing a robust layer of protection for both your data and our infrastructure.</p><h3 class="slate-h3 " >Creating and Managing API Keys</h3><p class="slate-p " >You can generate and manage API keys through the our <a href="https://portal.cryptomate.me" target=""><strong class="slate-bold">Dashboard</strong></a>. Create, edit, rotate, or revoke keys directly from your account dashboard. </p><p class="slate-p " >Each API key is independent and can be managed lifecycle-wise without impacting other integrations.</p><h3 class="slate-h3 " >Fine-Grained Permissions</h3><p class="slate-p " >Every API key can be configured with <strong class="slate-bold">specific feature-level permissions</strong>. This allows you to precisely control which parts of the system a given key can access.</p><p class="slate-p " >For example, you may issue:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">A read-only key for reporting or analytics </div></li><li class="slate-li " ><div style="position:relative">A restricted key for a single product or feature </div></li><li class="slate-li " ><div style="position:relative">A full-access key for trusted backend services </div></li></ul><p class="slate-p " >This principle of least privilege helps minimize risk while maximizing operational flexibility.</p><h3 class="slate-h3 " >IP Address Restrictions</h3><p class="slate-p " >To further strengthen security, API keys can now be <strong class="slate-bold">restricted to a defined set of IP addresses</strong>.</p><p class="slate-p " >When creating or editing an API key, you may optionally configure an <strong class="slate-bold">IP allowlist</strong>:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Only requests originating from the specified IP addresses or CIDR ranges will be accepted. </div></li><li class="slate-li " ><div style="position:relative">Requests from any other IP will be automatically rejected, even if the API key is valid. </div></li></ul><p class="slate-p " >This feature is particularly useful for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Backend services running from fixed infrastructure </div></li><li class="slate-li " ><div style="position:relative">Preventing key misuse in case of accidental exposure </div></li><li class="slate-li " ><div style="position:relative">Enforcing network-level security policies </div></li></ul><p class="slate-p " >IP restrictions can be updated at any time without regenerating the key.</p><h3 class="slate-h3 " >Using an API Key</h3><p class="slate-p " >To authenticate a request, include your API key in the request headers:</p><p class="slate-p " >X-API-KEY: &lt;your-api-key&gt;</p><p class="slate-p " >No additional authentication steps are required.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p>

To ensure secure, reliable, and controlled access to our platform, all API interactions are authenticated using 

. An API key uniquely identifies your application and authorizes it to interact with our services, providing a robust layer of protection for both your data and our infrastructure.

You can generate and manage API keys through the our 

. Create, edit, rotate, or revoke keys directly from your account dashboard. 

Each API key is independent and can be managed lifecycle-wise without impacting other integrations.

. This allows you to precisely control which parts of the system a given key can access.

This principle of least privilege helps minimize risk while maximizing operational flexibility.

To further strengthen security, API keys can now be 

restricted to a defined set of IP addresses

When creating or editing an API key, you may optionally configure an 

IP restrictions can be updated at any time without regenerating the key.

To authenticate a request, include your API key in the request headers:

No additional authentication steps are required.

error_code

message

Example

<p class="slate-p " ><span style="color:rgb(63, 63, 70)">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.</span></p><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><p class="slate-p " >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>. </p><p class="slate-p " >This information will be ask on any support request made so we can speed up the solution of any error ocurred.</p><h2 class="slate-h2 " ><a href="https://cryptomate.me/docs/errors#error-response" target="_blank">Error response</a></h2><p class="slate-p " >If the request has not been successful, you will receive a JSON with the following attributes:</p><p class="slate-p " ><span style="color:rgb(63, 63, 70)"><code class="slate-code">error_code</code></span><span style="color:rgb(63, 63, 70)">: The error code that has occurred.</span></p><p class="slate-p " ><span style="color:rgb(63, 63, 70)"><code class="slate-code">message</code></span><span style="color:rgb(63, 63, 70)">: A message that describes the error.</span>
</p><div class="slate-div"></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p>

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.

<p class="slate-p " >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.</p><p class="slate-p " >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.</p><p class="slate-p slate-indent-0" style="0px">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.</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:194px;">Title</div><div style="width:176px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:194px"><col style="width:176px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Field</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">Type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >operation</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicator of the operation being informed</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >sub_operation</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicator of the activity of the operation being informed</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >operation_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the operation</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status of the transaction. Possible values: SUCCESS | CANCELLED | FAILED</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >reason</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >If the status is FAILED the reason of why ll appear here</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >data</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Variable payload of the notification. The content of this will change depending of the notification type. Complete specification of this will be inside each notification page.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">General payload example:</strong></p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;operation&quot;: &quot;TREASURY&quot;,</div><div class="slate-code_line">  &quot;sub_operation&quot;: &quot;DEPOSIT&quot;,</div><div class="slate-code_line">  &quot;operation_id&quot;: &quot;ca0c57d2-b1c9-4bcd-9d5d-8d361cad6fddds1c&quot;,</div><div class="slate-code_line">  &quot;status&quot;: &quot;FINISHED&quot;,</div><div class="slate-code_line">  &quot;data&quot;: { }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

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.

Sections