포인트 회수 API
회원에게 지급된 포인트를 회수하는 API입니다.
API 정보
POST/v1/point/revoke
Content-Type
application/json테스트
https://tb-mps-api.hectofinancial.co.kr/v1/point/revoke운영
https://mps-api.hectofinancial.co.kr/v1/point/revoke요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└custNoAN(20)영문+숫자, 최대 20byte*선불 회원번호
선불 회원번호
*헥토파이낸셜에서 부여하는 고유 선불 회원 번호
└mTrdNoAN(50)영문+숫자, 최대 50byte*상점 거래번호
상점 거래번호
*상점에서 생성하는 거래번호 (한글 제외)
└trdAmtN(7)숫자, 최대 7byte*
AES-256AES-256/ECB/PKCS5Padding + Base64회수 요청 금액회수 요청 금액
*AES-256/ECB/PKCS5Padding 암호화 필요
└pntBlcN(7)숫자, 최대 7byte*
AES-256AES-256/ECB/PKCS5Padding + Base64포인트 잔액포인트 잔액
*선불 회원의 포인트 잔액. AES-256/ECB/PKCS5Padding 암호화 필요
└reqDtAN(8)영문+숫자, 최대 8byte요청 일자
요청 일자
*yyyyMMdd. 입력 안 할 시 서버 일자로 자동 입력
└reqTmAN(6)영문+숫자, 최대 6byte요청 시각
요청 시각
*HHmmss. 입력 안 할 시 서버 시간으로 자동 입력
└trdSumryAN(50)영문+숫자, 최대 50byte거래 적요
거래 적요
*포인트 회수 사유
└mResrvField1AN(255)영문+숫자, 최대 255byte상점 여유필드 1
상점 여유필드 1
*평문으로 송수신되므로 개인정보와 같은 민감정보 포함되지 않도록 주의
└mResrvField2AN(255)영문+숫자, 최대 255byte상점 여유필드 2
상점 여유필드 2
*평문으로 송수신되므로 개인정보와 같은 민감정보 포함되지 않도록 주의
└mResrvField3AN(255)영문+숫자, 최대 255byte상점 여유필드 3
상점 여유필드 3
*평문으로 송수신되므로 개인정보와 같은 민감정보 포함되지 않도록 주의
└pktHashAN(200)영문+숫자, 최대 200byte*
SHA-256SHA-256 해시값(실시간 생성)SHA-256 해시값
*선불회원번호 + 상점아이디 + 상점거래번호 + 거래금액(평문) + 해시키
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└rsltCdAN(4)영문+숫자, 최대 4byte*응답코드
0000응답코드
0000: 성공 그 외: 실패└rsltMsgAN(255)영문+숫자, 최대 255byte*응답 메시지
성공응답 메시지
rsltObj (응답 객체)
└custNoAN(20)영문+숫자, 최대 20byte*선불 회원번호
2400001605선불 회원번호
└mtrdNoAN(50)영문+숫자, 최대 50byte*상점 거래번호
ORDER20240716상점 거래번호
*한글 제외
└trdNoAN(50)영문+숫자, 최대 50byte*거래 승인번호
24071616270200002193거래 승인번호
*헥토파이낸셜에서 부여하는 고유 거래번호
└trdDtAN(8)영문+숫자, 최대 8byte*거래 일자
20240716거래 일자
*yyyyMMdd
└trdTmAN(6)영문+숫자, 최대 6byte*거래 시각
164101거래 시각
*HHmmss
└trdAmtN(7)숫자, 최대 7byte*거래 금액
10000거래 금액
*포인트 회수 금액
└pntBlcN(7)숫자, 최대 7byte*포인트 잔액
0포인트 잔액
*회수 후 포인트 잔액
└pktHashAN(200)영문+숫자, 최대 200byte*SHA-256 해시값
SHA-256 해시값
*선불회원번호 + 상점아이디 + 상점거래번호 + 헥토파이낸셜 거래승인번호 + 거래금액 + 해시키
요청 예시
{
"custNo": "2400001605",
"mTrdNo": "ORDER20240716",
"trdAmt": "AES암호화된금액",
"pntBlc": "AES암호화된잔액",
"reqDt": "20240716",
"reqTm": "132300",
"trdSumry": "이벤트 포인트 회수",
"pktHash": "해시값"
}
응답 예시
성공
{
"rsltCd": "0000",
"rsltMsg": "성공",
"rsltObj": {
"custNo": "2400001605",
"mtrdNo": "ORDER20240716",
"trdNo": "24071616270200002193",
"trdDt": "20240716",
"trdTm": "164101",
"trdAmt": "10000",
"pntBlc": "0",
"pktHash": "f395b6725a9a18f2563ce34f8bc76698051d27c05de5ba815f463f00429061c"
}
}
실패
{
"rsltCd": "T-054",
"rsltMsg": "보유한 포인트보다 많은 금액을 회수 할 수 없습니다. "
}
주의사항
- 회수 요청 금액은 회원의 포인트 잔액보다 클 수 없습니다.
- 거래번호(
mTrdNo)는 중복될 수 없습니다. - 포인트 회수는 지급된 포인트에 대해서만 가능합니다.
