Billing Account API - Register Payment PIN #
1. API Overview #
Purpose #
This API registers the authentication PIN used for card-based payments.
The PIN provided by the user must be transmitted in an encrypted form, and EBP does not interfere with the encryption method.
The purpose is to enhance security by combining registered card data with a PIN without exposing sensitive card information.
Note: Changing the payment PIN is not supported. If you lose your PIN, you must delete the existing payment method and re-register.
Details #
| Item | Value |
|---|---|
| API Name | Register Payment PIN |
| API Path | /api/v2/payment-methods/pin/registration |
| API ID | EBP_API_131 |
| HTTP Method | POST |
| Region | Global |
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 token-based payment |
2.3 Request Examples #
JSON Example #
{
"userNo": "T0a8w9h7t5h3v5w6w4v6v4d1d4c1",
"paymentMethodId": "202512110245491",
"paymentPin": "44a019096dabfb5c660df1252609528795400f653ba"
}
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 |
null |
| 0 | paymentMethodId |
🔴 Required Token identifier (for server internal/external tracking) |
3.2 Response Samples #
Success Response #
{
"resultCode": "0",
"message": "SUCCESS",
"requestId": "06EFX0CRR7JK0KCSSTFEEDRDVG",
"timestamp": "2025-12-30T07:33:13.824093100Z",
"data": {
"paymentMethodId": "b79c2955f3a7462f86885c2d7fae04b5"
}
}