API Documentation
All API
Service
Search for Refund FeeSync
Version: v1
Version: v1
/api/v1/refund/fee
Request Headers
Request Parameters
Response Headers
X-KM-Correlation-Id
string
Required
Length : 20
Transaction number for tracking trasncription
- Form : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7digit, Hex String
X-KM-Crypto-Key-Id
string
Optional
Length : 32
Data encryption/decryption key ID
- Given ID from creating the service provider's project
- If it is passed as a callback, the first key issued among the keys issued to the service provider is used.
Response Parameters
par
string
Required
Length : 27
Number that replaces PAN(Primary Account Number) of a card
refundFeeRate
number
Required
Min : 0 , Max : 99
Refund fee rate
Down to one decimal place is possible
balance
number
Required
Min : 0 , Max : 1000000000
Card balance
refundCheckBalance
number
Required
Min : 0 , Max : 1000000000
Balance including payment only
discountAmount
number
Required
Min : 0 , Max : 1000000000
Discounted amount
refundFee
number
Required
Min : 0 , Max : 1000000000
Refund fee amount
refundAmount
number
Required
Min : 0 , Max : 1000000000
Refund amount
expiredFee
number
Required
Min : 0 , Max : 1000000000
Expiration Fee
refundable
boolean
Required
Final refundability
refundThresholdBalance
number
Required
Min : 0 , Max : 1000000000
Maximum balance for refund
Refund can be made only when the balance is less than the amount. (e.g. If the balance is "1000", it is possible when the refund amount is less than 1,000 won.)
refundThresholdRatio
number
Required
Min : 0 , Max : 99
Ratio of maximum balance for refund
Refunds are only possible if a member uses this percentage or more as the ratio of the amount used to the final balance.
Down to one decimal place is possible.
currentBalanceRatio
number
Required
Min : 0 , Max : 99
Current balance usage compared to last charging
Down to one decimal place is possible
lastLoadedBalance
number
Required
Min : 0 , Max : 1000000000
Balance at last charge
lastLoadedDateTime
string
Required
Length : 17
Last charging date
- Format : yyyyMMddHHmmssSSS
refundPolicy
object
Required
Refund Policy Infomation
refundMonthlyCount
number
Required
Min : 0 , Max : 1000000000
Number of refunds per month
refundMonthlyLimitCount
number
Required
Min : 0 , Max : 1000000000
Limit number of refunds per month
refundMonthlyAmount
number
Required
Min : 0 , Max : 1000000000
Refund amount per month
refundMonthlyLimitAmount
number
Required
Min : 0 , Max : 1000000000
Refund limit per month
conditionOverPolicy
string
Required
Length : 1
Classification of processing in case of exceeding refund limit
- D : Not refundable
- C : Fee charged
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
Success
400
Error code
000_002
Message
Invalid input parameter. oneTimeToken
Description
Invalid input parameter
400
Error code
009_001
Message
Bank account is null.
Description
No information of member’s refund account
400
Error code
009_002
Message
Refund amount over limit in month.
Description
Exceeding monthly refund limit
400
Error code
009_003
Message
Refund count over limit in month.
Description
Exceeding the limit of number of refunds per month
400
Error code
009_004
Message
Refund denied.
Description
Refund transaction rejected
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!
