API 문서
전체 API
서비스
카드 잔액 이관동기
버전: v1
버전: v1
/api/v1/transfer/balance
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
amount
number
필수
값 : 0
이관된 잔액
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
400
에러 코드
000_003
메시지
Missing required values. toCardNo
설명
입력 파라미터 오류 - `toCardNo` 입력 요청 정보가 null 인 경우
400
에러 코드
005_017
메시지
Possible collection balance is zero.
설명
이관되는 카드 잔액이 0일 경우
400
에러 코드
005_018
메시지
There is not enough balance to transfer.
설명
이관 요청하는 금액이 카드 잔액 보다 많을 경우
400
에러 코드
017_001
메시지
Balance is over the max.
설명
이관 받는 카드의 잔액 한도 초과일 경우
400
에러 코드
017_002
메시지
Failed to balance transfer.
설명
잔액 이관 실패
400
에러 코드
017_003
메시지
Value transfer between same card.
설명
같은 카드 간에 잔액 이관을 요청할 경우
400
에러 코드
017_004
메시지
Input affiliateId is not same as owner affiliateId.
설명
입력받은 affiliateId와 owner affiliateId가 다를 경우
400
에러 코드
017_005
메시지
Product is not allowed collection.
설명
잔액 합치기 기능이 지원하지 않는 상품으로 요청할 경우
400
에러 코드
017_006
메시지
Owner affiliate not found.
설명
해당 상품의 owner affiliateId가 존재하지 않을 경우
전체 보기
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.