PAYCO Developer

1. 자동결제 등록 예약(payco_reserve)

• PAYCO 자동 결제 등록 및 변경 페이지를 띄우기 전에 자동 결제 등록 예약 API를 통해 필요한 정보를 전달한다.
• 가맹점에서는 자동 결제 등록 예약 API 응답으로 받은 주문서 URL 을 팝업으로 띄운다. 자동 결제 정보 변경이 필요한 경우에는 변경이 필요한 자동결제번호 와 인증키 정보를 필수로 전달한다. (autoPaymentNo, autoPaymentCertifyKey)
• 1) PAYCO 자동 결제 등록 팝업 오픈시 팝업차단을 위한 개발 TIP!!
  • - orderSheetUrl로 PAYCO 팝업오픈시엔 가맹점페이지 오픈 후 피드백받은 orderSheetUrl을 redirect처리하도록 한다.
  • - 팝업 오픈은 POST방식의 submit은 지양하도록 한다. ( IE11 관리자모드 about:blank 새창 오픈 )
• METHOD : POST
• URL : /outseller/autoPayment/reserve

자동 결제 등록 예약 API > INPUT

▷ 15번 컬럼 extraData

▷ 15번 컬럼 extraData의 viewOptions 화면UI 옵션

					
{
	"sellerAutoPaymentReferenceKey": "TEST1041031058328",
	"autoPaymentNo": "",
	"sellerKey": "S0FSJE",
	"autoPaymentCertifyKey": "",
	"extraData": "{\"cancelMobileUrl\":\"http://www.payco.com\",\"viewOptions\":{\"iframeYn\":\"N\",\"showMobileTopGnbYn\":\"\"}}",
	"cpId": "PARTNERTEST_AUTO",
	"orderChannel": "PC",
	"returnUrlParam": "{\"cart_no\":\"20151234567\"}",
	"orderMethod": "EASYPAY_F",
	"totalPaymentAmt": 69000,
	"currency": "KRW",
	"inAppYn": "N",
	"returnUrl": "http://localhost/jsp/autoPayment//autoPayment_return.jsp",
	"orderTitle": "자동결제 테스트(JSP)"
}
					
					

자동 결제 등록 예약 API > OUTPUT

					
{
	"result": {
		"reserveOrderNo": "201608312004340321",
		"orderSheetUrl": "https://alpha-bill.payco.com/autoPayment/easyLogin/201608312004340321"
	},
	"code": 0,
	"message": "success"
}
					
					

2. 자동결제(payco_autopayment)

• METHOD : POST
• URL : /outseller/autoPayment/payment

자동 결제 API > INPUT

▷12번 컬럼 orderProducts 주문상품 List

					
{
	"autoPaymentNo": "201608311000022591",
	"totalPaymentAmt": 69000,
	"totalTaxfreeAmt": 0,
	"sellerKey": "S0FSJE",
	"autoPaymentCertifyKey": "zxi8rFXWRA5MeOStIWSXf01u5Euz06Ux9dAU8zVcfmXNGH9ZJZ5bW9hylkHHSXZ8",
	"totalVatAmt": 6900,
	"orderProducts": [{
		"productImageUrl": "",
		"orderConfirmMobileUrl": "",
		"productId": "PROD_AUTO",
		"productPaymentAmt": 69000,
		"productAmt": 69000,
		"cpId": "PARTNERTEST_AUTO",
		"sortOrdering": 1,
		"orderQuantity": 1,
		"productName": "테스트 상품1",
		"orderConfirmUrl": "",
		"taxationType": "TAXATION",
		"sellerOrderProductReferenceKey": "ITEM_100001",
		"option": "테스트입니다"
	}],
	"currency": "KRW",
	"totalTaxableAmt": 62100,
	"orderTitle": "자동결제 테스트 상품",
	"sellerOrderReferenceKeyType": "UNIQUE_KEY",
	"sellerOrderReferenceKey": "TEST3429654693"
}
					
					

자동 결제 API > OUTPUT

▷ 12번 컬럼의 deliveryPlace (배송지)

▷ 13번 컬럼의 orderProducts (주문상품List)

▷ paymentDetails (결제내역 List)

▷ cardSettleInfo (카드결제정보)

▷ cellphoneSettleInfo(핸드폰 결제 정보)

					
{
	"result": {
		"sellerOrderReferenceKey": "TEST3429654693",
		"orderNo": "201608312002168126",
		"memberName": "강**",
		"memberEmail": "na****",
		"orderChannel": "기타",
		"totalOrderAmt": 69000,
		"totalDeliveryFeeAmt": 0,
		"totalRemoteAreaDeliveryFeeAmt": 0,
		"totalPaymentAmt": 69000,
		"orderProducts": [{
			"orderProductNo": "201608312002324128",
			"sellerOrderProductReferenceKey": "ITEM_100001",
			"orderProductStatusCode": "OPSPAED",
			"orderProductStatusName": "결제완료",
			"cpId": "PARTNERTEST_AUTO",
			"productId": "PROD_AUTO",
			"productKindCode": "GENERAL_PRODUCT",
			"productPaymentAmt": 69000,
			"originalProductPaymentAmt": 69000
		}],
		"paymentDetails": [{
			"cardSettleInfo": {
				"cardCompanyName": "삼성카드",
				"cardCompanyCode": "CCSS",
				"cardNo": "941010******1234",
				"cardInstallmentMonthNumber": "00",
				"cardAdmissionNo": "11055600",
				"cardInterestFreeYn": "N",
				"corporateCardYn": "N",
				"partCancelPossibleYn": "Y"
			},
			"paymentTradeNo": "201608312002742896",
			"paymentMethodCode": "51",
			"paymentMethodName": "신용카드(자동)",
			"paymentAmt": 69000,
			"tradeYmdt": "20160831145454",
			"pgAdmissionNo": "16494900698257",
			"pgAdmissionYmdt": "20160831145454",
			"easyPaymentYn": "N"
		}],
		"orderCertifyKey": "ZH2eIuuh4Q9Bah67WMH9DCBVd1C1Atm566MJLundf2ICC",
		"autoPaymentNo": "201608311000022591",
		"paymentCompleteYmdt": "20160831145454"
	},
	"code": 0,
	"message": "success"
}
					
					

3. 자동 결제 정보 조회

• 등록된 자동 결제 정보를 조회한다.
• URL : /outseller/autoPayment/info

자동 결제 정보 조회 > INPUT

					
{
	"sellerAutoPaymentReferenceKey": "TEST3429654693",
	"sellerKey": "S0FSJE",
	"autoPaymentCertifyKey": "zxi8rFXWRA5MeOStIWSXf01u5Euz06Ux9dAU8zVcfmXNGH9ZJZ5bW9hylkHHSXZ8"
}
					
					

자동 결제 정보 조회 > OUTPUT

					
{
	"result": {
		"sellerAutoPaymentReferenceKey": "TEST3429654693",
		"autoPaymentCertifyKey": "zxi8rFXWRA5MeOStIWSXf01u5Euz06Ux9dAU8zVcfmXNGH9ZJZ5bW9hylkHHSXZ8",
		"autoPaymentNo": "201608311000022591",
		"paymentMethodCode": "51",
		"paymentMethodName": "신용카드(자동)",
		"pinNo": "************1234",
		"corporationCode": "CCSS",
		"corporationName": "삼성카드",
		"registYmdt": "20160831145438"
	},
	"code": 0,
	"message": "success"
}
					
					

4. 자동결제 삭제

• 가맹점에서 자동결제가 해지되는 경우 자동결제 삭제 API를 호출하여 등록된 정보를 삭제한다.
• URL : /outseller/autoPayment/delete

자동결제 삭제 API > INPUT

					
{
	"sellerAutoPaymentReferenceKey": "TEST3429654693",
	"sellerKey": "S0FSJE",
	"autoPaymentCertifyKey": "zxi8rFXWRA5MeOStIWSXf01u5Euz06Ux9dAU8zVcfmXNGH9ZJZ5bW9hylkHHSXZ8"
}
					
					

5. 외부 가맹점 API 상세

• 외부가맹점은 아래 API를 제공해야 합니다.
• API 스펙은 PAYCO에서 정의한 대로 개발되어 있어야 합니다
• 자동 결제 등록 및 변경 완료
  • 자동 결제 등록 예약 API 연동 시 파라미터로 'returnUrl'을 전달하게 된다.
  • 'returnUrl'은 결제인증완료URL로 외부가맹점이 제공하는 페이지이다.
  • 자동 결제 등록 및 변경 성공시점 또는 사용자 취소시 외부가맹점의 returnUrl로 이동한다.
  • 캐릭터셋은 UTF-8이며, POST로 전달한다.
  • 예약시 returnUrlParam 값에 셋팅된 정보가 존재시 해당값을 추가하여 returnUrl을 호출한다.
  • 예] 예약API 호출시 전달된 정보

  "returnUrl": "https://alpha-api-bill.payco.com/test/surl/ok",
  "returnUrlParam" : "{\"returnUrlParam1\":\"data1\", \"returnUrlParam2\":300}",

  • 예] 결제인증완료 호출 페이지

  http://alpha-api-bill.payco.com/test/surl/ok?returnParam1=data1&returnParam2=300

  • 자세한 항목은 아래 'returnUrl 로 전달되는 정보'를 참고한다.
  • 가맹점에서는 reserveOrderNo와 sellerAutoPaymentReferenceKey가 일치하는지 확인한다.
  • 자동결제 정보 조회 API를 이용하여 자동 결제시 필요한 정보를 조회한다. (autoPaymentNo)

returnUrl 로 전달되는 정보

6. 유의사항

• ERROR 코드 9000은 시스템 점검시 내려주는 코드이므로 해당 코드에 대한 메시지는 사용자에게 노출처리 부탁드립니다.
• 결제수단 코드가 추가 될 수 있으니 참고부탁드립니다.
• 자동 결제 등록 및 변경 성공시점 또는 사용자 취소시 외부가맹점의 returnUrl로 이동한다.
• 모바일웹의 경우 페이코 연동은 페이지 이동방식으로 작업 부탁드립니다.
• 예약시 returnUrlParam 값에 셋팅된 정보가 존재시 해당값을 추가하여 returnUrl을 호출한다.
• 자동결제 등록 예약API > 부가정보(extraData) > cancelMobileUrl에 취소버튼 클릭시 이동할 URL을 추가로 보내주세요.