Recurring Billing Transaction History API
Retrieve recurring billing transaction history.
Recurring Billing Transaction History
Retrieve transaction history for recurring billing over a specified date range.
API Information
POST/v1/api/regular/translist
Content-Type
application/json; charset=UTF-8테스트
https://tbnpay.settlebank.co.kr/v1/api/regular/translist운영
https://npay.settlebank.co.kr/v1/api/regular/translistRequest Parameters
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└hdInfoAN(50)Alphanumeric, up to 50 bytes*Message information code.
Message information code.
*Fixed value
└mchtIdAN(8)Alphanumeric, up to 8 bytes*Merchant ID.
Merchant ID.
└mchtCustIdAN(100)Alphanumeric, up to 100 bytes*
AES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)Customer ID.Customer ID.
└reqDtAN(8)Alphanumeric, up to 8 bytes*Request date (yyyyMMdd).
Request date (yyyyMMdd).
└reqTmAN(6)Alphanumeric, up to 6 bytes*Request time (HH24MISS).
Request time (HH24MISS).
└rglChrgKeyAN(32)Alphanumeric, up to 32 bytes*Unique recurring billing key.
Unique recurring billing key.
└useStDtAN(8)Alphanumeric, up to 8 bytes*Query start date (yyyyMMdd).
Query start date (yyyyMMdd).
*Maximum query period is 1 year (365 days)
└useEdDtAN(8)Alphanumeric, up to 8 bytes*Query end date (yyyyMMdd).
Query end date (yyyyMMdd).
└pktHashAN(200)Alphanumeric, up to 200 bytes*
SHA-256SHA-256 HMAC signature.(실시간 생성)SHA-256 HMAC signature.
NOTE
Signature composition
mchtId + mchtCustId + reqDt + reqTm + rglChrgKey + hashKey
Response Parameters
└outStatCdAN(4)Alphanumeric, up to 4 bytes*Transaction status code.
0021Transaction status code.
0021: Success 0031: Failure└outRsltCdAN(4)Alphanumeric, up to 4 bytes*Decline code.
0000Decline code.
*ST08: If the account is already enrolled, existing account information is returned
└outRsltMsgAN(300)Alphanumeric, up to 300 bytes*Result message.
Processed successfully.Result message.
└dataCntN(4)Numeric, up to 4 bytes*Number of transactions found.
10Number of transactions found.
└trRecordsObject List*Transaction history list.
[{"recordTrdDt":"20210830080000", "recordTrdAmt":"50000"}]Transaction history list.
trRecords Fields
└recordTrdDtAN(14)Alphanumeric, up to 14 bytesTransaction datetime (yyyyMMddhhmmss).
20210830080000Transaction datetime (yyyyMMddhhmmss).
└recordBankCdAN(3)Alphanumeric, up to 3 bytesBank code.
011Bank code.
└recordBankNmAN(45)Alphanumeric, up to 45 bytesBank name (Korean: 3 bytes per character).
국민은행Bank name (Korean: 3 bytes per character).
└recordCustAcntNoAN(15)Alphanumeric, up to 15 bytesAccount number (masked).
1234***********6546Account number (masked).
└recordRglChrgKeyAN(32)Alphanumeric, up to 32 bytesUnique recurring billing key.
Unique recurring billing key.
└recordTrdNoAN(50)Alphanumeric, up to 50 bytesTransaction reference number.
STFP_FIRM1234576789890Transaction reference number.
└recordMchtTrdNoAN(100)Alphanumeric, up to 100 bytesMerchant order number (no Korean characters).
OID2021083021343Merchant order number (no Korean characters).
*No Korean characters
└recordTrdAmtN(13)Numeric, up to 13 bytesTransaction amount.
50000Transaction amount.
└recordUseOrdN(13)Numeric, up to 13 bytesBilling cycle number.
1Billing cycle number.
└recordOutStatCdAN(4)Alphanumeric, up to 4 bytesTransaction status code.
0021Transaction status code.
0021: Success 0031: Failure└recordOutRsltCdAN(4)Alphanumeric, up to 4 bytesTransaction result code.
0000Transaction result code.
└recordOutRsltMsgAN(200)Alphanumeric, up to 200 bytesTransaction result message.
SuccessTransaction result message.
Need technical support?
Code Samples
HectoFinancial GitHub