Payment acceptance widget

Description

The widget allows you to set up payment acceptance with minimal integration. On your part, you will need to configure the reception of webhooks and place the widget on your application page.

There are 2 payment acceptance options available:

  • Invoices. For each new payment, the user receives a new account with a unique address, which is valid for a limited time. The invoice can be issued in crypto or fiat currency, with or without a fixed amount for free payment.

  • Personal addresses. Accepting payments allows you to create a list of crypto addresses for each payer. These addresses are permanently assigned to the user.

Depending on the selected type of payment acceptance, we will send the appropriate type of webhook

Webhook when paying an invoice Webhook when adding funds to a personal address

Orphan transaction webhook. In order to handle cases of sending a payment with the wrong currency, contact your personal manager to issue a webhook about the orphan transaction

Connection

The connection is made using the HTML tag <iframe/>

Example:

<iframe 
    allow="clipboard-read; clipboard-write"
    src="https://widget.apollopayment.io/181a197e-3b00-4359-8298-6097aeb52c69"
></iframe>

The attribute allow="clipboard-read; clipboard-write" is required so that your customers can copy the payment address by clicking the "Copy" button

Available options

The parameters are passed to the query

To insert data into the query, it must be escaped. In JavaScript, this can be done using the function encodeURIComponent

const payinCryptoInvoiceId = encodeURIComponent('#12345');

Parameters for accepting payments using invoices

If you do not pass the payinCryptoInvoiceCurrencies parameter, the user will be prompted choose from all available currencies to recalculate its amount

Multiple currencies can be separated by commas in the parameter, then the user will be offered a choice only from the specified currencies

One currency can be transferred, then it will be selected, without the possibility for the user to change

The payinCryptoInvoiceAmount parameter will work if one currency is passed to payinCryptoInvoiceCurrencies

You can specify multiple coins/networks separated by commas in the parameter

Only the ticker of the coin is available, in this case all networks that have this coin will be available Example: USDT,BNB,ETH

It is possible to specify the coin in a specific network, the separator is an underscore Example: USDT_tron,BNB_bsc,ETH_ethereum


Parameters for payment with a personal address

The personal users created from the widgets will be isolated between the widgets

If you get the payment address for the user X from the widget A, it will not be the same as for the same user X from the widget B


If you want to get a user X through the Personal payment API, then you must add the widget ID to the beginning

User X: user12345 Widget ID: 00000000-0000-0000-0000-000000000000

Client ID to receive via API will be: 00000000-0000-0000-0000-000000000000@user12345

Last updated