Case Search

• Endpoint: POST /aggregate-pay/api/gateway/caseSearch
• Tags: Chargeback Service

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
data	object	Yes		Request data body
data.caseId	string	Yes	maxLength: 64	chargeback case no
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
spMerchantNo	string	No		Merchant ID of ISV service provider

Example

{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2023-04-13T06:31:52.000Z",
  "appId": "54a5e69376734010982c1602c88e00ff",
  "merchantNo": "SP100860372",
  "data": {
    "caseId": "O20230103065545916437107761"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
data	object	Yes		return data body
data.amount	string	Yes	maxLength: 20	Actual frozen payment amount of the case. It should be returned with the decimal places supported by each country's currency. Example: 15.00.
data.retrievalDate	string	Yes	maxLength: 32	Documents retrieval initiation date, Format: yyyy-MM-dd
data.fee	string	Yes	maxLength: 20	Case freezing fee,returned according to the decimal point supported by each country’s currency.
data.caseResult	string	No	maxLength: 32	Case result，Merchant wins: WIN, merchant loses: FAI
data.batchId	string	No	maxLength: 64	Case batch number, generated during batch documents retrieval.
data.outUserId	string	Yes	maxLength: 64	User ID
data.tradeCreateTime	string	Yes		Transaction creation time, Format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX
data.totalAmount	string	Yes	maxLength: 20	Actual total frozen amount of the case, which is the sum of the actual frozen amount and the actual frozen fee. It should be returned with the decimal point supported by the respective currency of each country. Example: 25.00.
data.caseId	string	Yes	maxLength: 64	Case id
data.outTradeNo	string	Yes	maxLength: 64	Merchant order number
data.currency	string	No	maxLength: 3	Actual currency frozen for the case
data.tradeToken	string	Yes	maxLength: 64	Payermax trade token
data.status	string	Yes	maxLength: 32	【Case status】
data.expirationDate	string	Yes	maxLength: 32	Reply due date: Merchant needs to submit proof materials before the due date, Format: yyyy-MM-dd
data.originTradeAmount	string	Yes	maxLength: 20	Amount to be frozen for the case, corresponding to the original transaction order's amount to be frozen. It should be returned with the decimal point supported by the respective currency of each country. Example: 15.00.
data.originTradeCurrency	string	No	maxLength: 3	Currency to be frozen for the case, corresponding to the original transaction order's currency to be frozen. Example: INR.
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’

Response Example

{
  "msg": "Success.",
  "code": "APPLY_SUCCESS",
  "data": {
    "amount": "5000.00",
    "retrievalDate": "2023-02-13",
    "fee": "5000.00",
    "caseResult": "WIN",
    "batchId": "",
    "outUserId": "10042",
    "tradeCreateTime": "2023-01-03T06:32:52.000Z",
    "totalAmount": "10000.00",
    "caseId": "O20230103065545916437107761",
    "outTradeNo": "dev-RenshTest1672727570986",
    "currency": "IDR",
    "tradeToken": "T2023081604639602348121",
    "status": "DISPUTE_INQUIRY",
    "expirationDate": "2023-02-14",
    "originTradeAmount": "5000.00",
    "originTradeCurrency": "IDR"
  }
}