API Documentation
English
English
  • Authorization
  • Request signing
  • List of error codes
  • Webhooks
  • IFrame order
  • Payment acceptance widget
  • Telegram MiniApp
  • API Reference
    • Base actions
      • Check x-api-signature
      • Fetch available currencies
      • Current price request
      • Search for operations by TX hash
      • Check address format
      • Get transaction history
    • Advanced account
      • Get advanced balances of user
      • Get advanced balance by id
      • Get payment address for advanced balance top-up
    • Blockchain addresses
      • Search by id
      • Transactions tracking
      • Search by address
      • Meta-data
      • Address Transactions
      • Last transaction of the address
      • Getting a list of PayIn addresses
      • Getting a list of business addresses
      • Get recurrent addresses
      • Getting a list of PayOut addresses
      • Creating a new business wallet address
      • Creating a new PayOut wallet address
    • Personal addresses
      • User creation
      • Getting an address
      • Getting a list of addresses
      • Get user
      • Adding a trusted address
      • Getting a list of trusted addresses
      • Deleting a trusted address
    • Orders
      • Creating an order
      • Getting information about an order
      • Getting a list of orders
    • Withdraws
      • Getting a commission for making a withdrawal
      • Sync withdraw
      • Async withdrawal
      • Receiving withdrawal information
    • Invoices
      • Create an invoice for payment
      • Invoice information request
      • Getting a list of invoices
    • Auto swaps
      • Create auto-swap
      • Find auto-swap by ID
    • Withdrawals 2.0
      • Create auto-withdrawal
      • Find auto-withdrawal by ID
      • Additional confirmation of the withdrawal
    • Bridge
      • Getting limits for cross-chain transfer
      • Getting information about cross-chain transfer
      • Commission token formation
      • Creating a cross-chain translation
    • Swaps
      • Getting limits for cross-chain exchange
      • Getting information about cross-chain exchange
      • Commission token formation
      • Creation of a cross-chain exchange
    • Recurring payments
      • Creating a payment link
      • Get a payment link
      • Get payment links by user
      • Disabling the payment link
      • Create a subscription
      • Getting a subscription
      • Cancel Subscription
      • Creating a payment
    • KYT
      • Check transaction risks
      • Check withdrawal risks
      • Check withdrawal risks for provided address
    • Partners API
      • Create user
      • Get user
      • Get all users
      • Creating an organization
      • Getting a list of organizations
      • Getting the user's advance balances
      • Replenishment of the user's advance balance
      • Get general tariffs
      • Create/update individual tariff
      • Get individual tariffs
      • Create API key
      • Get API keys
      • Delete API key
    • Webhooks
      • Get webhook
      • Get webhook (extended)
    • Orphan transactions
      • Get a transaction
      • Get a list of transactions
      • Get a commission token
      • Withdrawal
    • Address book
      • Add an address
      • Delete an address
      • Update the address
      • Get a list of addresses
Powered by GitBook
On this page
  • Description
  • Parameters
  • Example

IFrame order

Description

This functionality allows you to create payments without accessing our API by embedding an 'iframe` on your page.

Parameters

The following parameters are available to manage the created order:

Parameter
Required
Description

apiKey

NO

Public part of the API key (used to sign payment webhooks)

theme

NO

Design theme (light/dark)

lang

NO

Language (ru, en, kr, lv, lt, de, pl, tp, tr, ua, fi, fr, ee, jp, bg, gr, es, it, cn, bn)

OrderID

YES

Payment ID

description

NO

Payment description

currency

NO

Coin payment

network

NO

Payment network

amount

NO

Amount to be paid

email

NO

Payer's email (to be pre-filled)

In the section "Integration" -> "Integration settings" in your personal account, you can configure the parameters for silence to create an order

For example, you can fill URL for sending webhooks

Example

As an example, let's create an order with the following parameters

  • Organization ID: 817f197e-3b00-4359-8298-6097aeb52c69

  • apiKey: odz2fn1+JhC...8J0fac4TnT6jew==

  • orderId: Payment #1234

  • description: Some payment description

  • currency: USDT

  • network: ethereum

Order parameters are specified in query

As a result, we will get the following URL

https://iframe-order.onchainpay.io/817f197e-3b00-4359-8298-6097aeb52c69?
    apiKeyId=odz2fn1%2BJhC...8J0fac4TnT6jew%3D%3D&
    orderId=Payment%20%231234&
    description=Some%20payment%20description&
    currency=USDT&
    network=ethereum

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

const apikeyId = encodeURIComponent('odz2fn1+JhC...8J0fac4TnT6jew==');

The final embed code will be as follows:

<iframe
    allow="clipboard-read; clipboard-write"
    src="https://iframe-order.onchainpay.io/817f197e-3b00-4359-8298-6097aeb52c69?apiKeyId=odz2fn1%2BJhC...8J0fac4TnT6jew%3D%3D&orderId=Payment%20%231234&description=Some%20payment%20description&currency=USDT&network=ethereum"
></iframe>

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

PreviousWebhooksNextPayment acceptance widget

Last updated 7 months ago