1. PAYCO 연동개발 진행절차
STEP 1> 가맹점 방화벽 오픈
- 가맹점은 PAYCO 서비스와 연동하기 위해서 가맹점의 서버 IP에 대해 방화벽 오픈요청을 해야 결제연동이 가능합니다.
( 가맹점 URL이 80, 443 이외의 port 를 사용할 경우 사전 공유 부탁드립니다. )
STEP 2> 가맹점코드발급 요청
- PAYCO 서비스 이용시 가맹점코드(sellerKey), 상점 ID(cpId), 상품 ID(productID) 코드 발급이 필요합니다.
( 3. PAYCO 연동에 필요한 KEY 정보 참조 )
STEP 3> API 연동
- 가맹점 개발환경에서 연동 개발을 진행합니다. PAYCO 서비스에서는 연동 가이드 및 샘플소스를 제공합니다.
STEP 4> 서비스 오픈
- PAYCO 서비스를 시작하고 모니터링 합니다.
2. PAYCO 연동 API
- PAYCO는 가맹점의 환경에 따라 여러가지 결제 방식을 연동할 수 있도록 다양한 방법의 서비스를 제공하고 있습니다.
각 가맹점은 PAYCO 서비스에 원하는 서비스를 선택하여 연동하실 수 있습니다.
2-1. PAYCO 제공 API 목록
PAYCO 제공 API 목록 표
API명 |
필수/선택 |
주문유형 |
기타 참고 |
주문예약 |
필수 |
바로구매형, 간편결제형 |
|
주문상태변경 |
필수 |
바로구매형, 간편결제형 |
|
주문 및 결제취소 가능 여부 조회 |
필수 |
바로구매형, 간편결제형 |
|
주문 및 결제 취소 처리 |
선택 |
바로구매형, 간편결제형 |
|
마일리지 적립 취소 |
선택 |
바로구매형, 간편결제형 |
|
연동 키 유효성 체크 |
선택 |
바로구매형, 간편결제형 |
|
2-2. 가맹점에서 구현해야 할 API 목록
가맹점에서 구현해야 할 API 목록 표
API명 |
필수/선택 |
주문유형 |
기타 참고 |
주문 완료 통보 |
필수 |
바로구매형, 간편결제형 |
|
추가배송비 조회 |
필수 |
바로구매형 |
|
무통장 입금 완료 통보 |
필수 |
바로구매형, 간편결제형 |
|
주문 및 결제 취소 처리 |
무통장 이용시 필수 |
바로구매형, 간편결제형 |
|
2-3. PAYCO 연동 API 주소
PAYCO 연동 API 주소 표
용도 |
도메인 |
테스트 용 |
https://alpha-api-bill.payco.com |
서비스 용 |
https://api-bill.payco.com |
※ 도메인 하위 주소는 API 상세 명세 참조.
2-4. PAYCO 연동 API 공통 규약
- Content-type : application/json
- Protocol : Payco API 호출 시 https 프로토콜(443포트)을 사용해야 합니다. ( HTTP 는 제공하지 않습니다. )
- TLS 1.2 미만의 SSL/TLS 버전은 보안이 취약하여 지원하지 않습니다. 가맹점 서버의 HTTP 클라이언트 환경이 TLS 1.2를 지원하는지 확인해주세요.
INPUT ( Request )
- method = POST & Json 타입으로 값을 전달받습니다.
OUTPUT ( Response )
- API Response는 사전에 예고되지 않은 field가 추가될 수 있습니다.
- 추가되더라도 오류가 발생되지 않도록 연동 개발 부탁 드립니다.
◆ code
- code=0 이면 성공
- code>0 이면 실패 [에러코드 참고]
◆ result
- 각 API에 따라 다양한 Type으로 사용이 됩니다.
▷ Default format
PAYCO 연동 API 공통 규약 표
Column |
Type |
설명 |
1 code |
Number |
성공여부 |
2 message |
String |
성공/실패 message |
3 result |
Object |
API 별 응답 result Json의 배열 형태로 결과를 반환. 오류시에는 포함되지 않음. |
3. PAYCO 연동에 필요한 KEY 정보
- - 아래 항목은 가맹점 별로 발행 해 드리는 항목으로 주문 예약 및 취소 처리 시 필요한 값 들 입니다.
- ▷ sellerKey (가맹점 코드) : 파트너 센터에서 발급 받은 가맹점 코드
- ▷ cpId (상점 ID) : 간편결제 , 바로구매형 구분 없이 1개 발급
- ▷ productID (상품 ID) : 간편결제형 상품, 바로구매형 상품, 배송비 상품ID를 상품별로 각각 발급