Match2Pay

AI skill.md

Integrated systems

Crypto deposit flow

Deposit Request

Deposit Callbacks

DONE

PENDING

PARTIALLY_PAID

FAIL

DECLINED

Withdrawal Request

Withdrawal Callbacks

ADMIN_CONFIRMATION

Cryptocurrency details

Extended callback signature generation

Request signature generation

Onchain Fee

Match2Pay API documentation

Production

<p class="slate-p " >Match2Pay has built a skill that makes integrating our API faster and easier. It lets you connect our API to your system - or check how your current integration is set up - just by describing what you need in plain language to an AI assistant.</p><p class="slate-p " >This skill teaches an AI assistant (like Claude) how to work with the Match2Pay API. Instead of reading technical docs and writing code yourself, you simply say what you want to do, and the assistant handles the technical details for you.</p><h4 class="slate-h4 " >To install it:</h4><p class="slate-p " ><span class="slate-color" style="background-color:transparent;color:rgb(234, 236, 240)"><code class="slate-code" style="color:rgb(234, 236, 240)">npx skills add https://github.com/Match2Pay-Ltd/M2P-API-skill</code></span></p><p class="slate-p " ></p>

Match2Pay has built a skill that makes integrating our API faster and easier. It lets you connect our API to your system - or check how your current integration is set up - just by describing what you need in plain language to an AI assistant.

This skill teaches an AI assistant (like Claude) how to work with the Match2Pay API. Instead of reading technical docs and writing code yourself, you simply say what you want to do, and the assistant handles the technical details for you.

npx skills add https://github.com/Match2Pay-Ltd/M2P-API-skill

<h2 class="slate-h2 " >CRMs integrated with our Crypto Gateway</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Utip</div></li><li class="slate-li " ><div style="position:relative">FX Back Office</div></li><li class="slate-li " ><div style="position:relative">Skale</div></li><li class="slate-li " ><div style="position:relative">Trade Smarter</div></li><li class="slate-li " ><div style="position:relative">Kenmore design</div></li><li class="slate-li " ><div style="position:relative">TradeSoft</div></li><li class="slate-li " ><div style="position:relative">Nullpoint</div></li><li class="slate-li " ><div style="position:relative">Plugit</div></li><li class="slate-li " ><div style="position:relative">Axis (Broctagon)</div></li><li class="slate-li " ><div style="position:relative">Reltrix</div></li><li class="slate-li " ><div style="position:relative">Datalyst</div></li><li class="slate-li " ><div style="position:relative">FTT (Fair Trading Technology)</div></li><li class="slate-li " ><div style="position:relative">Leverate</div></li><li class="slate-li " ><div style="position:relative">Pheasantech</div></li><li class="slate-li " ><div style="position:relative">UpTrader</div></li><li class="slate-li " ><div style="position:relative">Syntellicore (Dynamic Works)</div></li><li class="slate-li " ><div style="position:relative">Delasport</div></li><li class="slate-li " ><div style="position:relative">TradeCore</div></li></ul><h2 class="slate-h2 " >Payment cashiers integrated with our Crypto Gateway</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="https://www.paytiko.com/" target="_blank">Paytiko</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://praxis.tech/" target="_blank">Praxis</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://bridgerpay.com/" target="_blank">BridgerPay</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://akurateco.com/" target="_blank">Akurateco</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://corefy.com/" target="_blank">Corefy</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://payprocc.com/" target="">PayProcc</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://paymaxis.com/" target="">Paymaxis</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://pay.binance.com/en" target="">Binance Pay</a></div></li></ul><h2 class="slate-h2 " >Supported wallets (coming soon)</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Trust Wallet</div></li><li class="slate-li " ><div style="position:relative">MetaMask</div></li><li class="slate-li " ><div style="position:relative">Binance Wallet</div></li><li class="slate-li " ><div style="position:relative">OKX Wallet</div></li><li class="slate-li " ><div style="position:relative">Bitget Wallet</div></li><li class="slate-li " ><div style="position:relative">TokenPocket</div></li><li class="slate-li " ><div style="position:relative">1inch Wallet</div></li><li class="slate-li " ><div style="position:relative">Best Wallet</div></li></ul><p class="slate-p " >And many more...</p>

Payment cashiers integrated with our Crypto Gateway

<div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1698752387676.png" alt="" style="width:1497px;height:623px;aspect-ratio:1497 / 623" /></div></figure></div><h2 class="slate-h2 " ></h2><h2 class="slate-h2 " >Dynamic single-use deposit flow</h2><h4 class="slate-h4 " ><strong class="slate-bold">A unique wallet address is generated per deposit request and expires after a time window.</strong></h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The client requests a deposit in the broker’s Client Office.</div></li><li class="slate-li " ><div style="position:relative">Client Office sends the request to the Match2Pay.</div></li><li class="slate-li " ><div style="position:relative">Processing request, generating individual crypto deposit wallet address.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The Match2Pay system processes the request and generates a unique cryptocurrency deposit wallet address for this individual deposit transaction.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">IMPORTANT</strong>: Wallet addresses must be newly generated each time a client initiates a new deposit. Wallet addresses are <strong class="slate-bold">single-use only</strong>; if a client deposits to a previously used address at a later time, they risk losing their funds. </div></li></ul></li><li class="slate-li " ><div style="position:relative">Displaying the Match2Pay Payment Page to the Client.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">We strongly recommend that the broker&apos;s Client Office redirects the client to the Match2Pay payment page or displays it in an Iframe.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">IMPORTANT</strong>: Generated wallet address has an expiration time. Currently, this is set to 2 hours for Bitcoin (BTC) deposits and 30 minutes for all other cryptocurrencies. <strong class="slate-bold">Clients must ensure their deposit is made to the provided address within this specific time window for the transaction to be processed successfully</strong>. <strong class="slate-bold">A 12-hour post-expiration grace period applies, deposits confirmed on-chain within this window will still be accepted and processed.</strong></div></li><li class="slate-li " ><div style="position:relative">If the client has a cryptocurrency, they can send this cryptocurrency to this individual deposit wallet address.</div></li></ul></li><li class="slate-li " ><div style="position:relative">The transaction is being processed by the blockchain.</div></li><li class="slate-li " ><div style="position:relative">After receiving the information from the blockchain about a successfully processed transaction, the cryptocurrency is being booked on the deposit wallet address.</div></li><li class="slate-li " ><div style="position:relative">Converting the cryptocurrency to FIAT. The final amount is being added to the broker’s Match2Pay balance.</div></li><li class="slate-li " ><div style="position:relative">The amount from a callback is being booked on the client’s trading account.<br><strong class="slate-bold">An important benefit of this solution is that, unlike the Static Wallet flow, there is no minimum fee applied to deposits.</strong><br>If you are unable to ensure that a unique wallet address is generated for each client deposit, or if you cannot integrate our payment page, please contact Match2Pay support.</div></li></ol><h2 class="slate-h2 " >Static wallet flow (set by default)</h2><h4 class="slate-h4 " >A reusable wallet address is assigned to a specific trading account; multiple deposits can be sent to the same address.</h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The client requests a deposit in the broker’s Client Office.</div></li><li class="slate-li " ><div style="position:relative">Client Office sends the request to the Match2Pay.</div></li><li class="slate-li " ><div style="position:relative">Processing request, generating<strong class="slate-bold"> individual crypto deposit wallet address</strong>.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">It is possible to assign generated wallet address to a particular trading account/client. Detailed guide can be found at the bottom.</div></li></ul></li><li class="slate-li " ><div style="position:relative">Returning generated crypto deposit wallet address on the payment page.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If the client has a cryptocurrency, they can send this cryptocurrency to this individual deposit wallet address.</div></li></ul></li><li class="slate-li " ><div style="position:relative">The transaction is being processed by the blockchain.</div></li><li class="slate-li " ><div style="position:relative">After receiving the information from the blockchain about a successfully processed transaction, the cryptocurrency is being booked on the deposit wallet address.</div></li><li class="slate-li " ><div style="position:relative">Converting the cryptocurrency to FIAT. The final amount is being added to the broker’s Match2Pay balance.</div></li><li class="slate-li " ><div style="position:relative">The amount from a callback is being booked on the client’s trading account.</div></li></ol><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">To correctly handle multiple deposits to the same static wallet address, your integration must be adapted as follows:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Assign </strong><code class="slate-code"><strong class="slate-bold">payment_id</strong></code><strong class="slate-bold">: </strong>The <code class="slate-code">payment_id</code> generated with the first deposit request must be assigned and stored for a particular client account on your end.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Reuse </strong><code class="slate-code"><strong class="slate-bold">payment_id</strong></code><strong class="slate-bold">: </strong>For all future deposit requests from that same client (within the same crypto gateway), you must use/display the same, originally assigned <code class="slate-code">payment_id</code>.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Handle Callbacks Correctly: </strong>A single <code class="slate-code">payment_id</code> will be associated with multiple deposits. Each deposit will have a unique transaction hash. Your system must process incoming callbacks by checking for a new, unbooked transaction hash. If you receive a callback with a known <code class="slate-code">payment_id</code> but a new hash, the transaction should be booked.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Gateway-Specific Implementation: </strong>This integration logic must be applied separately for each crypto payment gateway you use.</div></li><li class="slate-li " ><div style="position:relative">Optional - Unlink Wallet: You can optionally add a feature to unlink the wallet address (<code class="slate-code">payment_id</code>) from a selected account. This would allow a new wallet address to be generated for that client in exceptional situations.</div></li></ul><p class="slate-p " ></p>

A unique wallet address is generated per deposit request and expires after a time window.

A reusable wallet address is assigned to a specific trading account; multiple deposits can be sent to the same address.

To correctly handle multiple deposits to the same static wallet address, your integration must be adapted as follows:

<p class="slate-p " >This request is responsible for generating a new deposit wallet address for cryptocurrency transactions and providing a link to the payment page. It is a valuable tool for users who wish to make a deposit or payment using cryptocurrencies. </p><p class="slate-p " ><strong class="slate-bold">Important information:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">On live environment, there is a need to provide IP addresses to whitelist to be able to send requests</div></li><li class="slate-li " ><div style="position:relative">Under one paymentID there can be more than one transaction. </div></li></ul><p class="slate-p " ><strong class="slate-bold">Crypto selection flow (2-step payment page)</strong></p><p class="slate-p " >When a deposit request is created without a preselected cryptocurrency (<code class="slate-code">&quot;paymentCurrency&quot;</code><span class="slate-color" style="color:rgb(0, 211, 189)"> </span>and <code class="slate-code">&quot;paymentGatewayName&quot;</code>), the user is redirected to a two-step payment page:</p><p class="slate-p " >Step I – Cryptocurrency selection – the user chooses which currency to use.</p><p class="slate-p " >Step II – Payment details – the user sees the address, amount and completes the deposit.</p><p class="slate-p " >The user may navigate back from Step II to Step I to select a different cryptocurrency.<br>In this case, a single deposit request can have multiple deposit addresses associated with it, one per selected cryptocurrency.</p><p class="slate-p " >If <code class="slate-code">&quot;paymentCurrency&quot;</code><span class="slate-color" style="color:rgb(0, 211, 189)"> </span>and <code class="slate-code">&quot;paymentGatewayName&quot;</code> are provided, the user is redirected directly to the payment details. </p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Fixed wallet</strong></p><p class="slate-p " >By default, Match2Pay generates a new deposit address for each deposit request.<br>For gateways using the <code class="slate-code">&quot;CRYPTO_AGENT&quot;</code> method, it is possible to enable the fixed wallets feature on the gateway configuration level<br><u class="slate-underline">When fixed wallets are enabled</u>:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Match2Pay checks if there is an existing deposit address for the given client email - <code class="slate-code">&quot;email&quot;</code>parameter.</div></li><li class="slate-li " ><div style="position:relative">If an address exists, the same deposit address is returned.</div></li><li class="slate-li " ><div style="position:relative">If not, a new deposit address is generated and linked to this email for future requests.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Deposit endpoint:</strong> /api/v2/payment/deposit</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">HTTP method:</strong> POST</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Request content:</strong> JSON object</p><p class="slate-p slate-indent-0" style="0px"><br><strong class="slate-bold">Binance Pay integration: </strong>To use the Binance Pay gateway, you must set <code class="slate-code">&quot;paymentGatewayName&quot;</code> parameter to <code class="slate-code">“USDT_BINANCE”</code> and set the <code class="slate-code">“paymentCurrency”</code> parameter to <code class="slate-code">“USX”</code>.<br>Note: This configuration unlocks multiple cryptocurrency options for the user on the payment page.</p><div class="slate-div"></div><p class="slate-p " ></p><h2 class="slate-h2 " >Statuses of deposit requests</h2><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div data-column-id="column-0" style="width:initial;">Title</div><div data-column-id="column-1" style="width:429px;">Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:429px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">NEW</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction has been initiated<br>(for example, the user displayed the wallet address to deposit)</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">PENDING</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction is processing.<br>This status is temporary. It should change to DONE after receiving confirmation/response from the blockchain and passing the compliance verification.</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DECLINED</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">This status may be assigned automatically by our scoring system if the transaction does not pass compliance verification. </strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">FAIL</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction has failed in the blockchain</strong> <strong class="slate-bold">or an error occurred while it was being processed.</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DONE</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction is done. The funds are booked</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SUSPECTED</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">The transaction is under review by our scoring system. This status indicates that additional compliance verification is required before the transaction can be processed further.</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">PARTIALLY PAID</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">The received amount is less than the requested amount. An additional payment covering the missing balance is required for the transaction status to change to DONE</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">REVERSED</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">The transaction has been reversed after being rejected by the scoring system and assigned a DECLINED status. This action can be performed by an authorized administrator through the Compliance Rejections section, allowing the transaction to proceed despite the initial rejection.</strong></p></td></tr></tbody></table></div></div><p class="slate-p " ></p>

This request is responsible for generating a new deposit wallet address for cryptocurrency transactions and providing a link to the payment page. It is a valuable tool for users who wish to make a deposit or payment using cryptocurrencies. 

Crypto selection flow (2-step payment page)

When a deposit request is created without a preselected cryptocurrency (

), the user is redirected to a two-step payment page:

Step I – Cryptocurrency selection – the user chooses which currency to use.

Step II – Payment details – the user sees the address, amount and completes the deposit.

The user may navigate back from Step II to Step I to select a different cryptocurrency.
In this case, a single deposit request can have multiple deposit addresses associated with it, one per selected cryptocurrency.

 are provided, the user is redirected directly to the payment details. 

By default, Match2Pay generates a new deposit address for each deposit request.
For gateways using the 

 method, it is possible to enable the fixed wallets feature on the gateway configuration level


To use the Binance Pay gateway, you must set 

.
Note: This configuration unlocks multiple cryptocurrency options for the user on the payment page.

Title

Description

The requested deposit amount in the currency provided in "currency" param

amount

Your API token - it will be provided by support

apiToken

Notification URL to send updates of payment status

callbackUrl

Symbol of currency to which currency deposit should be converted
Use the paymentCurrency from Cryptocurrency details section

currency

Currency in which transaction will be booked on Match2Pay balance

balanceCurrency

The order of parameters in the "customer" object must be exactly as specified in the documentation; otherwise, the request will not be processed successfully

customer

The URL to redirect the user in case of a failed transaction

failureUrl

Optional (direct specific payment details flow). The currency of the payment gateway
All currency symbols are described in the Cryptocurrency Details section

paymentCurrency

Optional (direct specific payment details flow). Name of payment gateway that will be used for deposit (e.g., USDT TRC20)
All available payment gateways are described in the Cryptocurrency Details section.

paymentGatewayName

The method of payment used for the transaction. 
For cryptocurrency gateways it is always CRYPTO_AGENT 
For PSP gateways, please ask support what paymentMethod you should use

paymentMethod

The URL to redirect the user upon a successful transaction

successUrl

timestamp

The signature generated from the request body and API secret

All necessary information to generate a valid signature can be found in the Signature section

signature

address

Unique id of the payment transaction in the Match2Pay

paymentId

status

transactionAmount

transactionCurrency

netAmount

finalAmount

Symbol of currency to which deposited currency was converted

finalCurrency

processingFee

Match2Pay page URL. The client should be redirected to this URL

checkoutUrl

errorList

totalInCryptoCurrency

totalInAccountCurrency

feeInAccountCurrency

Expiration time of the wallet address in UTC

expiration

URLs to the exchangers where you can redirect the user to make the crypto purchase through exchanger

exchangerLinks

<p class="slate-p " >Match2Pay sends a callback to your callbackUrl every time the status of a deposit changes. Each status below has its own subsection with an example callback body.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DONE</strong> - the transaction is done and the funds are booked.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PENDING</strong> - the transaction appeared in the blockchain and is being processed. This status is temporary and changes to DONE after blockchain confirmation and compliance verification.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PARTIALLY_PAID</strong> - the received amount is lower than the requested one. An additional payment covering the missing balance is required for the status to change to DONE.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">FAIL</strong> - the transaction failed in the blockchain or an error occurred while it was being processed.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DECLINED</strong> - the transaction was rejected, e.g. it did not pass compliance verification. The same status is sent when a declined deposit is reversed.</div></li></ul><p class="slate-p " ></p>

Match2Pay sends a callback to your callbackUrl every time the status of a deposit changes. Each status below has its own subsection with an example callback body.

depositAddress

cryptoTransactionInfo

The unique request identifier in Match2Pay.

The current status of the entire request.

Sum of the amount field across all objects in cryptoTransactionInfo where status = DONE.

Sum of (amount - processingFee) for transaction with status DONE.

The currency of the crypto gateway associated with the request. If any of the transactions had the wrong coin sent, this field returns null.

Sum of processingFee across all transactions in cryptoTransactionInfo with status DONE.

The currency in which the requested amount (finalAmount) is expressed.

The exchange rate transactionCurrency → finalCurrency.

conversionRate

The currency to which the funds are booked on the merchant's Match2Pay balance.

settlementCurrency

The amount that will be booked to the merchant's balance.

settlementAmount

Callback body

<p class="slate-p " >The transaction is done and the funds are booked on the merchant&apos;s balance. This callback is sent after the funds are correctly booked.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

The transaction is done and the funds are booked on the merchant's balance. This callback is sent after the funds are correctly booked.

Unique id of the payment transaction in the Match2Pay.

The currency to which the funds are booked on the merchant's Match2Pay balance. Null until the transaction is booked.

The amount that will be booked to the merchant's balance. Null until the transaction is booked.

<p class="slate-p " >Sent after the transaction appears in the blockchain. The transaction is being processed. This status is temporary and changes to DONE after blockchain confirmation and compliance verification.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

Sent after the transaction appears in the blockchain. The transaction is being processed. This status is temporary and changes to DONE after blockchain confirmation and compliance verification.

The current status of the entire request. PARTIALLY_PAID means the received amount is lower than the requested amount (finalAmount).

The amount that is booked to the merchant's balance.

<p class="slate-p " >The received amount is lower than the requested one. An additional payment covering the missing balance is required for the status to change to DONE.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

The received amount is lower than the requested one. An additional payment covering the missing balance is required for the status to change to DONE.

The current status of the entire request. FAIL means the request ended unsuccessfully.

The amount that would be booked to the merchant's balance.

<p class="slate-p " >The transaction failed in the blockchain or an error occurred while it was being processed.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

The transaction failed in the blockchain or an error occurred while it was being processed.

The current status of the entire request. DECLINED means the request was declined (including reversed deposits).

<p class="slate-p " >The transaction was rejected, e.g. it did not pass compliance verification. The same status is sent when a declined deposit is reversed.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

The transaction was rejected, e.g. it did not pass compliance verification. The same status is sent when a declined deposit is reversed.

<p class="slate-p " >A withdrawal request is a fundamental process that facilitates the transfer of cryptocurrency funds from one&apos;s wallet to an external recipient&apos;s address.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Endpoint:</strong> /api/v2/payment/withdrawal</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">HTTP method:</strong> POST</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Request Content:</strong> JSON Object</p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><h2 class="slate-h2 " >Statuses of withdrawal requests</h2><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div data-column-id="03ab7b58-aa02-4b1b-a5b7-e2a2465940c4" >Title</div><div data-column-id="ceec7aae-d9b1-4379-9b5f-ba1583547623" >Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">NEW</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction has been initiated</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ADMIN CONFIRMATION</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction needs to be confirmed by Support</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">PENDING</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction is processing.<br>This status is temporary. It should change to DONE or DECLINED after receiving confirmation/response from the blockchain</strong> <strong class="slate-bold">and compliance verification system.</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DECLINED</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction has been rejected. This status mainly occurs in these scenarios:<br>- a transaction requiring admin confirmation is declined by an authorized administrator or by our team.<br>- the transaction does not pass compliance verification.<br>- there are not enough funds on the merchant balance to process the transaction.</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DONE</strong></p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">The transaction is done. The funds are booked</strong>.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">FAIL</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">The transaction has failed</strong>. <strong class="slate-bold">This status is not final – it can be reprocessed within the same paymentID.</strong></p></td></tr></tbody></table></div></div><p class="slate-p " ></p>

A withdrawal request is a fundamental process that facilitates the transfer of cryptocurrency funds from one's wallet to an external recipient's address.

The amount the client wants to withdraw in the currency specified in the currency parameter

Notification about changes in payment status will be sent to this URL

The wallet address of the end user to which they want to withdraw funds

The wallet address must match the network of the paymentCurrency

cryptoAddress

Symbol of currency of client's account.

In that currency funds will be taken from your Match2Pay balance

The symbol of the currency that will be withdrawn (e.g. USX)

All currency symbols are described in the Cryptocurrency details section

Name of the payment gateway that will be used for withdrawal (e.g., USDT TRC20)

All available payment gateways are described in the Cryptocurrency details section.

The method of payment used for the transaction. 
For crypto gateways it is always CRYPTO_AGENT 

For PSP methods please ask support what method to use

The signature generated from the request body and API secret

All necessary information to generate a valid signature can be found in the Request signature generation section

Content-Type

The unique request identifier in Match2Pay. It helps you find this transaction in the Match2Pay dashboard.

The status of the request at the moment of sending it.

The amount to be withdrawn, expressed in transactionCurrency.

The currency of the crypto gateway used for the withdrawal.

The amount sent to the recipient: amount minus processingFee, expressed in transactionCurrency.

The fee charged for the transaction, expressed in transactionCurrency.

List of errors. Empty if the request was accepted.

Destination wallet address to which the funds are sent.

Temporary transaction identifier used for Match2Pay internal identification.

tempTransactionId

<p class="slate-p " >Match2Pay sends a callback to your callbackUrl every time the status of a withdrawal changes. Each status below has its own subsection with an example callback body.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DONE</strong> - the transaction is confirmed on-chain and the funds are booked.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PENDING</strong> - the transaction appeared in the blockchain and is being processed. This status is temporary and changes to DONE or DECLINED after blockchain confirmation and compliance verification.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">ADMIN_CONFIRMATION</strong> - the request is waiting for confirmation by an authorized administrator or Support.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">FAIL</strong> - the transaction has failed. This status is not final - it can be reprocessed within the same paymentId.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DECLINED</strong> - the transaction was rejected: declined by an administrator or our team, did not pass compliance verification, or there are not enough funds on the merchant balance.</div></li></ul><p class="slate-p " ></p>

Match2Pay sends a callback to your callbackUrl every time the status of a withdrawal changes. Each status below has its own subsection with an example callback body.

<h3 class="slate-h3 " >Please make sure you send cryptocurrency from the list below and use a network supported by Match2pay.<br>Sending funds via an unsupported token or network may result in loss of funds.</h3><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div data-column-id="column-0" style="width:initial;">Title</div><div data-column-id="column-1" style="width:325px;">Description</div><div data-column-id="column-2" style="width:755px;">Title</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:325px"><col style="width:755px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">cryptocurrency</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">paymentCurrency</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">paymentGatewayName</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Bitcoin</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTC</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTC</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Ethereum (only Ethereum network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT ERC20 (only Ethereum network) <strong class="slate-bold">min amount 5 USDT!</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UST</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC ERC20 (only Ethereum network) <strong class="slate-bold">min amount 5 USDC!</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCC</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >DAI ERC20 (only Ethereum network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAE</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAI ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">SHIBA INU ERC20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SHB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SHIBA INU ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">BTC ERC20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTE</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTC ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Coinbase Wrapped BTC ERC20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">CTC</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">CBBTC ERC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Tronix - TRX <strong class="slate-bold">[Deposits only] min amount 1.5 TRX!</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">TRX</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">TRX</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">USDT TRC20 - <strong class="slate-bold">min amount 1 USDT!</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USX</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT TRC20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Binance Coin (only BSC network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BNB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BNB</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT BEP20 (only BSC network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC BEP20 (only BSC network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >DAI BEP20 (only BSC network)</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAI BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">BTC BEP20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BTC BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >ETH BEP20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >SHIBA INU BEP20 <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SHH</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SHIBA INU BEP20</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">MATIC<strong class="slate-bold"> [Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">MAT</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">MATIC</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT Polygon</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USP</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT POLYGON</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">USDC Polygon <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCP</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC POLYGON</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >DAI Polygon</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAP</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAI POLYGON</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">XRP<strong class="slate-bold"> [Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">XRP</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">XRP</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Dogecoin <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DOG</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DOGECOIN</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Litecoin</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">LTC</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">LTC</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Solana <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SOL</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">SOL</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT Solana</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USS</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT SOL</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC Solana</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCS</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC SOL</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >DAI Solana</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAS</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DAI SOLANA</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">ETH BASE <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BST</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH BASE</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC BASE</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UBC</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC BASE</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">USDT BASE <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UTB</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT BASE</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">ETH OPTIMISM <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETO</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH OPTIMISM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT OPTIMISM</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UTO</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT OPTIMISM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC OPTIMISM</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCO</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC OPTIMISM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">ETH ARBITRUM <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETA</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ETH ARBITRUM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT ARBITRUM</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UTA</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT ARBITRUM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC ARBITRUM</p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">UCA</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDC ARBITRUM</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >BNB OPBNB <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BNO</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">BNB OPBNB</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT OPBNB  <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USO</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT OPBNB</strong></p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Binance Pay (multiple currencies) <strong class="slate-bold">[Deposits only]</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USX</strong></p></td><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">USDT_BINANCE</strong></p></td></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">For withdrawals</strong>, there are 3 types of BTC addresses supported by our system:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Legacy – starting with “1”</div></li><li class="slate-li " ><div style="position:relative">Script – starting with “3”</div></li><li class="slate-li " ><div style="position:relative">Segwit – starting with “bc1q”</div></li></ul><p class="slate-p " >For the test environment, we provide Bitcoin and USDT TRC20 gateways.</p><p class="slate-p " ></p><p class="slate-p " >For withdrawals, Match2Pay supports both options: with or without a memo. </p><p class="slate-p " >To withdraw without a memo, simply enter the wallet address as usual. </p><p class="slate-p " >If a memo is required, use the format <code class="slate-code">walletAddress;memo</code>, for example:</p><p class="slate-p " ><code class="slate-code">&quot;address&quot;: &quot;UQANXiRA9BhsOAcuaQ30L7W2StlboH2p9_eOxf4VB1ohz0v6;1708317974&quot;</code><br><br><br><br><br><br><br><br></p><p class="slate-p " ></p>

Please make sure you send cryptocurrency from the list below and use a network supported by Match2pay.
Sending funds via an unsupported token or network may result in loss of funds.

, there are 3 types of BTC addresses supported by our system:

For the test environment, we provide Bitcoin and USDT TRC20 gateways.

For withdrawals, Match2Pay supports both options: with or without a memo. 

To withdraw without a memo, simply enter the wallet address as usual. 

"address": "UQANXiRA9BhsOAcuaQ30L7W2StlboH2p9_eOxf4VB1ohz0v6;1708317974"

Value of transactions in the transactions currency

That value should NOT be used to book deposits.

transactionAmount after processsing fee deduction.

Currency in which we will return the finalAmount.

Conversion rate from transactionCurrency to finalCurrency.

Example

<p class="slate-p " ><strong class="slate-bold">Important note:</strong> Callback extended signature will be sent for every status and transaction type.</p><p class="slate-p " >To ensure that a callback sent from the Match2Pay system wasn&apos;t already used for transaction verification you can optionally check the extended callback signature. To do this you have to build the HMAC-SHA384 hash by adding the callback&apos;s full body content and API secret in this order:<br><code class="slate-code">{ raw callback body without white spaces } + ‘apisecret’</code></p><p class="slate-p " >It&apos;s important to mention that signature will be received in <strong class="slate-bold">Headers</strong> under <strong class="slate-bold">X-M2P-Extended-Signature</strong> field.</p><p class="slate-p " ><strong class="slate-bold">Example:</strong><br>In this case { raw callback body without white spaces } + ‘apisecret’<br>string will look like this:<br><code class="slate-code">{&quot;depositAddress&quot;:&quot;mhuLyXBc9CJfFu6KDpsMNaeiqxR5GZzMsH&quot;,&quot;cryptoTransactionInfo&quot;:[{&quot;txid&quot;:&quot;55609bc1c2d3c4746e5f391a226144ed4ab369432adcef617e48d77826a92c1d&quot;,&quot;confirmations&quot;:1,&quot;amount&quot;:0.00011873,&quot;confirmedTime&quot;:&quot;May18,20231:51:47PM&quot;,&quot;status&quot;:&quot;DONE&quot;,&quot;processingFee&quot;:0.00000119,&quot;conversionRate&quot;:27233.9}],&quot;paymentId&quot;:&quot;4d42212c-8ac3-40c1-bc71-0770f522a9a9&quot;,&quot;status&quot;:&quot;DONE&quot;,&quot;transactionAmount&quot;:0.00011873,&quot;netAmount&quot;:0.00011754,&quot;transactionCurrency&quot;:&quot;BTC&quot;,&quot;processingFee&quot;:0.00000119,&quot;finalAmount&quot;:3.2,&quot;finalCurrency&quot;:&quot;USD&quot;,&quot;conversionRate&quot;:27233.9}apisecret</code></p><p class="slate-p " >The HMAC-SHA384 hash built with this string will look like this:<br><code class="slate-code">73a65b2c22174d71ece96072193a8ee67b8c0f81e58444e7d0c1fd79a90308186c33c4c6800345d8369a20cb608c0f53</code></p><div class="data-example-widget"></div><p class="slate-p " ></p>

 Callback extended signature will be sent for every status and transaction type.

To ensure that a callback sent from the Match2Pay system wasn't already used for transaction verification you can optionally check the extended callback signature. To do this you have to build the HMAC-SHA384 hash by adding the callback's full body content and API secret in this order:


{ raw callback body without white spaces } + ‘apisecret’

It's important to mention that signature will be received in 


In this case { raw callback body without white spaces } + ‘apisecret’
string will look like this:


{"depositAddress":"mhuLyXBc9CJfFu6KDpsMNaeiqxR5GZzMsH","cryptoTransactionInfo":[{"txid":"55609bc1c2d3c4746e5f391a226144ed4ab369432adcef617e48d77826a92c1d","confirmations":1,"amount":0.00011873,"confirmedTime":"May18,20231:51:47PM","status":"DONE","processingFee":0.00000119,"conversionRate":27233.9}],"paymentId":"4d42212c-8ac3-40c1-bc71-0770f522a9a9","status":"DONE","transactionAmount":0.00011873,"netAmount":0.00011754,"transactionCurrency":"BTC","processingFee":0.00000119,"finalAmount":3.2,"finalCurrency":"USD","conversionRate":27233.9}apisecret

The HMAC-SHA384 hash built with this string will look like this:


73a65b2c22174d71ece96072193a8ee67b8c0f81e58444e7d0c1fd79a90308186c33c4c6800345d8369a20cb608c0f53

Python

<p class="slate-p " >All signatures are valid for one minute after creation.</p><p class="slate-p " >API token and API secret key are provided by Match-Trade.</p><p class="slate-p " ><strong class="slate-bold">Algorithm</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Take all the keys from your deposit or withdrawal request and sort them in A-Z order</div></li><li class="slate-li " ><div style="position:relative">Concatenate the values according to the order of keys from the first step</div></li><li class="slate-li " ><div style="position:relative">Append the API secret key to the concatenated string from the second step</div></li><li class="slate-li " ><div style="position:relative">Build the sha384 hash of the string from the third step</div></li></ol><p class="slate-p " ><strong class="slate-bold">Example</strong></p><p class="slate-p " >API secret key: <span class="slate-color" style="background-color:rgb(31, 31, 31);color:rgb(206, 145, 120)">ApiSecretProvidedBySupport</span></p><div class="code-block-wrapper"  style="width:100%" ><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">{
  &quot;amount&quot;: 10,
  &quot;apiToken&quot;: &quot;ApiTokenProvidedBySupport&quot;,
  &quot;callbackUrl&quot;: &quot;http://test/deposit/callback&quot;,
  &quot;currency&quot;: &quot;USD&quot;,
  &quot;customer&quot;: {
    &quot;firstName&quot;: &quot;firstName_4da0af01617c&quot;,
    &quot;lastName&quot;: &quot;lastName_801eb285edd1&quot;,
    &quot;address&quot;: {
      &quot;address&quot;: &quot;address_52c10ed842fb&quot;,
      &quot;city&quot;: &quot;city_62da6faaeb17&quot;,
      &quot;country&quot;: &quot;country_a6be7ed127cc&quot;,
      &quot;zipCode&quot;: &quot;zipCode_3e168862ef49&quot;,
      &quot;state&quot;: &quot;state_b8d531055c90&quot;
    },
    &quot;contactInformation&quot;: {
      &quot;email&quot;: &quot;email_e4ac63093536&quot;,
      &quot;phoneNumber&quot;: &quot;phoneNumber_8fcb0237f7ee&quot;
    },
    &quot;locale&quot;: &quot;en_US&quot;,
    &quot;dateOfBirth&quot;: &quot;dateOfBirth_338c08d95dd6&quot;,
    &quot;tradingAccountLogin&quot;: &quot;clientId_d6811bff2963&quot;,
    &quot;tradingAccountUuid&quot;: &quot;clientUid_56b798ba2ae2&quot;
  },
  &quot;failureUrl&quot;: &quot;http://test/failed-payment&quot;,
  &quot;paymentCurrency&quot;: &quot;USX&quot;,
  &quot;paymentGatewayName&quot;: &quot;USDT TRC20&quot;,
  &quot;paymentMethod&quot;: &quot;CRYPTO_AGENT&quot;,
  &quot;successUrl&quot;: &quot;http://test/thanku&quot;,
  &quot;timestamp&quot;: &quot;1764149779000&quot; 
}
</textarea><code class="language-plainText keep-markup drop-tokens">{
  &quot;amount&quot;: 10,
  &quot;apiToken&quot;: &quot;ApiTokenProvidedBySupport&quot;,
  &quot;callbackUrl&quot;: &quot;http://test/deposit/callback&quot;,
  &quot;currency&quot;: &quot;USD&quot;,
  &quot;customer&quot;: {
    &quot;firstName&quot;: &quot;firstName_4da0af01617c&quot;,
    &quot;lastName&quot;: &quot;lastName_801eb285edd1&quot;,
    &quot;address&quot;: {
      &quot;address&quot;: &quot;address_52c10ed842fb&quot;,
      &quot;city&quot;: &quot;city_62da6faaeb17&quot;,
      &quot;country&quot;: &quot;country_a6be7ed127cc&quot;,
      &quot;zipCode&quot;: &quot;zipCode_3e168862ef49&quot;,
      &quot;state&quot;: &quot;state_b8d531055c90&quot;
    },
    &quot;contactInformation&quot;: {
      &quot;email&quot;: &quot;email_e4ac63093536&quot;,
      &quot;phoneNumber&quot;: &quot;phoneNumber_8fcb0237f7ee&quot;
    },
    &quot;locale&quot;: &quot;en_US&quot;,
    &quot;dateOfBirth&quot;: &quot;dateOfBirth_338c08d95dd6&quot;,
    &quot;tradingAccountLogin&quot;: &quot;clientId_d6811bff2963&quot;,
    &quot;tradingAccountUuid&quot;: &quot;clientUid_56b798ba2ae2&quot;
  },
  &quot;failureUrl&quot;: &quot;http://test/failed-payment&quot;,
  &quot;paymentCurrency&quot;: &quot;USX&quot;,
  &quot;paymentGatewayName&quot;: &quot;USDT TRC20&quot;,
  &quot;paymentMethod&quot;: &quot;CRYPTO_AGENT&quot;,
  &quot;successUrl&quot;: &quot;http://test/thanku&quot;,
  &quot;timestamp&quot;: &quot;1764149779000&quot; 
}
</code></pre></div><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The string from this request body is: <code class="slate-code">10ApiTokenProvidedBySupporthttp://test/deposit/callbackUSD{firstName=firstName_4da0af01617c, lastName=lastName_801eb285edd1, address={address=address_52c10ed842fb, city=city_62da6faaeb17, country=country_a6be7ed127cc, zipCode=zipCode_3e168862ef49, state=state_b8d531055c90}, contactInformation={email=email_e4ac63093536, phoneNumber=phoneNumber_8fcb0237f7ee}, locale=en_US, dateOfBirth=dateOfBirth_338c08d95dd6, tradingAccountLogin=clientId_d6811bff2963, tradingAccountUuid=clientUid_56b798ba2ae2}http://test/failed-paymentUSXUSDT TRC20CRYPTO_AGENThttp://test/thanku1764149779000</code></div></li><li class="slate-li " ><div style="position:relative">Then we append the secret key at the end and we receive: <code class="slate-code">10ApiTokenProvidedBySupporthttp://test/deposit/callbackUSD{firstName=firstName_4da0af01617c, lastName=lastName_801eb285edd1, address={address=address_52c10ed842fb, city=city_62da6faaeb17, country=country_a6be7ed127cc, zipCode=zipCode_3e168862ef49, state=state_b8d531055c90}, contactInformation={email=email_e4ac63093536, phoneNumber=phoneNumber_8fcb0237f7ee}, locale=en_US, dateOfBirth=dateOfBirth_338c08d95dd6, tradingAccountLogin=clientId_d6811bff2963, tradingAccountUuid=clientUid_56b798ba2ae2}http://test/failed-paymentUSXUSDT TRC20CRYPTO_AGENThttp://test/thanku1764149779000ApiSecretProvidedBySupport</code></div></li><li class="slate-li " ><div style="position:relative">Then we use sha-384 to generate a hash from this string and we receive our final signature value: <code class="slate-code">e058a6fb0d310335985f69d686ae47bdf1c34ad33bcafd83852b6034d8eb3254e7d300a63590f815baf2fe3d8eff11ec</code><br>Please remember that signature must have <strong class="slate-bold">lowercase letters</strong>.</div></li><li class="slate-li " ><div style="position:relative">We add it to the request body in the signature field. The final request body is:</div></li></ol><div class="code-block-wrapper"  style="width:100%" ><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">{
  &quot;amount&quot;: 10,
  &quot;apiToken&quot;: &quot;ApiTokenProvidedBySupport&quot;,
  &quot;callbackUrl&quot;: &quot;http://test/deposit/callback&quot;,
  &quot;currency&quot;: &quot;USD&quot;,
  &quot;customer&quot;: {
    &quot;firstName&quot;: &quot;firstName_4da0af01617c&quot;,
    &quot;lastName&quot;: &quot;lastName_801eb285edd1&quot;,
    &quot;address&quot;: {
      &quot;address&quot;: &quot;address_52c10ed842fb&quot;,
      &quot;city&quot;: &quot;city_62da6faaeb17&quot;,
      &quot;country&quot;: &quot;country_a6be7ed127cc&quot;,
      &quot;zipCode&quot;: &quot;zipCode_3e168862ef49&quot;,
      &quot;state&quot;: &quot;state_b8d531055c90&quot;
    },
    &quot;contactInformation&quot;: {
      &quot;email&quot;: &quot;email_e4ac63093536&quot;,
      &quot;phoneNumber&quot;: &quot;phoneNumber_8fcb0237f7ee&quot;
    },
    &quot;locale&quot;: &quot;en_US&quot;,
    &quot;dateOfBirth&quot;: &quot;dateOfBirth_338c08d95dd6&quot;,
    &quot;tradingAccountLogin&quot;: &quot;clientId_d6811bff2963&quot;,
    &quot;tradingAccountUuid&quot;: &quot;clientUid_56b798ba2ae2&quot;
  },
  &quot;failureUrl&quot;: &quot;http://test/failed-payment&quot;,
  &quot;paymentCurrency&quot;: &quot;USX&quot;,
  &quot;paymentGatewayName&quot;: &quot;USDT TRC20&quot;,
  &quot;paymentMethod&quot;: &quot;CRYPTO_AGENT&quot;,
  &quot;successUrl&quot;: &quot;http://test/thanku&quot;,
  &quot;timestamp&quot;: &quot;1764149779000&quot;,
  &quot;signature&quot;: &quot;e058a6fb0d310335985f69d686ae47bdf1c34ad33bcafd83852b6034d8eb3254e7d300a63590f815baf2fe3d8eff11ec&quot;
}
</textarea><code class="language-plainText keep-markup drop-tokens">{
  &quot;amount&quot;: 10,
  &quot;apiToken&quot;: &quot;ApiTokenProvidedBySupport&quot;,
  &quot;callbackUrl&quot;: &quot;http://test/deposit/callback&quot;,
  &quot;currency&quot;: &quot;USD&quot;,
  &quot;customer&quot;: {
    &quot;firstName&quot;: &quot;firstName_4da0af01617c&quot;,
    &quot;lastName&quot;: &quot;lastName_801eb285edd1&quot;,
    &quot;address&quot;: {
      &quot;address&quot;: &quot;address_52c10ed842fb&quot;,
      &quot;city&quot;: &quot;city_62da6faaeb17&quot;,
      &quot;country&quot;: &quot;country_a6be7ed127cc&quot;,
      &quot;zipCode&quot;: &quot;zipCode_3e168862ef49&quot;,
      &quot;state&quot;: &quot;state_b8d531055c90&quot;
    },
    &quot;contactInformation&quot;: {
      &quot;email&quot;: &quot;email_e4ac63093536&quot;,
      &quot;phoneNumber&quot;: &quot;phoneNumber_8fcb0237f7ee&quot;
    },
    &quot;locale&quot;: &quot;en_US&quot;,
    &quot;dateOfBirth&quot;: &quot;dateOfBirth_338c08d95dd6&quot;,
    &quot;tradingAccountLogin&quot;: &quot;clientId_d6811bff2963&quot;,
    &quot;tradingAccountUuid&quot;: &quot;clientUid_56b798ba2ae2&quot;
  },
  &quot;failureUrl&quot;: &quot;http://test/failed-payment&quot;,
  &quot;paymentCurrency&quot;: &quot;USX&quot;,
  &quot;paymentGatewayName&quot;: &quot;USDT TRC20&quot;,
  &quot;paymentMethod&quot;: &quot;CRYPTO_AGENT&quot;,
  &quot;successUrl&quot;: &quot;http://test/thanku&quot;,
  &quot;timestamp&quot;: &quot;1764149779000&quot;,
  &quot;signature&quot;: &quot;e058a6fb0d310335985f69d686ae47bdf1c34ad33bcafd83852b6034d8eb3254e7d300a63590f815baf2fe3d8eff11ec&quot;
}
</code></pre></div><p class="slate-p " ><strong class="slate-bold">Algorithm for creating the signature</strong></p><p class="slate-p " >This Python script generates a SHA-384 signature from a structured request body and an API secret. It is designed to ensure data integrity by concatenating specific request parameters in a defined order and hashing them.</p><div class="data-example-widget"></div><p class="slate-p " ></p>

All signatures are valid for one minute after creation.

API token and API secret key are provided by Match-Trade.

This Python script generates a SHA-384 signature from a structured request body and an API secret. It is designed to ensure data integrity by concatenating specific request parameters in a defined order and hashing them.

<p class="slate-p " >Onchain fees are charges associated with processing cryptocurrency transactions on their respective blockchain networks. </p><p class="slate-p " >Match2Pay applies fixed onchain fees to:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Direct settlement withdrawals</strong> </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Client withdrawals</strong>, if specified in the agreement</div></li></ul><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div data-column-id="5f834540-424c-451c-b0ea-bf83bc0b76b3" style="width:195px;">Cryptocurrency</div><div data-column-id="8b41cc6d-6431-497e-befa-d98a8a8dd369" style="width:225px;"> Network</div><div data-column-id="d28bfa66-c14b-4613-a89c-0f375650e98a" style="width:224px;">Onchain Fee</div></div><table class="slate-table" style="width:644px;min-width:644px;table-layout:fixed;"><colgroup ><col style="width:195px"><col style="width:225px"><col style="width:224px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >BTC</p></td><td class="slate-td"><p class="slate-p " >Bitcoin</p></td><td class="slate-td"><p class="slate-p " >0.00004 BTC</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >ETH</p></td><td class="slate-td"><p class="slate-p " >Ethereum</p></td><td class="slate-td"><p class="slate-p " >0.001 ETH</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >BNB</p></td><td class="slate-td"><p class="slate-p " >Binance Chain</p></td><td class="slate-td"><p class="slate-p " >0.0005 BNB</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >MATIC</p></td><td class="slate-td"><p class="slate-p " >Polygon</p></td><td class="slate-td"><p class="slate-p " >0.5 MATIC</p></td></tr></tbody></table></div></div><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div data-column-id="10bfd6db-6061-40d6-8188-576154542f3b" style="width:195px;">Stablecoin</div><div data-column-id="c331cdfa-987d-41be-8436-9c6d8d842255" style="width:226px;">Network</div><div data-column-id="9d34af4e-6274-4a78-944f-8571ed93b792" style="width:224px;">Onchain Fee</div></div><table class="slate-table" style="width:645px;min-width:645px;table-layout:fixed;"><colgroup ><col style="width:195px"><col style="width:226px"><col style="width:224px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT</p></td><td class="slate-td"><p class="slate-p " >TRC20</p></td><td class="slate-td"><p class="slate-p " >2.5 USDT</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT</p></td><td class="slate-td"><p class="slate-p " >BEP20</p></td><td class="slate-td"><p class="slate-p " >1 USDT</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT</p></td><td class="slate-td"><p class="slate-p " >ERC20</p></td><td class="slate-td"><p class="slate-p " >2.5 USDT</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDT</p></td><td class="slate-td"><p class="slate-p " >POLYGON</p></td><td class="slate-td"><p class="slate-p " >1 USDT</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC</p></td><td class="slate-td"><p class="slate-p " >BEP20</p></td><td class="slate-td"><p class="slate-p " >1 USDC</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC</p></td><td class="slate-td"><p class="slate-p " >ERC20</p></td><td class="slate-td"><p class="slate-p " >2.5 USDC</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >USDC</p></td><td class="slate-td"><p class="slate-p " >POLYGON</p></td><td class="slate-td"><p class="slate-p " >1 USDC</p></td></tr></tbody></table></div></div><p class="slate-p " ></p>

Onchain fees are charges associated with processing cryptocurrency transactions on their respective blockchain networks. 

Sections