订单列表查询接口
通过该接口,查询完结时间在一定范围内的订单列表。接口正常将返回一个包含 orderList
的 data
on-ramp订单仅返回“已完结”订单(orderStatus=3),即链上交易已确认、用户已收到加密货币的订单
NFT订单已支付、已结算状态会触发通知
订单列表查询接口
GET
https://api.ramp.fatpay.xyz/open/api/onramp/order
基于订单起止时间和订单类型查询订单列表
Query Parameters
startTime*
Long
订单完结时间。Unixime 时间戳,秒 e.g. 1661346861
endTime*
Long
订单完结时间。Unixime 时间戳,秒 e.g. 1661346861
page
Integer
分页号,默认 1
size
Integer
每页条数,默认20
buyType
String
buyType=nft:返回NFT订单 不传则返回on-ramp订单
Headers
Content-Type*
String
application/json
X-Fp-Version*
String
FaTPay API 接口版本 e.g. v1.0
X-Fp-Timestamp*
Integer
Unixtime 时间戳,秒 e.g. 1661346861
X-Fp-Nonce*
Integer
6位随机正整数 e.g. 868964
X-Fp-Partner-Id*
String
申请高级合作伙伴时,由 FaTPay 分配的 partner ID e.g. 2yQrS9A0xmM8xpfa
X-Fp-Signature*
String
由 APIPrivateKey
生成的签名
e.g. zbBQ+1nv/5up9riH1wbTSSMmkb26LQj3g1cNWsutOordOrtpk8agcA5D5bdYaGeVlHK0qZ2MlUV+ZfOK9cXMuficeIm5fnEjMEm7s1IZtSivMt5te7EFqe52dtVFafE4hUgwqH6QBZB0yZ1FSqHs2dOCI0e8RKJQBDitxtHkibStl1Jt5wulzzq96qWbbVnwoBqGDT52OtwwEcDqMI4SIAzUAdBhAuLqUig1U4Ne9ufT8B1aAohEk5fvn/Sbom21bEjLdgbt5PwH2wmmuBx4tq31IgcP4V+qEBILY2eMAFzkvxNXaX3PsLbj9NpgyIc3HQl0FtRq3gdN7FsSvyvcWA==
{
"code": 10000,
"msg": "Success",
"data":
{
"page": 1,
"size": 20,
"totalCount": 2,
"list": [
{
"orderId": "jIdvChO85Bw.",
"orderStatus": 3,
"userId": "test-4Q4-zf4mDKh7h3FNXPFNaA..",
"payTime": 1661177568,
"deliverTime": 1661177536,
"finishTime": 1661177536,
"fiatCurrency": "USD",
"currencyAmount": 100,
"cryptoCurrency": "USDC",
"cryptoCurrencyCode": "USDC_Polygon",
"cryptoCurrencyAmount": 93.09000000,
"cryptoCurrencyUnitPrice": 1.03,
"walletAddress": "0x9a078d5109a9268cE307884e825576520733e2FE",
"walletAddressTag": "88888888",
"gasFee": 0.01,
"gasFeeUnit": "USDC",
"platformFee": 5.00,
"platformFeeUnit": "USDC",
"totalFee": 5.01,
"totalFeeUnit": "USDC",
"payment": "CREDIT_DEBIT_CARD",
"txHash": "0x777fb52e7f77d14f7d6d51eefa90c4c2f03d0b6d21e51dcc4c056baedf5f7e4e",
"network": "polygon_mumbai",
"blockchainExplorer": "https://mumbai.polygonscan.com/tx/"
},
{
"orderId": "s0cec3BQ8i4.",
"orderStatus": 3,
"nftDetails": [
{
"externalCustomerId": "123333",
"tokenId": "",
"nftNetwork": "ethereum",
"transferWalletAddress": "0x0B4DF75c947e225b459B949F1625AcAb171053c4",
"merchantUniqueId": "112233",
"contractAddress": "0xe785E82358879F061BC3dcAC6f0444462D4b5330",
"mintQuantity": 2,
"type": "MINT",
"merchantOrderNo": "123321"
}
"userId": "test-4Q4-zf4mDKh7h3FNXPFNaA..",
"payTime": 1661163885,
"deliverTime": 1661163847,
"finishTime": 1661163847,
"fiatCurrency": "USD",
"currencyAmount": 10,
"cryptoCurrency": "USDC",
"cryptoCurrencyCode": "USDC_Polygon",
"cryptoCurrencyAmount": 9.30000000,
"cryptoCurrencyUnitPrice": 1.03,
"walletAddress": "0x9a078d5109a9268cE307884e825576520733e2FE",
"gasFee": 0.01,
"gasFeeUnit": "USDC",
"platformFee": 0.50,
"platformFeeUnit": "USDC",
"totalFee": 0.51,
"totalFeeUnit": "USDC",
"payment": "CREDIT_DEBIT_CARD",
"txHash": "0x93da31ee10015ecf3c0dee4a5fa1c74a7a2e02f88ec71f60317c2055f80f3d3c",
"network": "polygon_mumbai",
"blockchainExplorer": "https://mumbai.polygonscan.com/tx/",
"ext": "ext"
}]
}
}
返回的对象
OrderList
OrderList
page
Integer
是
当前页码,如 1
size
Integer
是
每页条数,如 20
totalCount
Integer
是
总 Item 数
list
Object
是
订单列表,Order
的数组
Order
Order
orderId
String
是
订单id,如 jIdvChO85Bw.
orderStatus
Integer
是
On-ramp: - 固定值 3,发货完结
NFT Checkout:
- 1:已支付 - 2:结算中 - 3:已结算
userId
String
是
FaTPay 用户id,如 test-4Q4-zf4mDKh7h3FNXPFNaA..
payTime
String
是
订单完成支付时间 Unixtime 时间戳,秒 e.g. 1661346861
deliverTime
String
是
订单上链时间 Unixtime 时间戳,秒 e.g. 1661346861
finishTime
String
是
链上交易完成时间 Unixtime 时间戳,秒 e.g. 1661346861
fiatCurrency
String
是
法币ISO代码:USD、THB
currencyAmount
Long
是
加密货币数量,最多 2 位小数,如 182
cryptoCurrency
String
是
加密货币名称,如 USDT
cryptoCurrencyCode
String
是
加密货币标识码,如 USDT_ERC20
cryptoCurrencyAmount
Decimal
是
法币金额,最多 2 位小数,如 199
cryptoCurrencyUnitPrice
Decimal
是
加密货币单价,最多 2 位小数,如 1.03
walletAddress
String
是
钱包地址,如 0xbe188d6641e8b680743a4815dfa0f6208038960f
walletAddressTag
String
是
钱包地址附加的Tag/Memo,如888888
gasFee
Decimal
是
网络手续费,最多 2 位小数,如 1.32
gasFeeUnit
String
是
网络手续费计价单位,如BTC
2022-10-18后的订单均按照所购加密货币单位来计价,如购买BTC,则gasFee按照BTC单位来收取
platformFee
Decimal
是
平台支付手续费,最多 2 位小数,如 11.94
platformFeeUnit
String
是
平台手续费计价单位,如USD
totalFee
Decimal
是
总计支付手续费 2022-10-18后的订单,totalFee=platformFee
totalFeeUnit
String
是
总计手续费计价单位,如USD
txHash
String
是
链上交易号,如 0x93da31ee10015ecf3c0dee4a5fa1c74a7a2e02f88ec71f60317c2055f80f3d3c
network
String
是
加密货币所在公链,如ethereum_mainnet
ext
String
是
URL入参提交的ext内容
nftDetails
nftDetails
contractAddress
String
是
NFT合约地址地址
nftNetwork
String
是
NFT合约所属公链
tokenId
String
否
NFT的TokenID
merchantUniqueId
String
否
URL传入的NFT的唯一标识
type
String
是
MARKET / MINT
mintQuantity
String
否
MINT数量
ownerWalletAddress
String
否
NFT当前持有人钱包地址
transferWalletAddress
String
是
支付后,NFT转让的钱包地址
merchantOrderNo
String
否
URL传入的外部商户订单号
externalCustomerId
String
否
URL传入的外部商户客户ID
Last updated