Cancel scheduled payment API
Cancels a scheduled payment before execution.
POST https://api.iamport.kr/subscribe/payments/unschedule Cancels a scheduled payment before execution.
Cancels a scheduled payment before execution.
Parameters
Body
Billing key
Order ID
If omitted, cancels all scheduled payments associated with customer_uid.
Responses
200: OK Success
code
*** **integer
Response code
0: success, Not 0: check the message
message
*** **string
Response message
A non-zero code includes a message like โInvalid payment infoโ.
response
(Array[ScheduleResultAnnotation], optional
code
* integer
Response code
0: success, Not 0: check the message
message
*** **string
Response message
A non-zero code includes a message like โInvalid payment infoโ.
customer_uid
* string
Billing key
**merchant_uid
* **string
Order ID
imp_uid
* string
iโmport transaction UID
schedule_at
* UNIX timestamp
Payment scheduled at
executed_at
* UNIX timestamp
Payment started at
revoked_at
* UNIX timestamp
Payment cancelled at
amount
* integer
Payment amount
name
string
Product name
buyer_name
string
Customer name
buyer_email
string
Customer email\
buyer_tel
string
Customer phone number
buyer_addr
string
Customer address
buyer_postcode
string
Customer zip code
custom_data
string
Echo data as JSON string
schedule_status
*** ** string
Status of scheduled payment
scheduled
(payment is scheduled for execution)executed
(payment is completed)revoked
(payment is cancelled)
payment_status
*** ** string
Payment approval state
null
: Scheduled payment has not executed yet (actual null value, not string)paid
: Scheduled payment is approvedfailed
: Scheduled payment approval failedcancelled
: Scheduled payment is refunded (cancelled) after approval
fail_reason
string
Reason for failure
401: Unauthorized Missing or invalid access token
{
// Response
}
Response Model Schema
Response Model Schema
{
"code": 0,
"message": "string",
"response": [
{
"customer_uid": "string",
"merchant_uid": "string",
"imp_uid": "string",
"schedule_at": "0",
"executed_at": "0",
"revoked_at": "0",
"amount": 0,
"name": "string",
"buyer_name": "string",
"buyer_email": "string",
"buyer_tel": "string",
"buyer_addr": "string",
"buyer_postcode": "string",
"custom_data": "string",
"schedule_status": "scheduled",
"payment_status": "paid",
"fail_reason": "string"
}
]
}
Swagger Test Link