⌨️Get scheduled payments API
Last updated
Last updated
GET https://api.iamport.kr/subscribe/payments/schedule
Scheduled payments data is sorted by the latest scheduled time. To sort by the oldest scheduled time, set sorting=scheduled.
schedule_from*
integer
Start search time (UNIX timestamp)
schedule_to*
integer
End search time (UNIX timestamp)
schedule_status
String
Schedule status
scheduled
executed
revoked
page
integer
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'.
Swagger Test Link
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 approved
failed: Scheduled payment approval failed
fail_reason string
Reason for failure
Result paging
Starts from 1, default: 1
limit
integer
Results per page
Max 1000, default: 20
sorting
String
Sort by
Default: latest scheduled time
scheduled: oldest scheduled time
{
// Response
}{
// Response
}cancelled: Scheduled payment is refunded (cancelled) after approval