OnlinePay API
V2
V1
V2
V1
  1. Query
  • Introduction
    • Introduction
    • How to Start
    • Country Code
    • Country Info
    • Currency Code
    • Error Code
    • Transfer Order Info Type
    • Transfer Order File Type
    • Per Bank
    • Spei Bank
    • Vietnam Bank
    • V2 Signature Specification
  • Payin
    • SEPA
      • SEPA Master Account API
      • SEPA Virtual Account API
      • SEPA Upload Kyc Files API
      • SEPA Submit EDD Files API
    • Credit Card API
      POST
    • Alipay API
      POST
    • GCash API
      POST
    • WeChat API
      POST
    • PIX API
      POST
    • Crypto API
      POST
    • Union Pay API
      POST
    • SPEI API
      POST
    • Per Transfer API
      POST
    • Cash App API
      POST
    • Google Pay API
      POST
    • Apple Pay API
      POST
    • MONO API
      POST
    • Vietnam Bank API
      POST
    • CheckOut API
      POST
    • CheckOut Payment API
      POST
    • OnRamps API
      GET
  • Payout
    • PER Transfer Payout API
    • Checkout Payout API
    • Card Payout API
    • Bank Account Payout API
    • PIX Payout API
    • PER Transfer Payout API
    • SPEI Payout API
    • CashApp Payout API
    • Checkout Payout API
    • Query Payout Order API
    • Supplement Payee Info API
  • Recharge
    • SEPA
      • Account
      • Virtual Account
  • Refund
    • Refund API
  • Card
    • Create Cardholder API
    • Create Card API
    • Active Card API
    • Freeze Card API
    • UnFreeze Card API
    • Cancel Card API
    • TopUp Card API
    • Card Withdraw API
    • Query Card Balance API
    • Query Card Info API
    • Query Card Transaction API
    • Add VPA Scene API
  • Query
    • Query Payout Order API
      POST
    • Query Order API
      POST
    • QueryOrderList API
      POST
    • QueryBalance API
      POST
    • QueryOrderAmount API
      POST
  • Notify
    • SEPA EDD KYC Notify Webhook API
    • Pay Notify WebHook API
    • Refund Notify WebHook API
    • Card Notify WebHook API
    • Chargeback Notify WebHook API
  • File
    • UploadFile API
  • Schemas
    • ApiResponse
    • V2EncryptedEnvelope
    • CreateAccountRequest
    • UserArray
    • V2EncryptedNotification
    • QueryPayOutV2Request
    • PayoutCheckStandV2Request
    • CheckStandV2Request
    • PayoutCheckStandV2Response
    • CreateAccountResponse
    • QueryPayOutV2Response
    • ProductParams
    • PaymentNotification
    • PaymentNotificationPayload
    • Category
    • RefundNotificationPayload
    • CreateAccountInfo
    • Pet
    • OrderQueryV2Data
    • PayoutQueryResult
    • CheckStandV2Response
    • PayoutCheckStandV2Data
    • Tag
    • ChargebackNotificationPayload
    • RechargeRequest
    • CheckStandV2Data
    • OrderQueryV2Request
    • OrderQueryV2Response
    • Order
    • RechargeResponse
    • User
    • RechargeAccountInfo
  1. Query

QueryOrderAmount API

Testing Env
https://testpay.onlinepay.ai
Testing Env
https://testpay.onlinepay.ai
POST
/v2/order/queryAmount
Query the total settlement amount and tag total amount of the order

Request

Body Params application/json

Example
{
    "merNo": 104001001,
    "orderStatusList": [
        "5"
    ],
    "sourceCurrencyList": [
        "USD"
    ],
    "settleCurrencyList": [
        "USD"
    ],
    "merOrderNoList": [
        "452236423626234"
    ],
    "settlementStatusList": [
        "1"
    ],
    "startDate": "2024-01-01",
    "endDate": "2025-09-09",
    "sign": "dfsghgfssgf"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://testpay.onlinepay.ai/v2/order/queryAmount' \
--header 'Content-Type: application/json' \
--data '{
    "merNo": 104001001,
    "orderStatusList": [
        "5"
    ],
    "sourceCurrencyList": [
        "USD"
    ],
    "settleCurrencyList": [
        "USD"
    ],
    "merOrderNoList": [
        "452236423626234"
    ],
    "settlementStatusList": [
        "1"
    ],
    "startDate": "2024-01-01",
    "endDate": "2025-09-09",
    "sign": "dfsghgfssgf"
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "code": "00000",
    "message": "SUCCESS",
    "data": {
        "settleAmountList": [
            {
                "settleAmount": "0.00100000",
                "settleCurrency": "BTC"
            },
            {
                "settleAmount": "111.60",
                "settleCurrency": "EUR"
            },
            {
                "settleAmount": "4859.06",
                "settleCurrency": "HKD"
            },
            {
                "settleAmount": "630.91",
                "settleCurrency": "USD"
            },
            {
                "settleAmount": "12.86",
                "settleCurrency": "USDT"
            }
        ],
        "sourceAmountList": [
            {
                "sourceAmount": "985.07",
                "sourceCurrency": "HKD"
            },
            {
                "sourceAmount": "1310.83",
                "sourceCurrency": "USD"
            },
            {
                "sourceAmount": "20.00",
                "sourceCurrency": "USDT"
            }
        ]
    }
}
Modified at 2026-05-27 09:25:35
Previous
QueryBalance API
Next
SEPA EDD KYC Notify Webhook API
Built with