API Doc

# 1 Checkout Order

# Brief Description
  • Merchant - Checkout Order API
# Request URL
  • /api/v1/checkout
# Request Method
  • POST
# Request Header
parameter name Is it mandatory type of data description
Content-Type mandatory string application/json
# Request Body Parameters
parameter name Is it mandatory type of data length example description
appId mandatory string - - Application App ID
appName mandatory string - - Application Name
param mandatory string - - Request Body
sign mandatory string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 Sign
# Params
parameter name Is it mandatory type of data length example description
mchOrderId mandatory string 10-32 CCP20220428011068111 Merchant Order ID, format: alphanumeric, 1-32 characters
currency mandatory string 10 Default: "PHP"
amount mandatory long - 50000 Unit is in cents. Example: 50 pesos should be passed as 5000.
customer mandatory object(customer) - - User Information
items mandatory Array[item] - - Product Information
callbackUrl mandatory string 1-256 - Payment Callback URL
redirectUrl mandatory string 1-512 - Payment Redirect URL
metadata optional string 1-2000 - Additional Data
remark optional string 1-256 - Remark
availableChannelCodes optional string - - Available Channels: All channels by default
expireTime optional string - Expiration Time: "YYYY-mm-dd H:i:s" format
timestamp mandatory long - 1678356680000 Millisecond Timestamp
# Customer Params
parameter name Is it mandatory type of data length example description
firstName mandatory string 1-500 jack Format: Alphanumeric, 1-500 characters, support special characters #(),.'":;@&ñÑ+
lastName optional string 1-500 Format: Alphanumeric, 1-500 characters, support special characters #(),.'":;@&ñÑ+
email mandatory string 1-128 abc@gmail.com Payer's Email
mobile mandatory string 11-14 092737734772 Payer's Phone Number
address optional object - - User Address
# Item Params
parameter name Is it mandatory type of data length example description
name mandatory string 1-500 CCP20220428011068111 Product Name, format: Alphanumeric, 1-500 characters, support special characters #(),.'":;@&ñÑ+
amount mandatory long - 50000 Product Unit Price (Unit: cents). Example: 50 pesos should be passed as 5000.
quantity mandatory int - 10 Product Quantity
description optional String 1-1000 - Product Description
url optional string 1-500 - Product URL Address
# Request Example
{
  "appId": "{{appId}}",
  "appName": "{{appName}}",
  "param": "{\"appName\":\"paycools test\",\"mchOrderId\":\"{{mchOrderId}}\",\"idempotencyId\":\"{{mchOrderId}}\",\"appName\":\"paycools APP\",\"amount\":4000,\"accountNo\":\"09957734428\",\"accountName\":\"Sam Wu\",\"payMethodCode\":\"EWALLET\",\"transferCode\":\"GCASH\",\"timestamp\":{{$timestamp}}}",
  "sign": "{{sign}}"
}
# Response Example
{
  "code": 1000,
  "message": "success",
  "data": {
    "redirectUrl": "https://a.api-uat.paycools.com/1L9zxxx",
    "transactionStatus": "PENDING",
    "checkoutId": "CH1175676368800878371"
  }
}
# Failed Case Response Code Reference List Reference List
{
    "code":1002,
    "message":"merchant white ip forbidden"
}

← 2 Checkout Order Status →