Channel payment flow API

Channel payment flow

This is a set of API calls you can support to customize the channel payment flow to your needs.

In order to make a deposit, your customer will first need to get an address assigned to them. To generate an address for a customer, make a POST request to /wallet/address specifying customer ID and currency (here's the list we currently support).

Returns a previously created or brand-new address with a link to a QR code.

Create a channel for the customer for a specified currency.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

post

/channels

Authorizations

Body

currencystring · enumrequired

Represents supported crypto currencies in the payment processing system.

Currencies:

• BNB - Binance Coin
• bUSDT - Tether (pegged to USD), issued on BNB Smart Chain network (BEP20 token)
• BTC - Bitcoin
• ETH - Ether
• eUSDC - USD Coin (pegged to USD), issued on Ethereum network (ERC20 token)
• eUSDT - Tether (pegged to USD), issued on Ethereum network (ERC20 token)
• FTN - Fasttoken
• POL - POL
• pUSDC - USD Coin (pegged to USD), issued on Polygon network (ERC20 token)
• SOL - SOL
• sUSDT - Tether (pegged to USD), issued on Solana network (SPL token)
• tUSDC - USD Coin (pegged to USD), issued on Tron network (TRC20 token)
• tUSDT - Tether (pegged to USD), issued on Tron network (TRC20 token)
• wpUSDC - wrapped USD Coin (pegged to USD), issued on Polygon network (ERC20 token)
• wpUSDT - wrapped Tether (pegged to USD), issued on Polygon network (ERC20 token).

Options: BNB, bUSDT, BTC, ETH, eUSDC, eUSDT, FTN, POL, pUSDC, SOL, sUSDT, tUSDC, tUSDT, wpUSDC, wpUSDT

customerIdstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.xgateway.tech/api/v2/channels' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "currency": "BNB",
    "customerId": "text"
  }'

200

201

400

401

422

500

200

{
  "data": {
    "address": "[address]",
    "qrCodeURL": "[qrCodeURL]"
  },
  "success": true
}

Ok

In case of a successful response, the data property contains the address that you can display to your customer. You can also use the qrCodeURL property to display the address in an easy-to-use format.

Once an address for a certain customer ID has been created, it gets saved in our database and each time you request it again, you will get the same address back. This means that the customer can safely store the address and continue depositing funds onto it, and you will be notified every time.