Cash Receipt Issuance Error List Inquiry API
Query NTS issuance error records. Available after 13:00 on D+1 from the registration request date.
Important Notes
Domain Notice
This API uses domain2 (tb-nspay / nspay).
NOTE
Error List Inquiry
Error records can be queried starting the day after the registration request date, with availability after 13:00.
If result receipt is delayed due to NTS processing, query result availability is also delayed, and error code 2001 is returned while the records cannot be queried.
This API cannot query error records for reprocessed transactions. For reprocessed transactions, use the Cash Receipt Reprocessing Result List Inquiry API.
TSN Is a Successfully Issued Transaction
A transaction with error code TSN was successfully issued to the NTS as standard income deduction because its transaction type was changed to standard income deduction due to the merchant not being registered as a cultural expense business.
Do not reprocess it as a failed transaction; check the detailed reason in the NTS error code guide.
API Information
GET/POST/pgtrans/CashReceiptMultiAction.do?_method=getReceiptErrList
Content-Type
요청
application/x-www-form-urlencoded;charset=UTF-8응답
text/plain;charset=UTF-8테스트
https://tb-nspay.settlebank.co.kr/pgtrans/CashReceiptMultiAction.do?_method=getReceiptErrList운영
https://nspay.settlebank.co.kr/pgtrans/CashReceiptMultiAction.do?_method=getReceiptErrListRequest Parameters
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└midAN(10)Alphanumeric, up to 10 bytes*Merchant ID.
Merchant ID.
*Merchant ID issued by Hecto Financial
└trDtGbA(1)Alphabetic, up to 1 bytes*Transaction date query type.
Transaction date query type.
1: Based on trDt from the registration request (or API request date for voids) 2: Based on NTS submission date*1: For registrations, query based on the requested trDt; for voids, query based on the void API request date
2: Query based on the NTS submission date
The NTS submission date is the day after the API request date and may vary depending on NTS processing
2: Query based on the NTS submission date
The NTS submission date is the day after the API request date and may vary depending on NTS processing
└trDt1N(8)Numeric, up to 8 bytes*Query start date (yyyyMMdd).
Query start date (yyyyMMdd).
*Enter the start date of the query period in yyyyMMdd format
└trDt2N(8)Numeric, up to 8 bytesQuery end date (yyyyMMdd).
Query end date (yyyyMMdd).
*Enter the end date in yyyyMMdd format for a range query
The query period is up to 7 days
To query only a single day of data, request with an empty value; the query is based on the trDt1 date
The query period is up to 7 days
To query only a single day of data, request with an empty value; the query is based on the trDt1 date
└ordNoAN(40)Alphanumeric, up to 40 bytesOrder number.
Order number.
*To query a specific transaction only, enter the transNo value from the register/void API request
└authNoAN(9)Alphanumeric, up to 9 bytesApproval number.
Approval number.
*To query a specific transaction only, enter the authNo value from the register/void API response
Response Parameters
Response data is in CSV format.
| No | Field | Description |
|---|---|---|
| 1 | Transaction datetime | Value of trTime from the register/void API response |
| 2 | Order number | Value of transNo from the register/void API request |
| 3 | Register/void type | 0: Approval, 1: Void |
| 4 | Approval number | Cash receipt approval number |
| 5 | Error code | NTS Registration Result Error Codes |
Request Example
https://tb-nspay.settlebank.co.kr/pgtrans/CashReceiptMultiAction.do?_method=getReceiptErrList
&mid=mid_test
&trDtGb=1
&trDt1=20180301
Response Example
Error
When a query error occurs, only the error code is returned without any other fields. The 2001 in the example below means the NTS result has not yet been received, so you should query again after a while.
2001
Success
20171207001336,test1234,0,F61839890,BLO
20171207003238,test1235,0,F61840946,BLO
20171207004750,test1236,0,F61841883,BLO
20171207011728,test1237,0,F61843540,TS2
20171207025839,test1238,0,F61847416,BLO
Query Result Error Codes
| Code | Description |
|---|---|
| 1000 | Merchant ID error |
| 1001 | Merchant information not found |
| 1003 | Transaction date error |
| 2000 | No error records |
| 2001 | NTS result not yet received; please try again later |
| 9999 | System error |
NTS Registration Result Error Codes
NTS error codes that may appear in the query results.
For the cause of each error, whether auto-reprocessing is possible, and how to handle it, refer to the NTS Registration Result Error Codes page.
Need technical support?
Code Samples
HectoFinancial GitHub