SparkPay OpenAPI Docs
English
  • English
  • 简体中文
English
  • English
  • 简体中文
  1. Must-Read for Integration
  • Product Introduction
  • Quick Guide
    • Integration Preparation
    • Interface Signature Description
  • Must-Read for Integration
    • Interface Rules
    • Asynchronous Notification
    • Interface Error Codes
    • Network and Currency
  • Integration Scenarios
    • Payment
    • Close Order
  • API List
    • Payment Order Creation
      POST
    • Payment Order Query
      GET
    • Payment Order Closure
      POST
    • Payment Order Creation(Pro Edition)
      POST
    • Payment Order Query(Pro Edition)
      GET
  • Frequently Asked Questions
    • Notification Related Issues
    • Redirect Failure Issues
    • Interface Error Issues
    • Test Token Acquisition/Test Network Connection
  • Integration Example
    • Interface Signature Example - PHP
    • Interface Signature Example - Postman
  • Version Notes
    • Version Notes
  1. Must-Read for Integration

Network and Currency

Here is the English version of your markdown document:

Currency and Network Parameters for Order Placement via Open API#

When merchants place orders using the Open API, they must provide the payment currency and payment network information. The payment currency is required and must be selected from the enumerated list below.

Currency Types#

Pricing Currency: The unit used to display the product/service price (can be either fiat or cryptocurrency).
Payment Currency: The currency customers actually use to make payments (only cryptocurrencies are supported).

Fiat Currencies#

Currency EnumDescription
USDUS Dollar
HKDHong Kong Dollar

Cryptocurrencies#

Currency EnumContract AddressNetwork
ETH-Ethereum
USDT0xdac17f958d2ee523a2206206994597c13d831ec7Ethereum
USDC0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48Ethereum
HSK0xe7c6bf469e97eeb0bfb74c8dbff5bd47d4c1c98aEthereum
POL-Polygon
USDT0xc2132d05d31c914a87c6611c10748aeb04b58e8fPolygon
USDC0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359Polygon
IRIS0x1D1530e3A3719BE0BEe1abba5016Cf2e236f3277IRISnet
BNB-BNB Smart Chain
USDT0x55d398326f99059ff775485246999027b3197955BNB Smart Chain
USDC0x8ac76a51cc950d9822d68b83fe1ad97b32cd580dBNB Smart Chain

Network Enum#

Below are the supported network enumerations for Spark:
Network EnumNetwork Name
2Ethereum
3BNB Smart Chain
4Polygon
5IRISnet

Example#

When using Payment Order Creation, the receive_network field is optional. If multiple networks are supported, use commas to separate them.
For example, if the merchant only wishes to receive USDT on Polygon, they should pass "4".
When using Payment Order Creation(Pro Edition), the available_payment_currency_networks field is optional.
If the merchant wants to receive:
USDT on Polygon and Ethereum
IRIS on IRISnet
ETH on all supported networks
The parameter should be set as follows:
{
    "available_payment_currency_networks": [
        {
            "currency": "USDT",
            "networks": [2, 4]
        },
        {
            "currency": "IRIS",
            "networks": [5]
        },
        {
            "currency": "ETH",
            "networks": []
        }
    ]
}

Notes#

The Open API will validate whether the amount of each payment currency (on its respective network), after conversion using the current exchange rate, meets or exceeds the minimum service fee.
Only currencies and networks that pass this check will be included in the final order. If none of them qualify, the API will return an error.

Frequently Asked Questions#

Q1: Why do I need to specify the pricing currency?
A: The pricing currency is used only to display the price in a familiar format. For example, if you're more comfortable with USD, the price might show as "100 USD".
Q2: Can I pay using USD?
A: No. Payment can only be made using cryptocurrencies like USDT or ETH. The system will automatically convert the USD amount to the equivalent crypto amount at the current exchange rate for payment.

Modified at 2025-07-04 09:28:08
Previous
Interface Error Codes
Next
Payment
Built with