# 1 Collection Request API

# Describe

  • Payment Request API

# HTTP Request Information

# Request URL

  • {domain}/open-api/dynamic/payment/code

# 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 10-32 CCP20220428011068111 Merchant order ID, format: letters + numbers, 10-32 characters
channelCode mandatory string - ALFAMART_VA Channel Code
amount mandatory long 2000-100000000 50000 Receiving Amount
email mandatory string - - User email Format: email format
mobile optional string - - User phone number
customerName mandatory string 1-100 - User Name
notifyUrl mandatory string Merchant transaction notification URL
remark optional string - - Acquisition remarks
timestamp mandatory long - 1678356680000 Millisecond timestamp

# channelCode see reference

# Request Body Example

{
  "appId": "abc6e413c37f14f9fabc36fcee8d97c5e",
  "sign": "********************",
  "param": "{\"mchOrderId\":\"TestMchOrderIdP0001\",\"amount\":10000,\"email\":\"test@123.com\",\"mobile\":\"81234567890\",\"customerName\":\"test\",\"remark\":\"test payment code\",\"notifyUrl\":\"http://test\",\"channelCode\":\"ALFAMART_VA\",\"timestamp\":1678356680000}"
}

# Response Example

# code see reference

# successful response example

{
  "code": 10000,
  "message": "Success",
  "data": {
    "transactionId": "C1630761265167208448",
    "transactionCreateTime": "2023-03-01 09:45:58",
    "transactionReturnTime": null,
    "transactionAmount": 10000,
    "transactionStatus": "PENDING",
    "remark": null,
    "paymentCode": {
      "mchOrderId": "TestMchOrderIdP0001",
      "channelCode": "ALFAMART_VA",
      "referenceNumber": "00012819",
      "expireTime": "2023-03-13 20:12:34"
    }
  }
}

# failed response example

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