| Doc. No. | A7S11D2V2 | ||
|---|---|---|---|
| API Title | 결제 > 포인트 사용예약 | ||
| API Description | 포인트를 여러 건에 지정하여 예약합니다. | ||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v2/payment/point |
| Data Encryption | Request : YES / Response : YES | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| userId | NUMBER | 1~999999999999 | MANDATORY | 회원 ID - 회원가입 시 부여되는 회원의 고유 ID입니다. |
||
| agreementList | ARRAY | MANDATORY | 사용 예약 대상이 되는 포인트 목록 | |||
| └ policyId | STRING | 15 | MANDATORY | 사용할 포인트 정책 ID 보유카드 조회로 확인 할 수 있습니다. |
||
| └ pointAmount | NUMBER | 1~1000000000 | MANDATORY | 사용할 포인트 금액 | ||
| cardNo | STRING | 16 | CONDITIONAL | 포인트를 사용할 카드 번호 - 카드 포인트를 사용할 경우 필수 |
||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| remainTime | NUMBER | 0~3600000 | MANDATORY | 포인트 사용 예약 시 예약의 유효한 잔여시간 - 단위 : ms |
||
| reservationYn | STRING | 1 | OPTIONAL | 기존에 예약된 par 정보와 같은지 판단 여부 - Y : 조회 요청과 같은 par 또는 기존 예약 없음 - N : 다른 par로 요청 |
||
| reservationPar | STRING | 27 | OPTIONAL | 예약된 par | ||
| par | STRING | 27 | OPTIONAL | 조회요청 및 보유잔액 조회 한 par | ||
| agreementList | ARRAY | MANDATORY | 사용 예약 대상이 되는 포인트 목록 | |||
| └ policyId | STRING | 15 | OPTIONAL | 사용할 포인트 정책 ID | ||
| └ pointAmount | NUMBER | 1~1000000000 | OPTIONAL | 사용할 포인트 금액 | ||
| └ pointType | STRING | 1 | OPTIONAL | 사용할 포인트 타입 - USER : 유저 포인트 - CARD : 카드 포인트 |
||
| └ policyName | STRING | 1~255 | MANDATORY | 포인트 정책명 | ||
| holdingList | ARRAY | MANDATORY | 보유 포인트 목록 | |||
| └ policyId | STRING | 15 | OPTIONAL | 포인트 정책 ID | ||
| └ pointAmount | NUMBER | 1~1000000000 | OPTIONAL | 포인트 금액 | ||
| └ pointType | STRING | 4 | OPTIONAL | 포인트 타입 - USER : 유저 포인트 - CARD : 카드 포인트 |
||
| failedList | ARRAY | MANDATORY | 실패 목록 | |||
| └ policyId | STRING | 15 | OPTIONAL | 사용 예약 실패한 포인트 정책 ID | ||
| └ failedReason | STRING | 1~20 | OPTIONAL | 실패에 대한 대한 코드 - 56_2005_001 : 잔액이 부족함 - 56_2005_002 : 1회 사용한도를 초과 - 56_2005_003 : 1일 사용한도를 초과 - 56_2005_004 : 1달 사용한도를 초과 |
||
| └ maxAmount | NUMBER | 1~1000000000 | OPTIONAL | 해당 포인트의 사용 가능한 최대 금액 | ||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||