API 연동 시 주의사항

API 연동은 클라이언트에 노출되지 않도록 반드시 서버간에 연동하시기 바랍니다.
또한, 상점 MID 발급 후 제공되는 SECRET KEY도 웹에 노출되지 않도록 서버 구간에서 관리를 하시기 바랍니다.

결제금액 검증

결제응답으로 전달하는 금액이 가맹점 DB의 금액과 상이할 경우 반드시 결제취소 요청하는 로직을 구현하여 주시기 바랍니다.

결제창 연동 시 주의사항

Mobile 환경 연동시에 iframe 으로 호출시 브라우저 정책 혹은 카드사 정책상 정상 동작이 되지 않을 수 있어 페이지 전환 방식을 권고합니다.

요청URL 확인

개발 작업 후 운영 적용 시는 테스트환경을 운영환경으로 세팅하셔야 합니다.
테스트환경에서 운영환 경으로 변경하지 않아 발생하는 손실은 당사에서 책임지지 않습니다.

특수문자 사용제한

결제 요청 시 아래 특수문자를 입력할 경우 오류가 발생할 수 있습니다.
엠퍼센트(&), 콤마(,), 세미콜론(;), 뉴라인(\n), 역슬래시(\), 파이프라인(|), 작은따옴표(‘), 큰따옴표(“)

하위 호환성

이지페이 API 서비스는 하위 호환성 준수 변경에 대해서는 제공되는 API의 버전 변경 없이 진행됩니다. 하위 호환성 미준수 변경에 대해서는 새롭게 릴리즈 하거나, 신규 URI를 통해 제공됩니다.

하위 호환성 준수 변경기준

   신규 API 엔드포인트 추가
   API 요청에 새로운 선택 파라미터 추가
   API 요청에서 필수 파라미터를 선택 파라미터로 변경
   API 응답에 새로운 파라미터 추가
   새로운 Enum Value 추가
   새로운 오류 코드 추가 및 오류 메시지 변경

하위 호환성 비준수 변경기준

   API 엔드포인트 제거
   API 요청에 새로운 필수 파라미터 추가
   API 요청에 선택 파라미터를 필수 파라미터로 변경
   API 응답에 사용 필수 파라미터 삭제
   API 요청 및 응답 항목의 데이터 타입 변경

클라이언트 하위 호환성 설정 가이드

   Java의 예를 들어 설명하면, Jackson의 경우 ObjectMapper를 선언해서 사용하면 default 옵션이 기본적으로 켜져 있기 때문에 필드가 추가되었을 때 이를 처리하지 못합니다.
   이지페이 API의 필드 추가 등의 변경으로 인하여 영향을 발생하지 않도록 아래와 같은 설정이 필요 합니다.
   Jackson 2.0
     objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);