CryptoMate

Introduction

Guides

Treasury

Virtual Wallets

Cards

API Keys & Access Security

Errors

Management

Webhooks

Events

Simulate

API Layer

Production

Sandbox

3DS authentication respond

Accounts

Unblock card

Transactions

Declined Reasons

Search card transactions

Virtual Cards

Create virtual card

Delete virtual card

Freeze or Unfreeze card

Get PAN (html)

Get Top Up wallets

Get Virtual Balance

Get virtual card

List virtual cards

Override virtual balance

Reissue Card

3DS configuration

Update PIN

Update virtual card phone

Update virtual card limits

Update virtual card email

Warranty

Get warranty balance

Warranty withdrawal

Blockchains

Get all blockchains

Company

Set webhook key

Subscribe webhook

Configurations

Delete payment destination

Get payment destination

Set payment destination

Contracted Products

Get all contracted and used products

Get contracted products

Clients

Get Supported Countries

Create Business Client

Create Client

Get all clients

Create PIX Bank Account

Create SEPA Bank Account

Create SPEI Bank Account

Create US Bank Account

Get All Bank Accounts

Get Bank Account by ID

Delete Bank Account

Get Business Identifications by Country

Get Business Industries

Get client

Delete client

Get Client Requiered Documentation

Get Identification Types

Get Pending Documents for Client

Update client

Operations

Get all operations

Get operation

Create account

Delete account

Edit account

Get all accounts

Tokens

Get tokens

Get listed tokens by blockchain

Search transactions

Wallets

Create wallet

Delete wallet

Get all wallets

Get balance

Get wallet

Transfer token

Update wallet

Configuration

Get available blockchains

Holding

Get Holding Wallet balance by blockchain

Get Holding Wallet balance info

Withdraw from Holding Wallet

Ramps

Bank Ramps

Execute bank ramp off

Cancel bank ramp on

Execute bank ramp on

Simulate bank ramp on

Simulate bank ramp off

Associate client

Create Virtual Wallet

Delete Virtual Wallet

Enable/disable Virtual Wallet

Get all Virtual Wallets

Get balance from a Virtual Wallet

Get movements

Get total Virtual Balances by blockchain

Get Virtual Wallet by ID

Update Virtual Wallet

Withdraw from Virtual Wallet

Card 3DS challenge

Card transaction approval

Card transaction cleared

Card transaction clearing failed

Card transaction clearing pending

Card transaction declined

Card transaction refund

Card transaction reversal

General

New deposit received

Withdraw completed

Simulate transaction approval

Simulate transaction clearing

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

Title

Description

<p class="slate-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 class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >This feature is only available on Sandbox environment</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-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.

This feature is only available on Sandbox environment

Sections

Simulate

What made this section unhelpful for you?

On this page

Sections

Simulate

What made this section unhelpful for you?

On this page

Ask an AI

Code with AI