거래생성
결제 화면 호출을 하기 위해 주문정보를 등록하고 결제창 호출 URL을 응답으로 받을 수 있습니다.
요청
요청 URL
POST https://{API 도메인}/api/trades/alipay
Content-type: application/json; charset=utf-8
참고
API 멱등성 지원 대상 (API 멱등성 참조)
파라미터
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| mallId | String | 8Byte | ✅ | KICC에서 부여한 상점ID |
| shopTransactionId | String | 60Byte | ✅ | 상점 거래고유번호 (API 멱등성 키) |
| shopOrderNo | String | 40Byte | ✅ | 상점 주문번호 반드시 Unique 값으로 생성 |
| goodsName | String | 100Byte | ✅ | 상품명(영문만 허용) |
| goodsDetail | String | 1000Byte | ✅ | 상품상세 내용(영문만 허용) |
| returnUrl | String | 256Byte | ✅ | 인증 완료 후 이동할 URL |
| walletBrandName | String | 20Byte | ✅ | Alipay 지갑 이름 일반통합 결제: “CONNECT_WALLET” 일반결제 : ALIPAY_CN, ALIPAY_HK, 등 |
| terminalType | String | 3Byte | ✅ | 터미널 종류 “APP”, “WEB”, “WAP” |
| osType | String | 7Byte | ✅ | “IOS”, “ANDROID” 터미널 종류가 APP/WAP일 경우 |
| notifyUrl | String | 256Byte | 결제 완료 후 결제 정보를 받을 URL 상점 방화벽 INBOUND 등록 필요 | |
| amountInfo | Object | ✅ | 결제금액 정보 (아래 amountInfo 참조) | |
| customerInfo | Object | 주문 고객 정보 (아래 customerInfo 참조) |
amountInfo(결제금액 정보)
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| currency | String | 3Byte | ✅ | 통화코드 원화: "KRW", 달러: "USD" |
| totalAmount | Number | ✅ | 총 결제금액 USD일 경우 * 100으로 요청, $12.03 이면 1203으로 요청 |
customerInfo(주문 고객정보)
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| customerId | String | 20Byte | 고객 ID | |
| customerName | String | 20Byte | 고객명 | |
| customerMail | String | 50Byte | 고객 Email | |
| customerContactNo | String | 11Byte | 고객 연락처(숫자만 허용) | |
| customerAddr | String | 200Byte | 고객 주소 |
요청 예시
{
"mallId": "{상점ID}",
"shopTransactionId": "{API 멱등성 키}",
"shopOrderNo": "{상점 주문번호}",
"goodsName": "예시 상품명",
"goodsDetail": "예시 상품상세",
"returnUrl": "{상점 리턴 URL}",
"walletBrandName": "CONNECT_WALLET",
"terminalType": "WEB",
"osType": "IOS",
"notifyUrl": "{결제 완료 후 결제 정보를 받을 URL}",
"amountInfo": {
"currency": "KRW",
"totalAmount": 1000
},
"customerInfo": {
"customerId": "고객ID",
"customerName": "고객명",
"customerMail": "고객 Email",
"customerContactNo": "고객 연락처",
"customerAddr": "고객 주소"
}
}
응답
파라미터
| 필드명 | 타입 | 길이 | 설명 |
|---|---|---|---|
| resCd | String | 4Byte | 결과코드(정상 : “0000”) |
| resMsg | String | 1000Byte | 결과 메시지 |
| shopTransactionId | String | 60Byte | 발급요청 시 전송한 값 그대로 사용 |
| pgCno | String | 20Byte | 결제 거래고유번호 |
| paymentPageUrl | String | 2048Byte | 결제창 호출 URL |
| normalUrl | String | 2048Byte | |
| schemeUrl | String | 2048Byte | |
| appLinkUrl | String | 2048Byte |
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"shopTransactionId": "{API 멱등성 키}",
"pgCno": "결제 거래고유번호",
"paymentPageUrl": "{결제창 호출 URL}"
}
알리페이 지갑이름(walletBrandName)
통합 결제(알리페이 플러스)는 일반 결제에 있는 지갑들이 모두 제공되는 서비스 입니다.
| 구분 | 지갑이름 | 설명 |
|---|---|---|
| 통합 결제 | CONNECT_WALLET | 알리페이에서 제공하는 통합 결제 지갑 |
| 일반 결제 | ALIPAY_CN | 알리페이(중국) |
| ALIPAY_HK | 알리페이(홍콩) | |
| TRUEMONEY | 트루머니(태국) | |
| TNG | 터치앤고(말레이시아) | |
| GCASH | G캐쉬(필리핀) | |
| DANA | 다나(인도네시아) | |
| KAKAOPAY | 카카오페이(한국) |