샌드박스 API - nicepayments/nicepay-manual GitHub Wiki
샌드박스 서비스는 요청과 응답을 체험해볼 수 있는 서비스로 일부 제한된 기능을 제공하고 있습니다. 인증 구간은 실제 결제창 호출을 경험해볼 수 있으나, 승인 구간에서는 결제가 발생하지 않습니다.
샌드박스 도메인 정보
| 서비스 | 도메인 |
|---|---|
| 샌드박스 | https://sandbox-api.nicepay.co.kr |
토큰 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/access-token | POST | AccessToken 발급 | server 승인 & bearer 인증으로 발급한 가맹점 키 값으로 요청 |
승인관련 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/payments/{tid} | POST | 승인 API | 결제 수단 별 기정의된 응답 값을 반환 |
| /v1/payments/{tid}/cancel | POST | 결제 취소 API | 부분취소 불가, 전액취소만 가능 |
| /v1/payments/netcancel | POST | 망상취소-orderId | |
| /v1/payments/{tid} | GET | 거래조회 - tid | |
| /v1/payments/find/{orderId} | GET | 거래조회 - orderId | |
| /v1/check-amount/{tid} | POST | 승인금액검증 |
정기결제 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/subscribe/regist | POST | 빌키발급 | 기정의된 응답 값을 반환 |
| /v1/subscribe/{bid}/payments | POST | 빌키승인 | 기정의된 응답 값을 반환 |
| /v1/subscribe/{bid}/expire | POST | 빌키삭제 |
현금 영수증 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/receipt/ | POST | 현금영수증 발급 | 기정의된 응답 값을 반환 |
| /v1/receipt/{tid}/cancel | POST | 현금영수증 취소 | |
| /v1/receipt/cancel | POST | 현금영수증 orderId취소 | |
| /v1/receipt/{tid} | GET | 현금영수증 거래조회 |
약관 및 정보 관련 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/card/event | GET | 카드 이벤트 조회 | |
| /v1/card/interest-free | GET | 카드 무이자정보 조회 | |
| /v1/terms | GET | 약관조회 |
체크아웃 API 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/checkout | POST | 체크아웃 발급 | |
| /v1/checkout/{sessionId} | GET | 체크아웃 상태조회 | |
| /v1/checkout/{sessionId}/expire | POST | 체크아웃 만료 | |
| /v1/payments/checkout/{sessionId} | GET | 체크아웃 거래조회 | |
| /v1/payments/checkout/{sessionId}/cancel | POST | 체크아웃 거래취소 |
웹훅 URL API 서비스
| URI | HttpMethod | 설명 | 상세 |
|---|---|---|---|
| /v1/webhook | POST | 웹훅 등록 | |
| /v1/webhook | GET | 웹훅 조회 | |
| /v1/webhook/{method}/update | POST | 웹훅 수정 | |
| /v1/webhook/{method}/delete | POST | 웹훅 삭제 |