Payio documentation

Welcome to Pay.io documentation.

Introduction

Pay.io is a Crypto on-ramping orchestrator.

Key features

• Support for an expanding list of crypto on-ramp providers where users can see the best buy crypto rate available
• Easy widget based integration

On-Ramp

User flow

To buy crypto, the user goes through the following steps in the widget:

1. Confirm the cryptocurrency, fiat, and amount to purchase.
2. Select a provider from supported providers list.
3. Click on continue.
4. User is re-directed to provider’s overlay where they need to confirm the amounts and log in
5. Complete purchase flow in provider’s overlay
6. Selected provider sends the crypto to the user
7. Success message will be displayed on provider side

Widget integration

Integrating the widget is easy, the only thing you would need to do is redirect your user to pay.io link.

Customization options via query parameters

If you want to set some custom options for your integration, just add them as query parameters to the URL. By customising the URL with these parameters, pay.io provides a seamless experience where the user is taken directly to the payment providers page with all the necessary details already filled in, pending only their confirmation to proceed with the transaction. This method simplifies the process for the user, making it more efficient and user-friendly.

Example URL with all parameters available: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&defaultFiat=AED&defaultCrypto=USDT_ETH&onlyFiats=EUR,AED,BRL,KES&onlyCryptos=BTC,USDT_ETH,USDT_BNB,ETH&theme=dark&lang=en&wallets=btc:1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71,usdt_eth:0xb794f5ea0ba39494ce839613fffba74279579268

apiKey

Your API key uniquely identifies you as a client. This is the only required parameter. With only apiKey the URL will look like this: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2

amount

Set a default amount to buy inside the widget.

Example URL will look like this: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&amount=100&onlyFiats=EUR&onlyCryptos=BTC

onlyFiats

Set a list of FIAT currencies you want to be available to choose from in the widget. For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&onlyFiats=EUR,AED,BRL,KES will set the only available FIATS to be EUR, AED, BRL and KES from the widget.

onlyCryptos

Set a list of cryptocurrencies you want to be available to choose from in the widget.

For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&onlyCryptos=BTC,USDT_ETHEREUM,USDT_BSC,USDT_POLYGON will set the only available crypto to be BTC, USDT on Ethereum network, USDT on Polygon network and USDT on Binance Smart chain from the widget.

defaultFiat

Set a default fiat currency to be displayed using defaultFiat. For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&defaultFiat=BRL

defaultCrypto

Set a default cryptocurrency to be displayed using defaultCrypto. NB! The cryptocurrency needs to be set in the onlyCryptos parameter list also to be visible for the user. For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&defaultCrypto=BTC

theme

Set a theme for your widget. Available parameters are light and dark . For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&theme=dark

lang

To set default language for the widget, use lang parameter. Available languages are English en, Japanese ja and Portugese pt.

For example, https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&lang=ja

Default Ramp provider

Set default ramp provider for the widget.

Listing of all ramp providers available via Pay.io.

https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&defaultProvider=onramp_money&onlyFiat=vnd,eur

Default Payment Method

Set default payment method for the widget.

Listing of all payment methods available via Pay.io.

https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&paymentMethod=bank_transfer&onlyFiat=eur

wallets

To set receiver wallet address, use wallets parameter. It is possible to set one or multiple wallets.

Example with one wallet set: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&wallets=btc:1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71

Example with more than one wallet set: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&wallets=btc:1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71,usdt_ethereum:0xb794f5ea0ba39494ce839613fffba74279579268

walletAddressTags

Parameter for currencies that need destination tag in addition to wallet aadress.

Example wallet and wallet address tag set: https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&wallets=btc:1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71,XRP:rLQUo6VbTMHA7dFTpCTzSzTKAUuWSy7u3K&walletAddressTags=xrp:1116204632

Country

Parameter for filtering the country. We will follow ISO 3166-1 standard.

https://widget.pay.io/?apiKey=pk_live_01j3d3wevhfhs8zztm74hke0v2&country=1

Supported currencies

Supported FIAT currencies

FIAT currencies supported by Pay.io

Supported Crypto currencies

Listing of all tokens and coins available for purchase via Pay.io.

Supported payment methods per provider and fiat currency

BoomFi

Swapped

TransFi

Onramp.Money