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

<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'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'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'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're tangible, real-world actions that imprint themselves on the main blockchain.</p><p class="slate-p " >Let'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'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><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" placeholder="Type / for widgets"><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color">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 </span><span style="background-color:var(--tw-prose-code-bg);color:var(--tw-prose-code);font-size:0.75rem" class="slate-color"><span style="background-color:var(--tw-prose-code-bg);color:var(--tw-prose-code);font-size:0.75rem" class="slate-backgroundColor"><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></span></span><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color"> with the value of your API-KEY and done!.</span></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

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

<p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">If the request has not been successful, you will receive a JSON with the following attributes:</p><p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color"><code style="color:rgb(63, 63, 70);font-size:14px" class="slate-code">error_code</code></span><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color">: The error code that has occurred.</span></p><p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color"><code style="color:rgb(63, 63, 70);font-size:14px" class="slate-code">message</code></span><span style="color:rgb(63, 63, 70);font-size:14px" class="slate-color">: A message that describes the error.</span>
</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p" placeholder="Type / for widgets"></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></p><p>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</p>

<p><span>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.</span></p><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.

<p>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</p>

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.

<p>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.</p><p></p><p></p>

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.

<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="table-container" style="width:60%;
  min-width:60%;"><table class="slate-table" ><colgroup ><col style="width:12.30964467005076%"><col style="width:11.16751269035533%"><col style="width:0%"></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</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><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" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  "operation": "TREASURY",</div><div class="slate-code_line">  "sub_operation": "DEPOSIT",</div><div class="slate-code_line">  "operation_id": "ca0c57d2-b1c9-4bcd-9d5d-8d361cad6fddds1c",</div><div class="slate-code_line">  "status": "FINISHED",</div><div class="slate-code_line">  "data": { }</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.

<p class="slate-p " >The Events section provides detailed information about the notifications that are triggered by our webhook service. Users can leverage this section to gain insights into real-time updates and track significant events within their application.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">Security:
For avoid that someone can call the client side simulating being a real call. The request will have a security header called </em><em class="slate-italic"><strong class="slate-bold">X-Webhook-Key</strong></em>  with the value set on the <a href="https://app.theneo.io/cryptomate/api/management/clients/subscribe-webhook" target="_self">management configuration</a></p></div></div><p class="slate-p slate-indent-0" style="0px">The request is composed by the following fields:</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">PRODUCT: </strong><em class="slate-italic">string</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">EVENT TYPE:</strong><em class="slate-italic"> string</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">STATUS:</strong><em class="slate-italic"> string</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">OPERATION ID:</strong><em class="slate-italic"> string</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">DATA:</strong><em class="slate-italic"> object</em></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Events section provides detailed information about the notifications that are triggered by our webhook service. Users can leverage this section to gain insights into real-time updates and track significant events within their application.

The request is composed by the following fields:

<p class="slate-p slate-indent-0" style="0px">When a deposit is detected on any of your wallets from the products TREASURY and VIRTUAL WALLETS, a notification will be sent to de configured webhook notification (if not configured nothing will be sent).</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >For configure the webhook please sea the <em class="slate-italic"><strong class="slate-bold">management</strong></em> endpoints</p></div></div><p class="slate-p slate-indent-0" style="0px">The request is composed by the following fields:</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">PRODUCT: </strong><em class="slate-italic">TREASURY | </em>VIRTUAL_WALLETS</p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">EVENT TYPE:</strong><em class="slate-italic"> DEPOSIT</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">STATUS:</strong><em class="slate-italic"> </em>SUCCESS</p><p class="slate-p slate-indent-0" style="0px"> </p><h3 class="slate-h3 " ><strong class="slate-bold">Data Payload:</strong></h3><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><colgroup ><col style="width:15.291878172588833%"><col style="width:17.00507614213198%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Field</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Type</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Description</strong></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >wallet_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the card that needs the approval</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >wallet_address</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Address of one of your wallets that received the tokens</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_hash</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Hash of the operation to check on the blockchain</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >blockchain</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Blockchain name where the operation was made. For possibles values check the Management/Blockchain endpoint</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >from_wallet_address</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Address of the wallet that send the tokens</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Amount received</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >token</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information of the received token</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >created_at</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date Time</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date and time when the transaction was created</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Token payload:</strong></h3><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><colgroup ><col style="width:0%"><col style="width:0%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Field</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Type</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Description</strong></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Full name of the token</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >symbol</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Short name of the token</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >address</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Address of the token contract</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Full payload example:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  "product": "TREASURY",</div><div class="slate-code_line">  "event_type": "DEPOSIT",</div><div class="slate-code_line">  "operation_id": "0x1234567890123456789012345678901234567890",</div><div class="slate-code_line">  "status": "SUCCESS",</div><div class="slate-code_line">  "data": {</div><div class="slate-code_line">    "wallet_id": "ivZPARvNBLOSZx69q4DCBBGUfVhCMsLw",</div><div class="slate-code_line">    "wallet_address": "0xff899364c6e15524531ed3739ea3e878eb1c6d86",</div><div class="slate-code_line">    "transaction_hash": "0xa348fb3f57c8ecc92ca0aaa858c520432a23cd5e5aeeee3e116fba229891e581",</div><div class="slate-code_line">    "from_wallet_address": "0xde0da9cb48b9133b9011fbc0a073c71e7cc23830",</div><div class="slate-code_line">    "amount": "100.1",</div><div class="slate-code_line">    "token": {</div><div class="slate-code_line">      "name": "USD Circle",</div><div class="slate-code_line">      "symbol": "USDC",</div><div class="slate-code_line">      "address": "0x41e94eb019c0762f9bfcf9fb1e58725bfb0e7582"</div><div class="slate-code_line">    },</div><div class="slate-code_line">    "created_at": "2024-06-28T10:20:56.654-03:00"</div><div class="slate-code_line">  } </div><div class="slate-code_line">}</div></code></pre></div><h2 class="slate-h2 " >Response:</h2><div class="slate-code_line">No response is needed</div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

When a deposit is detected on any of your wallets from the products TREASURY and VIRTUAL WALLETS, a notification will be sent to de configured webhook notification (if not configured nothing will be sent).

New deposit received

The request webhook is triggered when a real-time authorization is requested. And should be answered with the correct code less than 1 second 

 to be processed, if not the operation will be declined and customer purchase reject.

In order to approve the transaction a OK (HTTP 200) response is needed in less that 1 second (

to know to approve or decline the transaction

Card transaction approval

The request webhook is triggered when the transaction was authorized and the clearing process is pending to be evaluated.

Card transaction clearing pending

<p class="slate-p slate-indent-0" style="0px">The request webhook is triggered when the transaction was authorized but it has been declined therefore the transaction has been fully reversed.</p><p class="slate-p slate-indent-0" style="0px">The request is composed by the following fields:</p><p class="slate-p slate-indent-0" style="0px"></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f8d71f62-4649-4483-8c28-29c1807372ed.jpg" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f8d71f62-4649-4483-8c28-29c1807372ed.jpg" style="width:600px;
	  height:300px;
	  aspect-ratio:600 / 300" /></a></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">PRODUCT: </strong><em class="slate-italic">CARDS</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">EVENT TYPE:</strong><em class="slate-italic"> CLEARING</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">STATUS:</strong><em class="slate-italic"> FAILED</em></p><p class="slate-p slate-indent-0" style="0px"> </p><h3 class="slate-h3 " ><strong class="slate-bold">Data Payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Field</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Type</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Description</strong></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the card that needs the approval</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Amount of the operation will be billed on the system. Since all our cards are issued on USD, all transactions on the field will be on US Dollar</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_currency_number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency expressed on <a href="https://www.iban.com/currency-codes" target="_blank">ISO 4217</a> format</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_currency_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency short name</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Amount of the operation that client is going to spend. This is the same value as show on the checkout/POS</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_currency_number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency expressed on <a href="https://www.iban.com/currency-codes" target="_blank">ISO 4217</a> format</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_currency_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency short name</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >exchange_rate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >If applied, the conversion rate applied to the amout. If not <em class="slate-italic">null</em> will be sent.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >channel</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Name of the channel where the transaction is being made. Possible values <code class="slate-code"><strong class="slate-bold">ATM</strong></code>, <code class="slate-code"><strong class="slate-bold">POS</strong></code>, <code class="slate-code"><strong class="slate-bold">ECOMMERCE</strong></code> or <code class="slate-code"><strong class="slate-bold">Visa Direct</strong></code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >created_at</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date Time</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date and time when the transaction was created</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information about the fees that are involved in the transaction</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >merchant_data</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information about the merchant that is involved in the transaction</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Fees payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Field</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Type</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Description</h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >atm_fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ATM fee charged to the transaction, if apply. Zero if no cost is incurred</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >fx_fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency conversion fee charged to the transaction, if apply. Zero if no cost is incurred</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Merchant payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Field</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Type</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Description</h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the merchant</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Registered of the merchant</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >city</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >City where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >post_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Postal code where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >state</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >State where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >country</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Country where the merchant is registered. The country name is represented in 3 letter format <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a>.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mcc_category</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Category name that the merchant has be registered</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mcc_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Numeric code of the category that merchant has be registered</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Full payload example:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  "product": "CARDS",</div><div class="slate-code_line">  "event_type": "CLEARING",</div><div class="slate-code_line">  "operation_id": "ca0c57d2-b1c9-4bcd-9d5d-8d361cad6fddds1c",</div><div class="slate-code_line">  "status": "FAILED",</div><div class="slate-code_line">  "data": {</div><div class="slate-code_line">    "card_id": "ivZPARvNBLOSZx69q4DCBBGUfVhCMsLw",</div><div class="slate-code_line">    "amount": 100.2,</div><div class="slate-code_line">    "currency_number": 840,</div><div class="slate-code_line">    "currency_code": "USD",</div><div class="slate-code_line">    "exchange_rate": null,</div><div class="slate-code_line">    "channel": "ECOMMERCE",</div><div class="slate-code_line">    "created_at": "2024-05-15T21:38:57.677Z",</div><div class="slate-code_line">    "fees": {</div><div class="slate-code_line">      "atm_fees": 0,</div><div class="slate-code_line">      "fx_fees": 0</div><div class="slate-code_line">    },</div><div class="slate-code_line">    "merchant_data": {</div><div class="slate-code_line">      "id": "311178830000",</div><div class="slate-code_line">      "name": "Amazon Es",</div><div class="slate-code_line">      "city": "Barcelona",</div><div class="slate-code_line">      "post_code": "16633",</div><div class="slate-code_line">      "state": "Cataluña",</div><div class="slate-code_line">      "country": "ESP",</div><div class="slate-code_line">      "mcc_category": "Electronics Stores",</div><div class="slate-code_line">      "mcc_code": "5732"</div><div class="slate-code_line">    }</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><h2 class="slate-h2 " >Response:</h2><p class="slate-p slate-indent-0" style="0px">No response is need it.</p><h3 class="slate-h3 " ><strong class="slate-bold">Payload example:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The request webhook is triggered when the transaction was authorized but it has been declined therefore the transaction has been fully reversed.

Card transaction clearing failed

The request webhook is triggered when the transaction was approved and therefore the purchase was fulfilled.

Card transaction cleared

<p class="slate-p slate-indent-0" style="0px">The request webhook is triggered when the transaction was declined for a several reason like response the transaction approval after the 1 second gap or response the approval with a 05 code.</p><p class="slate-p slate-indent-0" style="0px">The request is composed by the following fields:</p><p class="slate-p slate-indent-0" style="0px"></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/fa1f6509-cd09-4c9d-936f-dc220f86c706.jpg" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/fa1f6509-cd09-4c9d-936f-dc220f86c706.jpg" style="width:600px;
	  height:300px;
	  aspect-ratio:600 / 300" /></a></div><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">PRODUCT: </strong><em class="slate-italic">CARDS</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">EVENT TYPE:</strong><em class="slate-italic"> DECLINED</em></p><p class="slate-p slate-indent-0" style="0px"><em class="slate-italic">
</em><strong class="slate-bold">STATUS:</strong><em class="slate-italic"> FAILED</em></p><p class="slate-p slate-indent-0" style="0px"> </p><h3 class="slate-h3 " ><strong class="slate-bold">Data Payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Field</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Type</strong></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><strong class="slate-bold">Description</strong></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the card that needs the approval</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Amount of the operation will be billed on the system. Since all our cards are issued on USD, all transactions on the field will be on US Dollar</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_currency_number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency expressed on <a href="https://www.iban.com/currency-codes" target="_blank">ISO 4217</a> format</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bill_currency_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency short name</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Amount of the operation that client is going to spend. This is the same value as show on the checkout/POS</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_currency_number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency expressed on <a href="https://www.iban.com/currency-codes" target="_blank">ISO 4217</a> format</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transaction_currency_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency short name</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >exchange_rate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >If applied, the conversion rate applied to the amout. If not <em class="slate-italic">null</em> will be sent.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >channel</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Name of the channel where the transaction is being made. Possible values <code class="slate-code"><strong class="slate-bold">ATM</strong></code>, <code class="slate-code"><strong class="slate-bold">POS</strong></code>, <code class="slate-code"><strong class="slate-bold">ECOMMERCE</strong></code> or <code class="slate-code"><strong class="slate-bold">Visa Direct</strong></code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >created_at</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date Time</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date and time when the transaction was created</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information about the fees that are involved in the transaction</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >merchant_data</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information about the merchant that is involved in the transaction</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >declined_reason</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information about why the transaction was rejected</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Fees payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Field</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Type</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Description</h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >atm_fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ATM fee charged to the transaction, if apply. Zero if no cost is incurred</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >fx_fees</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Decimal with 2 digit precision</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency conversion fee charged to the transaction, if apply. Zero if no cost is incurred</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Merchant payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Field</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Type</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Description</h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier of the merchant</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Registered of the merchant</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >city</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >City where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >post_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Postal code where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >state</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >State where the merchant is registered, could be <em class="slate-italic">null</em></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >country</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Country where the merchant is registered. The country name is represented in 3 letter format <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a>.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mcc_category</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Category name that the merchant has be registered</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mcc_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Numeric code of the category that merchant has be registered</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><strong class="slate-bold">Declined Reason payload:</strong></h3><div class="table-container"><table class="slate-table" style="width:60%;
  min-width:60%;"><colgroup ><col style="width:15%"><col style="width:17%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Field</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Type</h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " >Description</h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >response_code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique code that represents the declined reason</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >description</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A more descriptive explanation of the reason of the declined reason</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Full payload example:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  "product": "CARDS",</div><div class="slate-code_line">  "event_type": "DECLINED",</div><div class="slate-code_line">  "operation_id": "ca0c57d2-b1c9-4bcd-9d5d-8d361cad6fddds1c",</div><div class="slate-code_line">  "status": "FAILED",</div><div class="slate-code_line">  "data": {</div><div class="slate-code_line">    "card_id": "ivZPARvNBLOSZx69q4DCBBGUfVhCMsLw",</div><div class="slate-code_line">    "amount": 100.2,</div><div class="slate-code_line">    "currency_number": 840,</div><div class="slate-code_line">    "currency_code": "USD",</div><div class="slate-code_line">    "exchange_rate": null,</div><div class="slate-code_line">    "channel": "ECOMMERCE",</div><div class="slate-code_line">    "created_at": "2024-05-15T21:38:57.677Z",</div><div class="slate-code_line">    "fees": {</div><div class="slate-code_line">      "atm_fees": 0,</div><div class="slate-code_line">      "fx_fees": 0</div><div class="slate-code_line">    },</div><div class="slate-code_line">    "merchant_data": {</div><div class="slate-code_line">      "id": "311178830000",</div><div class="slate-code_line">      "name": "Amazon Es",</div><div class="slate-code_line">      "city": "Barcelona",</div><div class="slate-code_line">      "post_code": "16633",</div><div class="slate-code_line">      "state": "Cataluña",</div><div class="slate-code_line">      "country": "ESP",</div><div class="slate-code_line">      "mcc_category": "Electronics Stores",</div><div class="slate-code_line">      "mcc_code": "5732"</div><div class="slate-code_line">    },</div><div class="slate-code_line">    "declined_reason": {</div><div class="slate-code_line">      "response_code": "DC",</div><div class="slate-code_line">      "description": "Transaction declined by the client"</div><div class="slate-code_line">    }</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><h2 class="slate-h2 " >Response:</h2><p class="slate-p slate-indent-0" style="0px">No response is need it.</p><h3 class="slate-h3 " ><strong class="slate-bold">Payload example:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The request webhook is triggered when the transaction was declined for a several reason like response the transaction approval after the 1 second gap or response the approval with a 05 code.

Card transaction declined

The request webhook is triggered when the transaction was reversal by the merchant or the card provider.

Card transaction reversal

The request webhook is triggered when the transaction was canceled therefore the amount has been refund.

Card transaction refund

<p>The Simulate section allows users to test and replicate transaction events within the API Layer using the account's configured mechanisms. By simulating transactions, users can ensure that the API functions correctly and accurately reflects real-world scenarios. This section is essential for developers to validate the behavior of their applications and ensure seamless integration with the API Layer.</p><p></p>

The Simulate section allows users to test and replicate transaction events within the API Layer using the account's configured mechanisms. By simulating transactions, users can ensure that the API functions correctly and accurately reflects real-world scenarios. This section is essential for developers to validate the behavior of their applications and ensure seamless integration with the API Layer.