Skip to main content

Query payment order list

GET 
/payment/list

Query the payment order list of the merchant by pagination.

Request​

Query Parameters

    chainId int32

    Chain ID

    This is the platform internal ID, not the chain ID on the chain or from the wallet, can be obtained from Get Chain List interface

    page int64

    Possible values: >= 1 and <= 1000000

    Default value: 1

    Page number

    size int64

    Possible values: <= 500

    Default value: 10

    Number of records per page

    orderStatus int32

    Possible values: [0, 1, 2, 3, 4, 5]

    Order Status

    • 0 - Paid
    • 1 - Pending Payment
    • 2 - Block Confirmation
    • 3 - Partially Paid
    • 4 - Payment Failed
    • 5 - Refunded
    transactionHash string

    Transaction hash

    startTime int64

    Start time of order creation

    Format: Unix timestamp, unit: seconds

    endTime int64

    End time of order creation

    Format: Unix timestamp, unit: seconds

Responses​

OK

Schema

    code int32required

    Status code

    msg stringrequired

    Status message on success or error message on failure

    description string

    Detailed description when error

    data

    object

    Page result object

    count int64required

    Total number of records that meet the conditions

    page int64required

    Current page number

    size int64required

    Number of records per page

    list

    object[]

    required

  • Array [

    • chainId int32required

    Chain ID

    This is the platform internal ID, not the chain ID on the chain or from the wallet, can be obtained from Get Chain List interface

    orgId int32required

    Merchant orgnization ID, can be obtained from the management platform

    outTradeNo stringrequired

    Merchant order number

    outPaymentNo stringrequired

    Payment order number

    description stringrequired

    Product description

    isLegalTender int32required

    Possible values: [0, 1]

    Whether the quoted currency is a fiat currency

    • 0 - No
    • 1 - Yes
    quoteCurrencySymbol stringrequired

    Quoted currency symbol, must be in uppercase letters

    Note: When the quoted currency is a fiat currency, this field is the international standard fiat currency symbol, such as USD, CNY, otherwise it is a digital currency symbol, such as USDT, TRX, ETH

    quoteAmount stringrequired

    Quoted amount

    Note: This is the actual amount, must be a positive number, can be a decimal

    paymentStatus int32required

    Possible values: [0, 1, 2, 3, 4, 5]

    Payment Order Status

    • 0 - Paid
    • 1 - Pending Payment
    • 2 - Block Confirmation
    • 3 - Partially Paid
    • 4 - Payment Failed
    • 5 - Refunded
    paymentType int32

    Possible values: [0, 1]

    Payment method

    • 0 - Contract payment
    • 1 - Scan code payment (wallet transfer)
    expectedAmount string

    Order expected payment amount

    Note: The value of this field is an integer, calculated by (actual_amount * 10^currency_decimals)

    settlementAmount string

    Order settlement amount

    Note: The value of this field is an integer, calculated by (actual_amount * 10^currency_decimals)

    settlementCurrencySymbol string

    Settlement currency symbol, based on the actual currency paid by the user

    transferHash string

    Order transaction hash

    userWalletAddress stringrequired

    Sub-contract wallet address for receiving payments

    fromAddress string

    Sender address

    createTime date-timerequired

    Order creation time

    blockTime int64

    Arrival time

    Note: Unix timestamp, unit: seconds

  • ]

Loading...
Last updated on