⌨️포인트 단건조회 API

베네피아 포인트를 단건 조회 합니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

API를 통해 베네피아 포인트(복지포인트)단건 조회

베네피아 포인트(복지포인트)단건 조회

POST https://api.iamport.kr/benepia/point

사용자로부터 베네피아 계정 아이디, 비밀번호를 전달받아 보유중인 베네피아 포인트를 조회할 수 있습니다. KCP를 통해서만 진행되므로 KCP사이트코드 발급이 필요합니다.

Request Body

Name	Type	Description
benepia_user*	String	베네피아 계정 아이디
benepia_password*	String	베네피아 계정 비밀번호
pg	String	PG구분코드 KCP PG설정이 2개 이상인 경우 조회가 진행되길 원하는 KCP사이트코드를 지정하실 수 있습니다. pg 파라미터는 kcp.{KCP사이트코드} 형식의 문자열입니다. pg 파라미터가 누락되는 경우 PG설정 내 KCP설정을 자동 탐색하여 처리하게 됩니다.

200: OK 성공

BenepiaPointResponse

code * integer

응답코드

0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다

message * string

응답메세지

code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response (BenepiaPointAnnotation, optional)

BenepiaPointAnnotation

point * integer

베네피아 보유 포인트

401: Unauthorized 인증 Token이 전달되지 않았거나 유효하지 않은 경우

{
    // Response
}

500: Internal Server Error 베네피아 포인트 조회 실패

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "point": 0
  }
}

Swagger Test Link

https://api.iamport.kr/#!/benepia/queryBenepiaPoint