이해하기

클라이언트 SDK를 통해서 결제를 끝까지 완료할 수 있지만, 서비스를 안정적으로 운영하려면 서버사이드 SDK를 연동해야 해요. 유효성 검사, 결제 승인, 취소, 예약, 구독 같은 기능은 서버사이드에서 처리해야 더 안전하고 정확하니까요.

서버 SDK 기능 목록

서버사이드 SDK에서 제공하는 주요 기능 목록은 아래와 같아요.

토큰 발급받기

부트페이 API를 사용하기 위해 필요한 토큰을 발급받습니다. 이 토큰은 모든 API 호출에 사용됩니다.

결제 조회하기

결제 정보 조회는 정상적인 결제 건인지와 위변조 여부를 검증하기 위해 수행됩니다.

결제 승인하기

클라이언트에서 진행중인 결제를 서버에서 승인할 수 있습니다. 분리 승인 옵션 사용시에만 가능하며, 서버에서 유효성 검사 후 승인을 요청할 수 있기 때문에 엄밀한 단일 트랜잭션이 가능합니다. 재고관리 및 유효성 검사가 중요할 때 사용하길 추천합니다.

결제 취소하기

결제 취소는 결제 완료 후, 고객이 환불을 요청한 경우 사용됩니다.

자동결제하기

자동결제는 '빌링 결제', '정기 결제'라고도 불리며, 고객이 미리 결제 수단을 등록 후 결제시점에 등록된 결제 수단으로 간편하게 결제할 수 있는 방법입니다. 등록된 결제 수단으로 서버사이드에서 요청되기 때문에 간편하게 결제를 이용할 수 있다는 장점이 있습니다.  자동결제 시 다음 기능들이 다뤄집니다.

  • 빌링키 발급받기구매자가 카드 또는 계좌 정보를 등록할 때, 해당 정보를 직접 저장하지 않고 '빌링키'라는 대체 키를 발급받습니다.
  • 빌링키 조회받기구매자가 등록한 카드나 계좌 정보에 대한 빌링키를 조회합니다.
  • 빌링키 삭제하기더 이상 사용하지 않는 빌링키를 삭제합니다.
  • 결제 요청하기발급받은 빌링키로 결제를 요청합니다.
  • 결제 예약하기발급받은 빌링키로 결제를 예약합니다. 예약된 시간에 실행되어 웹훅으로 결과가 전달됩니다.
  • 예약 취소하기예약된 결제를 취소합니다.
  • 예약 조회하기예약된 결제를 조회합니다.

API 공통 응답처리

부트페이는 REST API의 성공 또는 실패 응답을 HTTP 상태 코드로 반환합니다. 일반적으로 2XX 상태 코드는 성공을 의미하며, 5XX 상태 코드는 PG와의 통신 오류나 부트페이 서버 내부 오류를 나타냅니다.

200
OK
요청이 성공적으로 처리되었음을 나타냅니다.
201
Created
요청이 성공적으로 처리되었으며, 새로운 리소스가 생성되었음을 나타냅니다.
202
Accepted
요청은 처리가 되었지만 지연 발생이 예상되는 경우에 반환됩니다.
400
Bad Request
필수 파라미터가 누락되었거나, 파라미터 값이 잘못된 경우에 발생합니다.
401
Unauthorized
인증이 필요한 API에 대해 인증되지 않은 요청이 발생했을 때 발생합니다.
404
Not Found
요청한 리소스가 존재하지 않음을 나타냅니다.
500
Internal Server Error
부트페이 서버 내에서 오류가 발생했거나, PG사와의 통신 중 오류가 발생한 경우에 반환됩니다.