API 문서
전체 API
서비스
기준 하한 및 월정액 자동 충전 목록 조회동기
버전: v1
버전: v1
/api/v1/recharges/auto/plans
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
parInfoList
array of objects
필수
자동 충전 설정 목록
parInfoList_item
object
옵션
type
string
필수
최소 : 5 , 최대 : 8
자동 충전 타입
- INFINITE : 기준하한
- FIXED : 월정액
state
string
필수
최소 : 6 , 최대 : 8
활성화 상태
- ACTIVE : 활성화 상태
- INACTIVE : 일시정지 상태
par
string
필수
길이 : 27
카드의 PAN(Primary Account Number)을 대체하는 번호
registeredDate
string
필수
길이 : 14
등록 일시
- 형식 : yyyyMMddHHmmss
amount
number
필수
최소 : 1 , 최대 : 9
자동 충전 발생 시, 충전되는 금액
thresholdBalance
number
조건부
최소 : 1 , 최대 : 9
자동 충전이 발생하기 위한 카드의 잔액
- type이 INFINITE인 경우, 필수값
reloadDate
string
조건부
최소 : 1 , 최대 : 2
자동 충전 날짜
- type이 FIXED 인 경우, 필수값
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
200
에러 코드
000_000
메시지
Success.
설명
성공 테스트_자동충전활성화된 PAR가 없는 케이스
400
에러 코드
000_002
메시지
Invalid input parameter. userId
설명
입력 파라미터 오류.
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
