Get scheduled payments API
Gets scheduled payments by billing key.
GET https://api.iamport.kr/subscribe/customers/{customer_uid}/schedules Gets scheduled payments by billing key.
Gets scheduled payments by billing key.
Returns scheduled payments using pagination (up to 3 months period).
Parameters
Path
Billing key
Query
Search result paging
Starts at 1 (default: 1)
UNIX timestamp
UNIX timestamp
Schedule status
If not specified, returns for all status
scheduled
executed
revoked
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
(CustomerAnnotation, 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
Customer ID
pg_provider
* string
PG code for billing key
pg_id
* string
PG merchant ID (MID) for billing key
card_name
* string
Credit card name
card_code
* string
Credit card code
card_number
* string
Masked card number
card_type
* string
Credit card type
Not supported in some PGs (returns null)
customer_name
* string
Customer name
customer_tel
* string
Customer phone
customer_email
* string
Customer email
customer_addr
* string
Customer address
customer_postcode
* string
Customer zip code
inserted
* integer
Billing key issued at
(UNIX timestamp)
updated
* integer
Billing key updated at
(UNIX timestamp)
400: Bad Request Invalid parameter value
{
// Response
}
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
https://api.iamport.kr/#!/subscribe.customer/findSchedulesByCustomer