API 레퍼런스
API 개요
결제 게이트웨이 API 3개 + 콜백 1개, 청구 서버 API의 엔드포인트 목록입니다.
결제 게이트웨이
BASE_URL: 테스트 https://dev-api.chewingpay.com · 운영 https://api.chewingpay.com · 인증 API_SIGN
| 메서드 | 경로 | 하는 일 | SDK |
|---|---|---|---|
| POST | /api/requestPayment | 결제 생성 → 결제 페이지 링크 발급 | createPayment() / create_payment() |
| POST | /api/searchPayment | 거래 상태·승인 정보 조회 | getPayment() / get_payment() |
| POST | /api/requestPaymentCancel | 결제 취소(전액) · 미결제 청구 삭제 | cancelPayment()·deleteBill() |
| POST | {CONFIRM_URL} | 결제 완료 콜백 (귀사가 구현) | confirmCallback() |
청구 서버
BASE_URL: https://api.dev.caripay.co.kr · 인증 x-access-token
| 메서드 | 경로 | 하는 일 | SDK |
|---|---|---|---|
| POST | /app/v1/auth/login | 로그인 → 접근·리프레시 토큰 | CariPayBilling.login() |
| POST | /app/v1/auth/refresh | 토큰 갱신 | 자동 |
| POST | /app/v1/sales/bill | 청구서 생성 + 알림톡/문자 발송 접수 | sendInvoice() |
| GET | /app/v1/sales/bill | 청구서 목록(월별) | listInvoices() |
| GET | /app/v1/sales/bill/{id} | 청구서 상세 + 결제 정보 + 발송 이력 | getInvoice() |
| POST | /app/v1/sales/bill/resend | 재발송 | — |
| DELETE | /app/v1/sales/bill/{id} | 미납 청구서 삭제 | — |
| PUT | /app/v1/sales/bill/{id} | 결제 완료 건 취소(환불) | — |
| GET | /app/v1/sales/public/bill/{transSeqNo} | 공개 청구서 조회(인증 없음) | — |
| GET | /app/v1/points/me | 발송 포인트 잔액 | — |
규격 파일
openapi.yaml— 결제 게이트웨이billing-openapi.yaml— 청구 서버
문서에 없는 내용이나 오류는 bellight@goatheaven.com 또는 지원 문의로 알려주세요.