GAgate

Retrieve detailed fee information for an order

Changed on

Query transaction fee, revenue share, payment details, and settlement information by merchant trade number. This is a GET endpoint; pass merchantTradeNo as a URL query parameter.

get/api/open/v1/pay/order/fee/query

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/api/open/v1/pay/order/fee/query
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Query parameters

merchantTradeNostring required

Merchant order ID

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

Merchant client ID

X-GatePay-Signaturestring required
Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8

Signature

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

Nonce

Response

Success

status'SUCCESS' | 'FAIL'

SUCCESS or FAIL

codestring

Error code

errorMessagestring

Error message

Example response

{
  "data": {
    "totalInstitutionFeeAmount": "0",
    "payDetails": [
      {
        "institutionFeeAmount": "0"
      }
    ]
  }
}

Changes

  • 1ba6e3b07dceRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status