Billing Account API - Get Payment Methods #

1. API Overview #

Purpose #

This API retrieves a list of all payment methods registered by a specific user (userNo) and their current status.
It is primarily used in 'Manage Payment Methods' screens or to load saved cards during the payment process.
By providing masked card numbers, issuer information, and payment method block status, it helps users identify and select valid payment methods for secure transactions.

Details #

Item	Value
API Name	Get Payment Methods
API Path	/api/v2/payment-methods/query
API ID	EBP_API_109
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

Field	Details & Description
userNo	`string` 🔴 Required Unique identifier for the user

string

🔴 Required

Unique identifier for the user

2.3 Request Examples #

JSON Example #

{
  "userNo": "dba6e05d13b7557e9efa4d414145cbfc"
}

3. Response Specification #

3.1 Response Data Schema #

Response Data Schema #

depth	Field	Details & Description
-1	resultCode	`string` 🔴 Required Result code e.g., "0" for success, "EBP-A-0001" for error
-1	message	`string` 🔴 Required Result message
-1	requestId	`string` 🔴 Required Unique request identifier for tracking
-1	timestamp	`string` 🔴 Required Response timestamp in ISO 8601 format e.g., 2025-12-19T14:24:00+09:00
-1	data	`array` 🔴 Required List of payment method objects
0	userNo	`string` 🔴 Required Unique identifier for the user
0	billingAccountNo	`string` 🔴 Required Billing account number
0	paymentMethod	`string` 🔴 Required Payment method code
0	paymentMethodId	`string= 16` 🔴 Required Payment Method identifier (for server internal/external tracking)
0	cardNumber	`string` 🔴 Required Masked card number (Original PAN not included. Recommended: First 6 / Last 4)
0	cardIssuer	`string` 🔴 Required Card issuer or brand name e.g., Visa, Mastercard
0	isBlocked	`boolean` 🔴 Required Block status (true if blocked)
0	pinErrorCount	`number` ⚪ Optional Number of PIN entry errors (minimum 0)
0	isPinRegistered	`boolean` ⚪ Optional Indicates if a PIN is registered
0	pgProvider	`string` 🔴 Required Payment Gateway (PG) code e.g., WORLDPAY, OMISE
0	pgChannel	`string` 🔴 Required PG Channel code e.g., WP_CARD, OMISE_CARD

3.2 Response Samples #

Success Response #

{
  "resultCode": "0",
  "message": "SUCCESS",
  "requestId": "01EFX0CUI7JK0KCSSTFEEDRDVA",
  "timestamp": "2025-12-30T06:21:55.556809100Z",
  "data": [
    {
      "userNo": "AU1741850000100",
      "billingAccountNo": "K202603170624637",
      "paymentMethod": "CARD",
      "paymentMethodId": "b79c2955f3a7462f86885c2d7fae04b5",
      "cardNumber": "************0023",
      "cardIssuer": "Visa",
      "isBlocked": false,
      "pinErrorCount": 0,
      "isPinRegistered": true,
      "pgProvider": "WORLDPAY",
      "pgChannel": "WP_CARD"
    }
  ]
}