⌨️Cancel scheduled payment API
Cancels a scheduled payment before execution.
Cancels a scheduled payment before execution.
POST
https://api.iamport.kr/subscribe/payments/unschedule
Request Body
Name | Type | Description |
---|---|---|
customer_uid* | String | Billing key |
merchant_uid | Array | Order ID If omitted, cancels all scheduled payments associated with customer_uid. |
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
Swagger Test Link
Last updated