Exchange result query

• Endpoint: POST /aggregate-pay/api/gateway/exchangeQuery
• Tags: Forex(Old)

Description

Merchants can query historical exchange transaction results through the exchange result query interface.

Parameters

Field	In	Type	Required	Constraints	Description
Content-Type	header	string	Yes
sign	header	string	Yes		签名信息请参考技术文档

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
version	string	Yes		API version. Current value: 1.5
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
requestTime	string	Yes		Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX The time must be within two minutes of the current time
appId	string	Yes		Merchant AppId，The unique identifier assigned to the merchant app by PayerMax
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
data	object	Yes
data.outTradeNo	string	Yes	maxLength: 64	Original Merchant Txn ID.

Example

{
  "version": "1.1",
  "keyVersion": "1",
  "requestTime": "2023-07-06T07:16:29.652+00:00",
  "appId": "6666c8b036a24579974497c2f9a33333",
  "merchantNo": "010213834784554",
  "data": {
    "outTradeNo": "outTradeNo1688627776151"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’
data	object	Yes
data.transactionCcy	string	Yes		Transaction currency
data.side	string	Yes		The buying and selling direction for the transaction currency,BUY,SELL
data.tradeNo	string	Yes		Platform order id
data.targetAmount	string	Yes		Arrival amount
data.rateTime	string	Yes		Exchange rate generation time
data.rate	string	Yes		Exchange rate
data.completeTime	string	Yes		Transaction completion time.Compliant with rfc3339 specification, format：yyyy-MM-dd’T’HH:mm:ss.SSSXXX
data.errorCode	string	Yes		Order failed error code
data.rateVersion	string	Yes		Exchange rate version
data.targetCcy	string	Yes		Target currency
data.errorMsg	string	Yes		Order failed error code
data.ccyPair	string	Yes		Currency pair
data.outTradeNo	string	Yes		PayerMax order id
data.transactionAmount	string	Yes		Transaction amount
data.status	string	Yes		Transaction status.SUCCESS-Success，FAILED-Failed，PENDING-In progressing;

Response Example

{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "transactionCcy": "IDR",
    "side": "BUY",
    "tradeNo": "20221128064248TU9975338200163533",
    "targetAmount": "0.01",
    "rateTime": "2022-11-28T06:42:48.000Z",
    "completeTime": "2022-11-28T06:42:48.000Z",
    "errorCode": "",
    "rateVersion": "batch0003166961776821287950001",
    "targetCcy": "USD",
    "errorMsg": "",
    "ccyPair": "USDIDR",
    "rate": "15577.65000000",
    "outTradeNo": "outTradeNo1669617768651",
    "transactionAmount": "100.00",
    "status": "SUCCESS"
  }
}