6. Query Order

  • Introduction: This interface mainly provides order inquiry function. The order status can be queried according to the specified order id.
  • Endpoint: /v1/order/query-order
  • Method: GET
  • Request
Field Name Type Required Description
orderId String N Unique identifier of the order in Paymonade system (Either orderId or merchantOrderNo must be provided.)
merchantOrderNo String N Unique identifier of the order on the merchant's platform (Either orderId or merchantOrderNo must be provided.)
  • Response
Field Name Type Description
orderId String Unique identifier of the order in Paymonade system
merchantOrderNo String Unique identifier of the order on the merchant's platform
merchantUserId string Unique identifier of the user on the merchant's platform
side String Transaction type, refer to enum type definitions
paymentMethod String Payment method, refer to enum type definitions
orderStatus String Order status, refer to enum type definitions
failReason String Reason for failure
fiatCurrency String Fiat currency
cryptoCurrency String Crypto currency
fiatAmt String Amount in fiat currency
cryptoAmt String Amount in crypto currency
price String Price
rampFee String Platform service fee
rampFeeCurrency String Currency of the service fee
networkFee String Network fee
networkFeeCurrency String Currency of the network fee
payer Object Payer account information, fields include:
- accountNumber: Payer's account number
- cardNumber: Payer's card number
- name: Payer's name
- iban: Payer's IBAN
beneficiary Object Beneficiary account information, fields include:
- accountNumber: Beneficiary's account number
- cardNumber: Beneficiary's card number
- name: Beneficiary's name
- iban: Beneficiary's IBAN
createTime Long Order creation time
updateTime Long Order update time
userType String Individual or Corporate
merchantRemark String merchant remark
  • Response Example:
    {
    "status": 200,
    "msg": "OK",
    "data": {
      "orderId": "BUY202307271234455",
      "merchantOrderNo": "202218839330",
      "side": "BUY",
      "paymentMethod": "SEPA",
      "orderStatus": "init",
      "fiatCurrency": "EUR",
      "cryptoCurrency": "USDT",
      "fiatAmt": "100",
      "cryptoAmt": "",
      "price": "1.01",
      "rampFee": "2",
      "rampFeeCurrency": "EUR",
      "payer": {
        "accountNumber": "32599867",
        "cardNumber": "",
        "name": "John Doe",
        "iban": "GB29NWBK60161331926819"
      },
      "beneficiary": {
        "accountNumber": null,
        "cardNumber": "",
        "name": "",
        "iban": "DUMMY12341234143412356"
      },
      "createTime": 1617893300241,
      "updateTime": 1617893300241,
      "userType": "Individual"
    },
    "traceId": "77ec4eeb-86ea-42e3-97f2-e5ff1c81e7fc"
    }
    

results matching ""

    No results matching ""