Get scheduled payments API

Gets a list of scheduled payments by search period.

GET https://api.iamport.kr/subscribe/payments/schedule

Gets a list of scheduled payments by search period.

Scheduled payments data is sorted by the latest scheduled time. To sort by the oldest scheduled time, set

sorting=scheduled

Parameters

Query

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

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

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 approved
failed: Scheduled payment approval failed
cancelled: Scheduled payment is refunded (cancelled) after approval

fail_reason string

Reason for failure

400: Bad Request

Invalid parameter

{
  // Response
}

401: Unauthorized

Missing or invalid access token

{
  // Response
}

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

https://api.iamport.kr/#!/subscribe/findSchedulesByRange