CookiePayments Documentation

안녕하세요. 가장 쉬운 결제연동 쿠키페이를 지금 시작합니다.

쿠키페이 API는 여러분의 웹 또는 앱에 결제화면을 띄우는 API입니다. 쉽게 적용할수 있도록 언어별 예제를 제공하고 있으며 본 매뉴얼은 API요청에 필요한 준비방법과 결제 방식에 대한 가이드입니다. 기술관련 도움이 필요시, 전문 개발자가 도움을 드리고 있으며 추가 기능이 계속 업데이트 될 예정입니다.

API 가이드 구성

1. API연동 결제 FLOW
2. 결제연동 준비하기
   1. 회원가입하기
   2. PG사 신청 (가맹점 정보입력)
   3. 가맹점 정보 확인하기
   4. 결제 전 설정하기 (PGID 검증)
3. 결제 연동 API
   1. 인증결제
      • 1.1 인증결제 결제요청 전문
        • 라이브러리 추가
        • 결제 준비하기
        • 결제 요청하기
        • 샘플예제
        • 요청전문 파라미터
      • 1.2 인증결제 응답 전문
      • 1.3 인증결제 결제정보 검증 후 저장
        • 토큰발행 URL
        • 토큰요청 전문 파라미터
        • 결제검증 URL
        • 결제검증 요청 전문 파라미터
        • 샘플예제
        • 결제검증 응답 전문 파라미터
   2. 비인증결제 (수기,카드번호로 결제 요청)
      • 2.1 비인증결제 결제요청 전문
        • 라이브러리 추가
        • 결제 준비하기
        • 결제 요청하기
        • 샘플예제
        • 요청전문 파라미터
      • 2.2 비인증결제 응답 전문
      • 2.3 비인증결제 결제정보 검증 후 저장
        • 토큰발행 URL
        • 토큰요청 전문 파라미터
        • 결제검증 URL
        • 결제검증 요청 전문 파라미터
        • 샘플예제
        • 결제검증 응답 전문 파라미터
4. 전표출력 API
5. 결제취소 API
6. 결제URL 발송 API (SMS, 이메일, 카카오청구서 결제요청)
7. 카카오청구서 API
8. 결제내역조회 API
9. 휴대폰인증번호 API
10. 정기결제
11. PG사 정산대사

API 연동 결제 FLOW

프로세스

1.쿠키페이로 결제요청
2.PG사로 결제요청 데이터 전송
  전송값에 이상이 있을시 결제 진행이 되지 않으며 오류가 됩니다.
3.PG결제폼 제공
  각 PG사의 결제창(스타일 변경불가)이 팝업됩니다.
4.결제실행
    결제정보를 PG사 서버로 전송하며, PG사에서는  각 카드사에 해당 정보를 전송하게 됩니다.
5.PG사 결제완료 데이터 전송
    PG사로부터 쿠키페이 서버로 결제완료 정보가 전송됩니다.
6.쿠키페이 결제완료 데이터 전송
    결제완료 정보를 클라이언트로 전송합니다.
7.클라이언트에서 송신된 결제정보 서버조회(결제검증) 후 결제완료 처리

연동 준비하기

• API를 사용하려면 먼저 쿠키페이 회원가입을 하고 아이디와 키값을 발급받아야 합니다 .
• 아이디와 키값은 쿠키페이 가맹점(사업자번호별로 각각의 가맹점으로 등록) 을 확인하는 수단이며 가맹점 가입 시점에 발급됩니다.
• 쿠키페이 API를 호출할때 HTTP헤더에 아이디와 키값을 포함해서 전송해야 결제호출을 할수 있습니다

1. 회원가입

1.1 회원 가입
1.2 이메일 로그인

2. PG사 신청하기

• 이메일 로그인 > PG사 설정 > PG신청
• 이용할 PG사를 선택 후, 연동할 사업자의 정보를 간단히 입력합니다.
• PG신청은 연동개발과 상관없이 언제든지 가능하며, 사업자번호 별로 각각 PG신청 및 관리를 할 수 있습니다.
• 가맹점 정보를 입력하여 연동 아이디와 키값 발급받기

2.1 PG사를 선택합니다
2.2 온라인 가입하기 클릭 후 사업자 정보를 입력합니다.
2.3 가입현황을 확인합니다. (신청결과 확인)
    - 이메일 로그인 > PG사 설정 > PG가입현황

3. 가맹점 연동 ID, KEY값 확인하기

• 이메일 로그인 > PG사 설정(API) > PG설정
• 연동을 위한 필수값인 연동 ID와 KEY값은 각 가맹점 PG신청시 자동 발급되어 PG설정 페이지에서 가맹점의 연동정보를 확인할 수 있습니다.
• 연동ID는 PG사의 상점아이디(PGID)와는 무관하며, 키값 보안을 위해 노출에 주의하셔야 합니다.
• 시크릿 KEY는 재발급이 가능합니다.

4. 결제 전 설정하기 (PGID검증)

• 이메일 로그인 > PG사 설정(API) > PG설정 > '설정하기'
• PG사 가입 및 심사가 완료되었다면 실결제를 위한 설정을 할 수 있습니다.
• PG설정 페이지에서 해당 가맹점의 연동설정 클릭 후, PG사로부터 메일로 받은 상점아이디(PGID)를 입력합니다.
• 상점아이디 검증완료시 PG사의 암호화키가 확인되며 결제를 위한 설정이 완료됩니다.
• 선택적으로 시크릿 KEY 의 재발급, 접근 아이피 제한, 허용할 할부개월수 설정, 상태 등이 항시 가능합니다.