# 2 Static VA Collection Query API

# Describe

  • Get collection information based on transaction ID.

# HTTP Request Information

# Request URL

  • {domain}/open-api/static/payment/code/payments

# Request Method

  • POST

# Request Header

parameter name Is it mandatory type of data description
Content-Type mandatory string application/json

# Request Params

parameter name Is it mandatory type of data length example description
appId mandatory string - - application APPID
param mandatory string - - Parameter Body
sign mandatory string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 sign

# param

parameter name Is it mandatory type of data length example description
mchOrderId mandatory string 1-32 CCP20220428011068111 Merchant order ID, format: letters + numbers, 10-32 characters
startDate mandatory Date - 2023-01-02 Start Date
endDate mandatory Date - 2023-01-03 End Date
timestamp mandatory long - 1678356680000 Millisecond timestamp

# Request Body Example

{
  "appId": "abc6e413c37f14f9fabc36fcee8d97c5e",
  "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "param": "{\"mchOrderId\":\"TestMchOrderIdP0001\",\"startDate\":\"2023-01-02\",\"endDate\":\"2023-01-03\",\"timestamp\":1678356680000}"
}

# Response Example

# code see reference

# transactionStatus see reference

# successful response example

{
  "code": 10000,
  "message": "Success",
  "data": [
    {
      "transactionId": "C1630761265167208448",
      "transactionCreateTime": "2023-03-01 09:45:58",
      "transactionReturnTime": "2023-03-01 09:45:58",
      "transactionAmount": 10000,
      "transactionStatus": "COMPLETE",
      "remark": null,
      "mchOrderId": "TestMchOrderIdP0001",
      "channelCode": "ALFAMART_VA",
      "referenceNumber": "00012819"
    },
    {
      "transactionId": "C1630761265167208449",
      "transactionCreateTime": "2023-03-01 09:45:58",
      "transactionReturnTime": "2023-03-01 09:45:58",
      "transactionAmount": 10000,
      "transactionStatus": "COMPLETE",
      "remark": null,
      "mchOrderId": "TestMchOrderIdP0001",
      "channelCode": "ALFAMART_VA",
      "referenceNumber": "00012819"
    }
  ]
}

# failed response example

{
  "code": 21000,
  "message": "Service error, please contact administrator",
  "data": null
}