API 연동방식 - iPay 연동방법 중 API연동방식 안내입니다.

사전 준비단계(STEP01.옥션 사업자/판매자 가입 STEP02.iPay 파트너 가입) 시스템 연동단계(STEP03.iPay 인증키 발급 STEP04.iPay 연동 및 테스트)운영단계(STEP05.판매관리)

API 연동방식 이란?

  • 자신이 운영하고 있는 쇼핑몰의 상품 상세페이지 혹은 주문서에 자동으로 iPay결제버튼이 붙어
    주문서가 연동되게 하는 방식으로 기존 쇼핑몰을 운영하고 있는 분들이 주로 이용하는 방식입니다.

  • API방식으로 시스템 연동 시, iPay 와 통신에 필요한 고유 키입니다.
    인증키는 iPay 가입 신청이 정상적으로 완료되면 가입신청 팝업 하단에서 확인할 수 있습니다.

인증키 확인하기

API 연동하기

  • 쇼핑몰에서 iPay 결제를 서비스하려고 하는 경우, 총 3가지 연동이 필요합니다.

01. 결제 연동

  • 주문서 혹은 상품상세보기 페이지에 결제 버튼을 노출시키고, iPay쪽에 결제를 위한 주문정보를 보내 고유번호를 받아
    결제 창을 띄워 결제를 완료하고 최종 결제번호까지를 부여 받는 연동절차입니다.
이름 API명 API역할
결제연동
카트번호요청
결제완료 정보조회
취소관리
배송 전 결제취소
송금완료 후 결제취소
정보조회
결제완료 여부 조회(*)
주문상태조회
결제수단조회

02. 주문관리 연동

  • 결제에 대한 변동사항 즉, 결제완료 여부 확인, 무통장입금확인, 주문취소, 결제취소, 구매결정은 기본적으로 연동을
    하도록 되어 있습니다.
  • iPay 판매관리를 이용하지 않고, 쇼핑몰에서 자체적으로 판매관리를 구축하실 경우 선택적으로 추가연동 작업을 할 수 있습니다.
이름 API명 API역할
주문조회
결제완료 주문내역조회
발주확인
발주확인으로 정보업데이트
취소관리
발주완료 배송 전 취소 건 조회
발주확인 후 배송 전 취소환불 처리
발송관리
일반발송
발송주소록내역조회
발송 방법 변경
문의내역 상세 조회
문의관리
구매자 문의 목록 조회
문의 답변
교환요청 내역 상세조회
교환관리
구매자 교환요청 건 목록 조회
구매자에 의한 반품 요청 건 목록 조회
반품관리
반품 승인 및 환불
반품 승인 거부처리
판매자 반품 신청
결제연동
구매결정요청

* API 연동에 관한 자세한 사항은 연동규격서를 다운받아 확인이 가능합니다.

API 목록 전체 확안하기 iPay API 연동규격서 다운받기

03. 에스크로 마크 연동

  • 쇼핑몰 특정 위치에 iPay 안전결제(에스크로)서비스를 이용하고 있음을 확인해 주는 안전결제 마크를 연동하는 작업입니다.