List all orders

Query orders list

Retrieves the partner's order list based on the finish time of order. And returns a Map with a data property that contains an object of OrderList with all the order details.

on-ramp: Currently only FINISHED orders will be contained in the response.FINISHED represents that transaction on chain is confirmed and user has received cryptocurrencies. nft: FINISHED Settlement Settledwill be contained in the response.

List all orders

GET https://api.ramp.fatpay.xyz/open/api/onramp/order

Query orders list based on the create time of orders.

Query Parameters

Name
Type
Description

startTime*

Long

Order finished time. Unix timestamp in second e.g. 1661346861

endTime*

Long

Order finished time. Unix timestamp in second e.g. 1661346861

page

Integer

Current page index, default 1

size

Integer

Page size, default 20

Headers

Name
Type
Description

Content-Type*

String

application/json

X-Fp-Version*

String

FaTPay API version e.g. v1.0

X-Fp-Timestamp*

Integer

Unix timestamp in second e.g. 1661346861

X-Fp-Nonce*

Integer

Random integer e.g. 868964

X-Fp-Partner-Id*

String

Partner ID assigned by FaTPay as Premium Partner e.g. 2yQrS9A0xmM8xpfa

X-Fp-Signature*

String

{
    "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"
        }]
    }
}

Objects definition

OrderList

Key
Format
Required
Description

page

Integer

Y

Current page index. e.g. 1

size

Integer

Y

Page size. e.g. 20

totalCount

Integer

Y

Total amount of orders. e.g 40

list

Object

Y

Order

Key
Format
Required
Description

orderId

String

Y

Order ID e.g. jIdvChO85Bw

orderStatus

Integer

Y

On-ramp: Order status fixed as 3īŧšFINISHED NFT Checkout: 1īŧšFINISHED 2īŧšSettlement 3īŧšSettled

userId

String

Y

FaTPay User ID e.g. test-4Q4-zf4mDKh7h3FNXPFNaA..

payTime

String

Y

Payment time. Unix timestamp in second e.g. 1661346861

deliverTime

String

Y

Tx on chain created time Unix timestamp in second e.g. 1661346861

finishTime

String

Y

Tx on chain confirmed time Unix timestamp in second e.g. 1661346861

fiatCurrency

String

Y

ISO code of fiat currency, e.g. USD, THB, etc.

currencyAmount

Long

Y

Fiat currency amount, up to two decimal places. e.g. 199

cryptoCurrency

String

Y

Cryptocurrency bought by the user. e.g. USDT

cryptoCurrencyCode

String

Y

Cryptocurrency code, e.g. USDT_ERC20

cryptoCurrencyAmount

Decimal

Y

The amount of cryptocurrency delivered to the user. up to two decimal places. e.g. 182

cryptoCurrencyUnitPrice

Decimal

Y

Unit price of cryptocurrency, up to two decimal places. e.g. 1.03

walletAddress

String

Y

Wallet address.

gasFee

Decimal

Y

Gas fee, up to two decimal places. e.g. 1.32

gasFeeUnit

String

Y

Unit of gas fee, e.g. BTC. * After 2022/10/18, gas fee of all order will be converted to be the same as purchased cryptocurrency. If BTC is purchased, gasFeeUnit will be BTC.

platformFee

Decimal

Y

Processing fee charged by FaTPay, up to two decimal places. e.g. 11.94

platformFeeUnit

String

Y

Unit of processing fee, e.g. USD.

totalFee

Decimal

Y

Total fee = Gas fee + Processing fee, up to two decimal places. e.g. 13.26

totalFeeUnit

String

Y

Unit of total fee, e.g. USD.

payment

String

Y

txHash

String

Y

Transaction Hash ID on blockchain. e.g. 0x93da31ee10015ecf3c0dee4a5fa1c74a7a2e02f88ec71f60317c2055f80f3d3c

network

String

Y

Blockchain. e.g. ethereum_mainnet

blockchainExplorer

String

Y

ext

String

Y

e.g. ext

nftDetails

Object

N

nftDetails

Key
Format
Required
Description

contractAddress

String

Y

Total amount of orders. e.g 40

nftNetwork

String

Y

tokenId

String

N

merchantUniqueId

String

N

type

String

Y

mintQuantity

String

N

ownerWalletAddress

String

N

transferWalletAddress

String

Y

merchantOrderNo

String

N

externalCustomerId

String

N

PreviousRetrieve quoted priceNextWebhooks

Last updated