API Documentation
All API
Service
Checking Refund ResultSync
Version: v1
Version: v1
/api/v1/refund/list
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
refundInfo
array of objects
Required
Refund list
refundInfo_item
object
Optional
serviceId
string
Required
Length : 15
Card product ID
- Unique ID assigned to a card product
serviceName
string
Required
Min : 1 , Max : 255
Card product name
serviceImageUrl
string
Required
Min : 1 , Max : 255
Image file URL of a card product
requestedDateTime
string
Required
Length : 17
Refund request date and time
- Format : yyyyMMddHHmmssSSS
settleDate
string
Required
Length : 8
Expected date of deposit of refund into account
- Format : yyyyMMdd
refundStatus
string
Required
Min : 4 , Max : 6
Refund status
- WAIT : Refund in progress
- SUCCESS : Refund completed
refundBalance
number
Required
Min : 0 , Max : 1000000000
Refund request amout
Balance on a card requested for refund
refundFee
number
Required
Min : 0 , Max : 1000000000
Amount of refund fee
settleAmount
number
Required
Min : 0 , Max : 1000000000
Final refund amount
refundType
string
Required
Min : 0 , Max : 10
Refund type
- BANK_ACC : Refund transfer
pageResponse
object
Required
Paging response information
page
number
Required
Min : 0 , Max : 1000
Paging index
- Default = 0
totalPages
number
Required
Min : 0 , Max : 1000
Total number of pages
numberOfElements
number
Required
Min : 0 , Max : 10000
Total number of lists
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.
Description
Invalid input parameter
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!