정기결제 관련 API
정기결제에 관련된 API 를 확인할 수 있습니다.
⌨ 정기결제예약 다건 조회
GET https://api.portone.io/v2/schedules 정기결제예약 다건 조회
정기결제예약 다건 조회
Parameters
Query
하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
결제예약시각(
scheduled_at
) 범위의 시작 - 값을 넣지 않으면 파라미터 end의 90일 전으로 설정됩니다.
결제예약시각(
scheduled_at
) 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.
결제예약 상태 리스트
페이지 - 0부터 시작합니다.
페이지 크기 (최대 1000까지 허용)
Responses
200 200 응답
current_page * integer
total_page * integer
total_count * integer
schedules * Array[Schedule]
결제예약정보
Schedule
Schedule
id * string
결제예약 ID
merchant_id * string
고객사 ID
store_id * string
하위 상점 ID
billing_key * string
빌링키
payment_id * string
결제 ID
status * ScheduleStatus
예약결제 상태
SCHEDULED: 결제 예약
STARTED: 결제 실행
COMPLETED: 실행 완료
CANCELLED: 예약 취소\
"SCHEDULED", "STARTED", "COMPLETED", "CANCELLED"
scheduled_at * string
결제 예약 시각
started_at string
결제 실행 시각 (status가 STARTED로 되었을 경우 제공)
completed_at string
결제 완료 시각 (status가 COMPLETED인 경우 제공)
cancelled_at string
결제 취소 시각 (status가 CANCELLED인 경우 제공)
order_name * string
주문명
is_cultural_expense * boolean
문화비 지출 여부
is_escrow * boolean
에스크로 결제 여부
products Array[Product]
상품 정보 (에스크로 결제 시 에스크로 상품 정보로 활용됨)
customer * Customer
구매자 정보
custom_data string
커스텀 데이터
total_amount * integer
결제 금액
tax_free_amount integer
면세 금액
currency * Currency
통화
"KRW", "USD", "EUR", "JPY", "CNY", "VND", "THB", "SGD", "AUD", "HKD", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"
origin Origin
결제를 요청한 근원에 대한 정보
notice_urls * Array[string]
결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다.
installment_month integer
할부개월
id string
구매자 ID
name string
구매자 이름
birthYear string
구매자 생년
gender Gender
"MALE", "FEMALE", "OTHER"
email string
구매자 이메일
phone_number string
구매자 전화번호
one_line_address string
구매자 주소 (한 줄)
separated_address SeparatedAddress
구매자 주소 (단위별)
SeparatedAddress
SeparatedAddress
country Country
국가
"AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BH", "BS", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
province string
시/도/구
city string
도시
address_line_1 * string
일반 주소
address_line_2 * string
상세 주소
zipcode string
구매자 우편번호
platform_type * string
결제를 요청한 단말의 플랫폼 분류
"PC", "MOBILE", "API"
user_agent string
결제근원의 환경 정보 (Http 의 User-Agent header value)
url string
결제근원의 페이지 url
ip_address * string
결제근원의 IP 주소
id * string
상품 ID
name * string
상품명
tag string
상품 태그(카테고리)
code string
상품 코드
amount * integer
상품 단위가격
quantity * integer
주문 수량
401 인증 실패
code * string
"UNAUTHORIZED"
params object
에러 세부사항
500 내부 서버 오류
code * string
"PORTONE_ERROR"
params object
에러 세부사항
⌨ 빌링키 정기결제예약 취소
DELETE https://api.portone.io/v2/schedules 빌링키 정기결제예약 취소
빌링키 정기결제예약 취소
Parameters
Query
하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
정기결제예약 빌링키
삭제할 정기결제예약 아이디 목록, 비어있을 경우 빌링키로 예약한 모든 예약을 취소함
Responses
200 200 응답
deleted_schedule_ids * Array[string]
삭제된 정기결제예약 아이디 목록
400 400 에러 응답
code * string
"INVALID_REQUEST", "SCHEDULE_ALREADY_PROCESSED"
params object
에러 세부사항
401 인증 실패
code * string
"UNAUTHORIZED"
params object
에러 세부사항
500 내부 서버 오류
code * string
"PORTONE_ERROR"
params object
에러 세부사항
⌨ 정기결제예약 단건 조회
GET https://api.portone.io/v2/schedules/{schedule_id} 정기결제예약 단건 조회
정기결제예약 단건 조회
Parameters
Path
정기결제예약 ID
Responses
200 200 응답
schedule * Schedule
결제예약정보
Schedule
Schedule
id * string
결제예약 ID
merchant_id * string
고객사 ID
store_id * string
하위 상점 ID
billing_key * string
빌링키
payment_id * string
결제 ID
status * ScheduleStatus
예약결제 상태
SCHEDULED: 결제 예약
STARTED: 결제 실행
COMPLETED: 실행 완료
CANCELLED: 예약 취소\
"SCHEDULED", "STARTED", "COMPLETED", "CANCELLED"
scheduled_at * string
결제 예약 시각
started_at string
결제 실행 시각 (status가 STARTED로 되었을 경우 제공)
completed_at string
결제 완료 시각 (status가 COMPLETED인 경우 제공)
cancelled_at string
결제 취소 시각 (status가 CANCELLED인 경우 제공)
order_name * string
주문명
is_cultural_expense * boolean
문화비 지출 여부
is_escrow * boolean
에스크로 결제 여부
products Array[Product]
상품 정보 (에스크로 결제 시 에스크로 상품 정보로 활용됨)
customer * Customer
구매자 정보
custom_data string
커스텀 데이터
total_amount * integer
결제 금액
tax_free_amount integer
면세 금액
currency * Currency
통화
"KRW", "USD", "EUR", "JPY", "CNY", "VND", "THB", "SGD", "AUD", "HKD", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"
origin Origin
결제를 요청한 근원에 대한 정보
notice_urls * Array[string]
결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다.
installment_month integer
할부개월
id string
구매자 ID
name string
구매자 이름
birthYear string
구매자 생년
gender Gender
"MALE", "FEMALE", "OTHER"
email string
구매자 이메일
phone_number string
구매자 전화번호
one_line_address string
구매자 주소 (한 줄)
separated_address SeparatedAddress
구매자 주소 (단위별)
SeparatedAddress
SeparatedAddress
country Country
국가 코드
"AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BH", "BS", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
province string
시/도/구
city string
도시
address_line_1 * string
일반 주소
address_line_2 * string
상세 주소
zipcode string
구매자 우편번호
platform_type * string
결제를 요청한 단말의 플랫폼 분류
"PC", "MOBILE", "API"
user_agent string
결제근원의 환경 정보 (Http 의 User-Agent header value)
url string
결제근원의 페이지 url
ip_address * string
결제근원의 IP 주소
id * string
상품 ID
name * string
상품명
tag string
상품 태그(카테고리)
code string
상품 코드
amount * integer
상품 단위가격
quantity * integer
주문 수량
401 인증 실패
code * string
"UNAUTHORIZED"
params object
에러 세부사항
404 리소스를 찾을 수 없음
code * string
"SCHEDULE_NOT_FOUND"
params object
에러 세부사항
500 내부 서버 오류
code * string
"PORTONE_ERROR"
params object
에러 세부사항