헥토파이낸셜 개발자센터

Option Balance Inquiry API

Balance inquiry API for merchants using auto top-up. If the custAutoChrgYn field in the response is Y, the customer has enabled auto top-up for insufficient balance and has completed bank account registration, meaning the Spend API will accept requests even when the transaction amount exceeds the current balance (the shortfall is automatically topped up before processing).

API Information

POST/v1/wallet/option/balance
Content-Typeapplication/json;charset=UTF-8
테스트https://tb-mps-api.hectofinancial.co.kr/v1/wallet/option/balance
운영https://mps-api.hectofinancial.co.kr/v1/wallet/option/balance

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.
└ciAN(255)Alphanumeric, up to 255 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Member CI value.
*Customer's unique CI value.

Response Parameters

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

rsltObj (Response Object)

└custNoAN(20)Alphanumeric, up to 20 bytes*20240000
Prepaid member number.
*Unique prepaid member number assigned by Hecto Financial.
└custDivCdAN(1)Alphanumeric, up to 1 bytes*0
Customer division code.
0: Anonymous 1: Named
└chrgblAmtN(7)Numeric, up to 7 bytes*500000
Available top-up amount.
*Maximum additional Money that can be topped up at the time of inquiry.
└mnyBlcN(7)Numeric, up to 7 bytes*1500000
Money balance.
└pntBlcN(7)Numeric, up to 7 bytes*1000
Points balance.
└waitMnyBlcN(7)Numeric, up to 7 bytes*0
Pending Money balance.
└expMnyBlcN(7)Numeric, up to 7 bytes*0
Money expiring within 2 months.
*Money validity period is 10 years.
└custAutoChrgYnAN(1)Alphanumeric, up to 1 bytes*Y
Customer auto top-up flag.
*Y if the customer has auto top-up enabled with automatic top-up for insufficient balance.
When 'Y', the Spend API will accept requests even when the customer's balance is less than the transaction amount, automatically topping up the shortfall before processing.

Request Example

{
  "custNo": "2400001605",
  "ci": "AES-encrypted CI value"
}

Response Examples

Success

{
  "rsltCd": "0000",
  "rsltMsg": "Success",
  "rsltObj": {
    "custNo": "2400001605",
    "custDivCd": "0",
    "chrgblAmt": "500000",
    "mnyBlc": "1500000",
    "pntBlc": "1000",
    "waitMnyBlc": "0",
    "expMnyBlc": "0",
    "custAutoChrgYn": "Y"
  }
}

Failure (Merchant Not Using Auto Top-up)

{
  "rsltCd": "M-007",
  "rsltMsg": "This merchant does not use auto top-up. This API is not available."
}
💬

Need technical support?