헥토파이낸셜 개발자센터

Points Revocation API

Revokes Points that were issued to a member.

API Information

POST/v1/point/revoke
Content-Typeapplication/json
테스트https://tb-mps-api.hectofinancial.co.kr/v1/point/revoke
운영https://mps-api.hectofinancial.co.kr/v1/point/revoke

Request Parameters

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
└custNoAN(20)Alphanumeric, up to 20 bytes*
Prepaid member number.
*Unique prepaid member number assigned by Hecto Financial.
└mTrdNoAN(50)Alphanumeric, up to 50 bytes*
Merchant transaction reference number.
*Transaction reference number generated by the merchant (no Korean characters).
└trdAmtN(7)Numeric, up to 7 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Requested revocation amount.
*AES-256/ECB/PKCS5Padding encryption required.
└pntBlcN(7)Numeric, up to 7 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Points balance.
*Member's Points balance. AES-256/ECB/PKCS5Padding encryption required.
└reqDtAN(8)Alphanumeric, up to 8 bytes
Request date.
*yyyyMMdd format. If omitted, the server date is used automatically.
└reqTmAN(6)Alphanumeric, up to 6 bytes
Request time.
*HHmmss format. If omitted, the server time is used automatically.
└trdSumryAN(50)Alphanumeric, up to 50 bytes
Transaction summary.
*Reason for the Points revocation.
└mResrvField1AN(255)Alphanumeric, up to 255 bytes
Merchant reserve field 1.
*Transmitted in plaintext. Do not include sensitive personal information.
└mResrvField2AN(255)Alphanumeric, up to 255 bytes
Merchant reserve field 2.
*Transmitted in plaintext. Do not include sensitive personal information.
└mResrvField3AN(255)Alphanumeric, up to 255 bytes
Merchant reserve field 3.
*Transmitted in plaintext. Do not include sensitive personal information.
└pktHashAN(200)Alphanumeric, up to 200 bytes*SHA-256(실시간 생성)
SHA-256 hash value.
*Signature composition: prepaid member number + merchant ID + merchant transaction reference number + transaction amount (plaintext) + hash key.

Response Parameters

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
└rsltCdAN(4)Alphanumeric, up to 4 bytes*0000
Result code.
0000: Success Other: Failure
└rsltMsgAN(255)Alphanumeric, up to 255 bytes*Success
Result message.

rsltObj (Response Object)

└custNoAN(20)Alphanumeric, up to 20 bytes*2400001605
Prepaid member number.
└mtrdNoAN(50)Alphanumeric, up to 50 bytes*ORDER20240716
Merchant transaction reference number.
*No Korean characters.
└trdNoAN(50)Alphanumeric, up to 50 bytes*24071616270200002193
Transaction approval number.
*Unique transaction number assigned by Hecto Financial.
└trdDtAN(8)Alphanumeric, up to 8 bytes*20240716
Transaction date.
*yyyyMMdd format.
└trdTmAN(6)Alphanumeric, up to 6 bytes*164101
Transaction time.
*HHmmss format.
└trdAmtN(7)Numeric, up to 7 bytes*10000
Transaction amount.
*Points revocation amount.
└pntBlcN(7)Numeric, up to 7 bytes*0
Points balance.
*Points balance after revocation.
└pktHashAN(200)Alphanumeric, up to 200 bytes*
SHA-256 hash value.
*Signature composition: prepaid member number + merchant ID + merchant transaction reference number + Hecto Financial transaction approval number + transaction amount + hash key.

Request Example

{
  "custNo": "2400001605",
  "mTrdNo": "ORDER20240716",
  "trdAmt": "AES-encrypted amount",
  "pntBlc": "AES-encrypted balance",
  "reqDt": "20240716",
  "reqTm": "132300",
  "trdSumry": "Event points revocation",
  "pktHash": "hash value"
}

Response Examples

Success

{
  "rsltCd": "0000",
  "rsltMsg": "Success",
  "rsltObj": {
    "custNo": "2400001605",
    "mtrdNo": "ORDER20240716",
    "trdNo": "24071616270200002193",
    "trdDt": "20240716",
    "trdTm": "164101",
    "trdAmt": "10000",
    "pntBlc": "0",
    "pktHash": "f395b6725a9a18f2563ce34f8bc76698051d27c05de5ba815f463f00429061c"
  }
}

Failure

{
  "rsltCd": "T-054",
  "rsltMsg": "Cannot revoke an amount greater than the member's Points balance."
}

Important Notes

  • The revocation amount cannot exceed the member's Points balance.
  • The transaction reference number (mTrdNo) must be unique.
  • Points revocation is only applicable to issued Points.
💬

Need technical support?