| Doc. No. | A12S1V1 | ||
|---|---|---|---|
| API Title | 포인트 > 포인트 잔액 조회 | ||
| API Description | 회원이 가진 유저 포인트 및 카드 포인트의 잔액을 확인하는 API 입니다. | ||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v1/point/info |
| Data Encryption | Request : YES / Response : NO | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| userId | NUMBER | 1~999999999999 | MANDATORY | 회원 ID - 회원가입 시 부여되는 회원의 고유 ID입니다. |
||
| pointType | STRING | 1~5 | CONDITIONAL | 조회할 포인트 타입 - USER : 유저 포인트 사용 - CARD : 카드 포인트 사용 - 기본값 : USER |
||
| policyId | STRING | 15 | CONDITIONAL | 조회할 포인트 정책 ID - 조건 필드 : "pointType"값이 "CARD"값일 경우 설정 |
||
| par | STRING | 27 | CONDITIONAL | 조회할 카드의 par - 조건 필드 : "pointType"값이 "CARD"값일 경우 설정 |
||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| pointAmount | NUMBER | 0~999999999999 | MANDATORY | 회원이 보유한 포인트 금액 | ||
| pointType | STRING | 1~5 | MANDATORY | 조회한 포인트 타입 | ||
| policyId | STRING | 15 | CONDITIONAL | 조회한 포인트 정책 ID - 조건 필드 : "pointType"값이 "CARD"값일 경우 설정 |
||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||
| 400 | 001_006 | Wallet user not found. | 회원을 찾을 수 없습니다. |