Ari10

Welcome to Ari10 Payment Docs

Getting Started

Getting Ari10 transactionId 

Calculating signature required for obtaining Ari10 transactionId

Example of a proper Ari10 Transaction ID callout

Passing custom parameters

Payment Methods

Rendering the Ari10 Gateway

Chosing layout

Disabling Ari10 Logo

Custom events to use

When user closes popup

Webhooks / Callbacks

Webhooks and custom params

Get Ari10 Transaction status

Testing the implementation

OpenAPI definition

Ari10 Payment Gateway Api Documentation

Production

Sandbox / Test

<p class="slate-p" placeholder="Type / for widgets">Here is all you need to know before and during implementation of Ari10 Payment Gateway into your solution.</p><h2 class="slate-h2">About Ari10 Payment Gateway 💪</h2><p class="slate-p" placeholder="Type / for widgets">Ari10 Gateway is a white-label solution that enables B2B entities to sell cryptocurrencies and Web3 goods directly on their website. To empower non-crypto and crypto-projects that undergo tokenization with new business opportunities, while simplifying the access path for their customers. Get ready! There are billions of people online who are waiting for you. Earn more. Seamlessly!</p><h2 class="slate-h2">Seamless Integration ✅</h2><p class="slate-p" placeholder="Type / for widgets">Our &quot;widget&quot; is not only easy to integrate but also to customize. Tailored set of features to meet your needs: your brand + our technology stack. With modular integration and our dedicated tech support, you won’t have to wait long to make it work. Only a few weeks and your website is ready to earn.</p><h2 class="slate-h2">Built-in compliance 🔐</h2><p class="slate-p" placeholder="Type / for widgets">With our dedicated gateway, you do not have to worry about compliance with KYC/AML standards. We handle it for you. So you can focus on your core business. A user-friendly experience / solution that reduces risk rather than blocking your visitors.</p><h2 class="slate-h2">Why this documentation? 📄</h2><p class="slate-p" placeholder="Type / for widgets">The following documentation describe step by step on how to set an integration of your solution to use Ari10 Payment Gateway capabilities</p><p class="slate-p" placeholder="Type / for widgets"></p>

Here is all you need to know before and during implementation of Ari10 Payment Gateway into your solution.

Ari10 Gateway is a white-label solution that enables B2B entities to sell cryptocurrencies and Web3 goods directly on their website. To empower non-crypto and crypto-projects that undergo tokenization with new business opportunities, while simplifying the access path for their customers. Get ready! There are billions of people online who are waiting for you. Earn more. Seamlessly!

Our "widget" is not only easy to integrate but also to customize. Tailored set of features to meet your needs: your brand + our technology stack. With modular integration and our dedicated tech support, you won’t have to wait long to make it work. Only a few weeks and your website is ready to earn.

With our dedicated gateway, you do not have to worry about compliance with KYC/AML standards. We handle it for you. So you can focus on your core business. A user-friendly experience / solution that reduces risk rather than blocking your visitors.

The following documentation describe step by step on how to set an integration of your solution to use Ari10 Payment Gateway capabilities

<p class="slate-p" placeholder="Type / for widgets">For a quick and easy installation please get yourself familiar with the following steps necessary to get you up and running.</p><h2 class="slate-h2">Implementation requirements: ✔</h2><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><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" placeholder="Type / for widgets">Solution will not work properly in an iframe window</p></div></div><ol class="slate-ol"><li class="slate-li"><div style="position:relative">Setup of your account in the Ari10 Panel which result with information containing:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">API_KEY</strong> (WidgetID)</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">SIGNATURE_SECRET</strong></div></li><li class="slate-li"><div style="position:relative">(separate set for Test and Production environments)</div></li></ul></li><li class="slate-li"><div style="position:relative">Setup of proper callback / webhook URLs in Ari10 Panel:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">START</strong> transaction webhook URL</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">CANCEL</strong> transaction webhook URL</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">PAID</strong>/<strong class="slate-bold">FINISHED</strong> transaction webhook</div></li><li class="slate-li"><div style="position:relative">(all of the callback / webhook URL&apos;s needs to be rovided by partner / merchant; all of them can be pointing towards same URL)</div></li></ul></li><li class="slate-li"><div style="position:relative">Setup of a BSC network wallet in Ari10 Panel:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">BSC network wallet (required only for the production environment)</div></li><li class="slate-li"><div style="position:relative">For other blockchains please contact us to agree on details</div></li></ul></li></ol><h2 class="slate-h2">Integration steps: 🪜</h2><ol class="slate-ol"><li class="slate-li"><div style="position:relative">Generate an Ari10 transactionId </div></li><li class="slate-li"><div style="position:relative">Display Ari10 Gateway Widget on your page with the use of previously generated Ari10 transactionId </div></li><li class="slate-li"><div style="position:relative">Listening for a callback / webhook for a confirmation of a successful transaction</div></li></ol><p class="slate-p" placeholder="Type / for widgets">Please continue following the documentation to correctly go through all of those steps.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

For a quick and easy installation please get yourself familiar with the following steps necessary to get you up and running.

Please continue following the documentation to correctly go through all of those steps.

<p>This API endpoint allows you to start a transaction for payments. This endpoint is used to start the transaction process and does not include method names such as GET or POST. </p><p></p><p></p>

This API endpoint allows you to start a transaction for payments. This endpoint is used to start the transaction process and does not include method names such as GET or POST. 

<p class="slate-p" placeholder="Type / for widgets">Depending on your agreement, multiple payment methods can be used. Out of all of them mostly used are:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">Blik fast payment method 💸</div></li><li class="slate-li"><div style="position:relative">Credit Card Payments 💳</div></li><li class="slate-li"><div style="position:relative">Apple Pay / Google Pay 📲</div></li></ol><p class="slate-p" placeholder="Type / for widgets">Blik payment method is specific for Poland and people having account in Polish banks using PLN as currency. 
To be able to enable it, one needs to select PLN as a currency while generating Ari10 transactionId. 
Using any other currency wont enable Blik as a payment.</p><h2 class="slate-h2">Transaction Limits</h2><p class="slate-p" placeholder="Type / for widgets">For the payment methods supported by Ari10 Gateway, the following minimum limits should be set:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">PLN: 100</div></li><li class="slate-li"><div style="position:relative">EUR: 25</div></li><li class="slate-li"><div style="position:relative">USD: 25</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

Depending on your agreement, multiple payment methods can be used. Out of all of them mostly used are:

Blik payment method is specific for Poland and people having account in Polish banks using PLN as currency. 
To be able to enable it, one needs to select PLN as a currency while generating Ari10 transactionId. 
Using any other currency wont enable Blik as a payment.

For the payment methods supported by Ari10 Gateway, the following minimum limits should be set:

<p>After you correctly obtained an Ari10 transactionId, the next step is to display a Ari10 Gateway.</p><div><div></div></div>

After you correctly obtained an Ari10 transactionId, the next step is to display a Ari10 Gateway.

For a proper way to display a widget, please use the following code samples.

<p>Ari10 employs webhooks, also known as callback URLs, to provide instantaneous updates on transaction statuses. Here's how it works:</p><h2>Webhook URLs Configuration.</h2><p>Partners typically offer three distinct URLs:</p><ul><li><div>Start Transaction Webhook URL</div></li><li></li></ul>

Ari10 employs webhooks, also known as callback URLs, to provide instantaneous updates on transaction statuses. Here's how it works:

Partners typically offer three distinct URLs:

Alternatively, partners can choose to provide a single URL that will be triggered for all transaction stages.

Transaction Statuses Sent Through Webhooks

For timely responses, such as account top-ups, merchants should primarily focus on the “

” status is vital for those relying on blockchain processes to conclude. However, due to potential blockchain delays, this status might be relayed up to 24 hours post the “

” status update.
In summary, while all transaction statuses are important, the “

” status is crucial for immediate actions. Ensure that the operational dynamics of blockchain are considered when waiting for the “

<p class="slate-p" placeholder="Type / for widgets">The API endpoint &quot;get /transaction/{transactionId}/status&quot; enables users to fetch the status of a specific transaction using its unique Ari 10 transactionId. This endpoint provides real-time insights into a transaction&apos;s progress and status within the Ari10 system. It&apos;s particularly vital for integrations centered on Blockchain operations beyond just payment methods. For integrations with processes like day +1 settlements, this endpoint serves as a supplementary information source. However, in such scenarios, Webhooks, especially the one indicating a PAID status, should be the primary method for acquiring transaction details.</p><h2 class="slate-h2">Types and description of Transaction Statuses</h2><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Statuses for Successful Transactions: ✅</strong></p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">STARTED</strong>”: This status is designated when the Ari10 Gateway becomes visible in a web browser window.</div></li><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">IN_PROGRESS</strong>”: This is assigned when the user embarks on the SMS verification journey.</div></li><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">PAYMENT_IN_PROGRESS</strong>”: This activates as the user steps into the phase of entering the BLIK code, furnishing credit card particulars, or other pertinent data contingent on the elected payment medium.</div></li><li class="slate-li"><div style="position:relative">&quot;<strong class="slate-bold">PAID</strong>: Denotes that the Ari10 system has accepted the deposit.</div></li><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">FINISHED</strong>”: This culminates when all actions tied to the Blockchain are accomplished.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Statuses for Unsuccessful Transactions: ⛔️ </strong></p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">REJECTED</strong>”: Indicated when a transaction is either flagged for potential fraud or if a user&apos;s verification process, in some instances, exceeds a 30-minute wait.</div></li><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">PAYMENT_CANCELLED</strong>”: Occurs when a user decides to abandon the payment process.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Other statuses: ✅ </strong>/<strong class="slate-bold"> ☑️</strong></p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">“<strong class="slate-bold">TRADE_REJECTED</strong>”: Occurs when everything progresses as expected, but the Blockchain processes haven&apos;t concluded. Within 24 hours, the Blockchain transaction will undergo a recheck/replay to ensure its conclusion, leading to the “FINISHED” status.</div></li></ol><h2 class="slate-h2">Recommendation for Merchants</h2><p class="slate-p" placeholder="Type / for widgets">If you integrate the /status endpoint, view the “<strong class="slate-bold">PAID</strong>”, “<strong class="slate-bold">FINISHED</strong>”, and “<strong class="slate-bold">TRADE_REJECTED</strong>” statuses as markers of a successful deposit. For users actively engaging with Blockchain and wishing to track its transfer status for accurate representation in their platforms, the “<strong class="slate-bold">FINISHED</strong>” status is the go-to confirmation of a submitted Blockchain transaction. Meanwhile, the “<strong class="slate-bold">TRADE_REJECTED</strong>” status signifies short-term Blockchain operation delays, expected to transition to “<strong class="slate-bold">FINISHED</strong>” within 24h.</p><p class="slate-p" placeholder="Type / for widgets"></p>

The API endpoint "get /transaction/{transactionId}/status" enables users to fetch the status of a specific transaction using its unique Ari 10 transactionId. This endpoint provides real-time insights into a transaction's progress and status within the Ari10 system. It's particularly vital for integrations centered on Blockchain operations beyond just payment methods. For integrations with processes like day +1 settlements, this endpoint serves as a supplementary information source. However, in such scenarios, Webhooks, especially the one indicating a PAID status, should be the primary method for acquiring transaction details.

Types and description of Transaction Statuses

Statuses for Successful Transactions: ✅

Statuses for Unsuccessful Transactions: ⛔️ 

If you integrate the /status endpoint, view the “

” statuses as markers of a successful deposit. For users actively engaging with Blockchain and wishing to track its transfer status for accurate representation in their platforms, the “

” status is the go-to confirmation of a submitted Blockchain transaction. Meanwhile, the “

” status signifies short-term Blockchain operation delays, expected to transition to “

Ari10-Widget-Id

The ID of the transaction for which you want to retrieve the status. This parameter is a path parameter, meaning it should be included in the URL after the word "transaction", followed by the actual ID.

transactionId

status

startTime

<p class="slate-p" placeholder="Type / for widgets">After fully implementing the flow, partners should conduct an end-to-end walkthrough of the entire process.</p><h3 class="slate-h3"><span style="color:var(--tw-prose-bold);font-size:16px" class="slate-color">Deposit Test Details:</span></h3><p class="slate-p" placeholder="Type / for widgets">For testing deposits, use your personal email and enter the designated test phone number: +48 999 999 999. Click on the “Send Code / Wyślij kod” button. The fixed security code for this number will always be 899 999.</p><p class="slate-p" placeholder="Type / for widgets">Upon proceeding, select “Test Method / Metoda Testowa” and continue with the transaction. Subsequently, the partner site should receive the correct “<strong class="slate-bold">PAID</strong>” and “<strong class="slate-bold">FINISHED</strong>” webhooks, facilitating an immediate top-up to the user account.</p><p class="slate-p" placeholder="Type / for widgets"></p>

After fully implementing the flow, partners should conduct an end-to-end walkthrough of the entire process.

For testing deposits, use your personal email and enter the designated test phone number: +48 999 999 999. Click on the “Send Code / Wyślij kod” button. The fixed security code for this number will always be 899 999.

Upon proceeding, select “Test Method / Metoda Testowa” and continue with the transaction. Subsequently, the partner site should receive the correct “

” webhooks, facilitating an immediate top-up to the user account.