Create Transaction

This API registers order information to invoke the payment screen and receives the Payment Window URL in the response.

Request

Request URL

POST https://{API Domain}/api/trades/alipay
Content-type: application/json; charset=utf-8

Note

Supports API Idempotency (See API Idempotency)

Parameters

Field Name	Type	Length	Required	Description
mallId	String	8Byte	✅	Merchant ID assigned by KICC
shopTransactionId	String	60Byte	✅	Merchant Transaction ID (API Idempotency Key)
shopOrderNo	String	40Byte	✅	Merchant Order No. Must be Unique.
goodsName	String	100Byte	✅	Product Name (English Only)
goodsDetail	String	1000Byte	✅	Product Detail (English Only)
returnUrl	String	256Byte	✅	URL to redirect to after authentication completes
walletBrandName	String	20Byte	✅	Alipay Wallet Name Integrated (Alipay+): “CONNECT_WALLET” Specific: ALIPAY_CN, ALIPAY_HK, etc.
terminalType	String	3Byte	✅	Terminal Type “APP”, “WEB”, “WAP”
osType	String	7Byte	✅	OS Type (“IOS”, “ANDROID”) Required if terminalType is APP/WAP
notifyUrl	String	256Byte		Webhook URL for Payment Completion Must whitelist KICC IPs (Inbound)
amountInfo	Object		✅	Payment Amount Info (See amountInfo below)
customerInfo	Object			Customer Info (See customerInfo below)

amountInfo (Payment Amount Info)

Field Name	Type	Length	Required	Description
currency	String	3Byte	✅	Currency Code (KRW: "KRW", USD: "USD")
totalAmount	Number		✅	Total Payment Amount For USD: Amount * 100 (e.g., $12.03 -> 1203)

customerInfo (Customer Information)

Field Name	Type	Length	Required	Description
customerId	String	20Byte		Customer ID
customerName	String	20Byte		Customer Name
customerMail	String	50Byte		Customer Email
customerContactNo	String	11Byte		Customer Contact No. (Numbers only)
customerAddr	String	200Byte		Customer Address

Request Example

{
    "mallId": "{Merchant ID}",
    "shopTransactionId": "{API Idempotency Key}",
    "shopOrderNo": "{Merchant Order No}",
    "goodsName": "Sample Product",
    "goodsDetail": "Sample Details",
    "returnUrl": "{Merchant Return URL}",
    "walletBrandName": "CONNECT_WALLET",
    "terminalType": "WEB",
    "osType": "IOS",
    "notifyUrl": "{Webhook URL}",
    "amountInfo": {
        "currency": "KRW",
        "totalAmount": 1000
    },
    "customerInfo": {
        "customerId": "User123",
        "customerName": "John Doe",
        "customerMail": "test@email.com",
        "customerContactNo": "01012345678",
        "customerAddr": "Seoul, Korea"
    }
}

Response

Parameters

Field Name	Type	Length	Required	Description
resCd	String	4Byte	✅	Response Code (Success: “0000”)
resMsg	String	1000Byte	✅	Response Message
shopTransactionId	String	60Byte	✅	Returns the value sent in the request
pgCno	String	20Byte		PG Transaction ID
paymentPageUrl	String	2048Byte		Payment Window URL (Redirect user here)
normalUrl	String	2048Byte		(Reserved)
schemeUrl	String	2048Byte		(Reserved)
appLinkUrl	String	2048Byte		(Reserved)

Response Example

{
   "resCd": "0000",
   "resMsg": "Success",
   "shopTransactionId": "{API Idempotency Key}",
   "pgCno": "{PG Transaction ID}",
   "paymentPageUrl": "{Payment Window URL}"
}

Alipay Wallet Names (walletBrandName)

Integrated Payment (Alipay+) is a service that provides access to all wallets available in the standard payment system.

Type	Wallet Name	Description
Integrated (Alipay+)	CONNECT_WALLET	Unified Wallet provided by Alipay
Specific Wallet	ALIPAY_CN	Alipay (China)
	ALIPAY_HK	Alipay (Hong Kong)
	TRUEMONEY	TrueMoney (Thailand)
	TNG	Touch 'n Go (Malaysia)
	GCASH	GCash (Philippines)
	DANA	DANA (Indonesia)
	KAKAOPAY	KakaoPay (Korea)