Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 8.12 KB

status-event.md

File metadata and controls

93 lines (73 loc) · 8.12 KB

카드 이벤트

카드 이벤트 조회 | 더 알아보기


Over-view

카드 이벤트 조회 API는 요청된 기준금액에 해당되는 카드사별 이벤트 정보를 응답 합니다.
이벤트 정보를 결제자에게 전달하여 카드사 선택을 위한 정보를 편리하게 제공할 수 있습니다.

기준금액이 5만원 이하 인 경우 무이자는 미제공하는 것으로 응답 됩니다.


샘플 코드

curl -X GET 'https://api.nicepay.co.kr/v1/card/event?amount={금액}&useAuth=false&ediDate={ISO 8601 형식}&...' 
-H 'Content-Type: application/json' 
-H 'Authorization: Basic YWYwZDExNjIzNmRmNDM3ZjgzMT...'

요청 명세

GET /v1/card/event?amount={금액}&useAuth=false&ediDate={ISO 8601 형식}&...   HTTP/1.1  
Host: api.nicepay.co.kr 
Authorization: Basic <credentials>  or Bearer <token>
Content-type: application/json;charset=utf-8
Parameter Type 필수 크기 설명
amount N O 12 기준금액
기준금액에 해당하는 카드 이벤트 정보를 제공합니다.
useAuth B O - 인증 거래 여부
true : 인증 / false : 비인증(빌링)
ediDate S O - 전문생성일시
ISO 8601 형식
mid S 　 10 상점 MID
일반적으로 사용하지 않지만, mid가 요청된 경우, 최우선하여 제공.
(요청된 clientId하위 가맹점여부 검증 필수)
signData S 　 256 위변조 검증 Data
생성규칙 : hex(sha256(ediDate + SecretKey))
- SecretKey는 가맹점관리자에 로그인 하여 확인 가능합니다.
returnCharSet S 　 10 응답파라메터 인코딩 방식
가맹점 서버의 encoding 방식 전달
예시) utf-8(Default) / euc-kr

응답 명세

POST
Content-type: application/json
Parameter Type 필수 Byte 설명
resultCode String O 4 결과코드
0000 : 성공 / 그외 실패
resultMsg String O 100 결과메시지
ediDate String - 응답전문생성일시
ISO 8601 형식
signature String 　 256 위변조 검증 데이터
- 유효한 거래건에 한하여 응답
- 생성규칙 : hex(sha256(ediDate+ SecretKey))
- 데이터 유효성 검증을 위해, 가맹점 수준에서 비교하는 로직 구현 권고
- SecretKey는 가맹점관리자에 로그인 하여 확인 가능합니다.
cardPoint String 　 　 포인트 결제 지원 카드
-콜론(:)을 구분자로 카드코드 나열
-카드사포인트는 amount에 관계 없이 이용가능한 카드사정보 제공
ex) 01:02:04:07
- 설명 : BC,국민,삼성,현대 카드는 카드사포인트 사용 가능

무이자 할부정보

Parameter Type 필수 Byte 설명
interestFree Array - 제공되는 모든 무이자 할부정보
- NICEPAY에서 기본제공하는 무이자와 상점무이자가 merge된 정보
- 카드코드별 하나의 무이자 Object가 응답됩니다.
cardCode String O 3 카드사 코드
신용카드사별 코드
cardName String O 20 카드사 이름
예) 비씨
freeInstallment String O 200 무이자 할부개월
콜론(:)을 구분자로 할부개월 나열
ex) 02:03:04:05
- 설명 : 2,3,4,5개월 무이자 할부 제공

더 알아보기

결제 개발을 위해 더 상세한 정보가 필요하다면📌 공통 탭의 정보를 활용하고,
API 개발을 위한 각 인터페이스의 개발 명세가 필요하다면 📚 문서 탭의 자료를 확인 해주세요.
개발이 완료되어 운영에 필요한 정보와 Tip은 ☸️ 운영 탭의 정보를 통해 확인이 가능 합니다.

📌 공통

개발 전 필요한 공통적인 가이드 입니다.

📚 문서

API 명세와 코드가 포함된 기술문서 입니다.

☸️ 운영

운영에 필요한 정보 입니다.