# 1 CPM Creation

# Brief Description
  • CPM Creation
# Request URL
  • /api/v1/cpm/payment
# Request Method
  • POST
# Request Params
parameter name Is it mandatory type of data description
appId mandatory string Application APPID
appName mandatory string Merchant application name, format: letter + space, 1-100 characters
mchOrderId mandatory string Merchant order id ((unique for customer or bill) format: letter + num, 1-32 characters
channelCode mandatory string ChannelCode: GCASH_CPM
amount mandatory int Amount
authCode mandatory string Barcode information
callbackUrl mandatory string Callback url
mobile optional string 11-14digit pure numbers starting with 09.
email optional string Email format
remark optional string Transaction description
# Response Params
parameter name type of data example description
code int 1000 Status code Reference List
message String success The message of status code
data Object - Response Data
- mchOrderId String E34302809202827219113 Merchant order id (unique for customer)
- channelCode String GCASH_CPM ChannelCode
- createTime String 2022-07-02 18:12:46 Create time
- paidTime String 2022-07-02 18:14:05 Paid time
- remark String - Remark
- status String SUCCESS Status
# Response Example
{
  "code": 1000,
  "message": "success",
  "data": {
    "mchOrderId": "ABAC2023060512457",
    "channelCode": "GCASH_CPM",
    "createTime": "2023-06-05 16:11:29",
    "paidTime": "2023-06-05 16:11:57",
    "remark": null,
    "status": "SUCCESS"
  }
}
# Failed Response Example Reference List
{
  "code": 1002,
  "message": "merchant white ip forbidden"
}