Account Ownership Verification Request API

Initiates a micro-deposit (1 KRW) transfer. The verification code type can be configured for the deposit.


Account Ownership Verification Request (2-Step, Step 1)

Initiates a micro-deposit (1 KRW) transfer. The verification code type can be configured for the deposit.

API Information

POST/v1/api/auth/ownership/req
Content-Typeapplication/json; charset=UTF-8
테스트https://tbnpay.settlebank.co.kr/v1/api/auth/ownership/req
운영https://npay.settlebank.co.kr/v1/api/auth/ownership/req

Request Parameters

hdInfoAN(50)Alphanumeric, up to 50 bytes*
Message type code. Fixed value.
*Fixed value
mchtIdAN(8)Alphanumeric, up to 8 bytes*
Merchant ID.
mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*
Merchant transaction number (no Korean characters).
mchtCustIdAN(100)Alphanumeric, up to 100 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)
Customer ID. AES-256 encrypted.
reqDtAN(8)Alphanumeric, up to 8 bytes*
Request date (yyyyMMdd).
reqTmAN(6)Alphanumeric, up to 6 bytes*
Request time (HH24MISS).
mchtCustNmAN(20)Alphanumeric, up to 20 bytesAES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)
Account holder name on the bankbook (Korean: 3 bytes per character). AES-256 encrypted.
bankCdAN(3)Alphanumeric, up to 3 bytes*
Bank code.
custAcntNoAN(15)Alphanumeric, up to 15 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)
Account number (no hyphens). AES-256 encrypted.
authTypeAN(1)Alphanumeric, up to 1 bytes*
Verification code type.
1: 3-digit numeric 2: Uppercase letter + 2-digit numeric 3: 4-character Korean word combination 4: 4-digit numeric
remitterNmAN(8)Alphanumeric, up to 8 bytesAES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)
Sender name displayed in the bank statement remark (Korean: 2 bytes per character). The verification code is prepended or appended to this name. AES-256 encrypted.
*Ignored when authType is '3' and the code is auto-generated. Maximum 3 characters when authType is '4'.
textPosAN(1)Alphanumeric, up to 1 bytes
Sender name position in the bank statement remark.
F: Prefix R: Suffix
authVldTmN(5)Numeric, up to 5 bytes
Verification validity period in seconds. Counted from the moment the successful verification request response is received.
*Validity period starts from the time the successful verification request response is received.
apintTmN(5)Numeric, up to 5 bytes
Duplicate request prevention period in seconds. Repeated requests within this window return an 'in progress' response without executing a new micro-deposit.
*Requests received within the specified period return an 'in progress' response without initiating a new 1 KRW transfer.
custIpAN(15)Alphanumeric, up to 15 bytes
Customer IP address.
pktHashAN(200)Alphanumeric, up to 200 bytes*SHA-256(실시간 생성)
SHA-256 HMAC signature.
NOTE

Signature Composition

mchtId + reqDt + reqTm + bankCd + custAcntNo + hashKey

Response Parameters

outStatCdAN(4)Alphanumeric, up to 4 bytes*0021
Transaction status code.
0021: Success 0031: Failure
outRsltCdAN(4)Alphanumeric, up to 4 bytes*0000
Decline code.
outRsltMsgAN(300)Alphanumeric, up to 300 bytes*Processed successfully.
Result message.
mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*OID201902210001
Merchant transaction number.
trdNoAN(40)Alphanumeric, up to 40 bytes*STFP_FIRM12345678901234567890
Transaction reference number.
mchtCustIdAN(100)Alphanumeric, up to 100 bytes*AES-256AES-256/ECB/PKCS5Paddingkimhecto
Customer ID. AES-256 encrypted.
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
bankChkYnAN(1)Alphanumeric, up to 1 bytes*N
Bank maintenance status.
Y: Under maintenance N: Normal
stDtmAN(14)Alphanumeric, up to 14 bytes20200729000900
Maintenance start datetime (yyyyMMddhhmmss).
edDtmAN(14)Alphanumeric, up to 14 bytes20200729001000
Maintenance end datetime (yyyyMMddhhmmss).

💬

Need technical support?