Billing Account API - Verify Payment PIN #
1. API Overview #
Purpose #
This API verifies the authentication PIN used for card-based payments.
It checks whether the user-provided PIN matches the previously registered authentication data to enhance the security of transactions.
The API operates without handling sensitive card information directly and leverages registered payment method data and authentication factors to ensure a secure payment process.
Details #
| Item | Value |
|---|---|
| API Name | Verify Payment PIN |
| API Path | /api/v2/payment-methods/pin/verification |
| API ID | EBP_API_126 |
| HTTP Method | POST |
| Region | Global |
2. Request Specification #
2.1 Request Header #
For detailed header information, please refer to the Common Headers documentation.
2.2 Request Data Schema #
| Field | Details & Description |
|---|---|
| userNo |
🔴 Required Internal user number for tracking purposes |
| paymentMethodId |
🔴 Required Unique identifier for the payment method |
| paymentPin |
🔴 Required PIN to register for payment method |
2.3 Request Examples #
JSON Example #
{
"userNo": "KR1234567890",
"paymentMethodId": "b79c2955f3a7462f86885c2d7fae04b5",
"paymentPin": "1234"
}
3. Response Specification #
3.1 Response Data Schema #
Response Data Schema #
| depth | Field | Details & Description |
|---|---|---|
| -1 | resultCode |
🔴 Required Result code e.g., "0" for success, "EBP-A-0001" for error |
| -1 | message |
🔴 Required Result message |
| -1 | requestId |
🔴 Required Unique request identifier for tracking |
| -1 | timestamp |
🔴 Required Response timestamp in ISO 8601 format e.g., 2025-12-19T14:24:00+09:00 |
| -1 | data |
🔴 Required Response data |
| 0 | requestId |
🔴 Required RequestId issued after successful authentication. Use as authRequestId in the payment request. |
| 0 | signature |
🔴 Required Signed value of the authentication RequestId (valid for 5 minutes). Use as authSignature in the payment request. |
| 0 | pinErrorCount |
🔴 Required Number of incorrect PIN attempts |
| 0 | pinErrorLimit |
🔴 Required Maximum allowed incorrect PIN attempts |
3.2 Response Samples #
Success Response #
{
"resultCode": "0",
"message": "SUCCESS",
"requestId": "1767081244065",
"timestamp": "2025-12-30T07:54:04.067215800Z",
"data": {
"requestId": "20260202070836883_06E1TBMGJCX7KRNQBGEDDRW30R",
"signature": "LFrk03gQUuxWxS0YM3Hbzu9iP24PTKkkPuCa97MbFf0=",
"pinErrorCount": 0,
"pinErrorLimit": 0
}
}