빌링키 관련 API
빌링키에 관련된 API 를 확인할 수 있습니다.
⌨ 빌링키 다건 조회
빌링키 다건 조회
GET https://api.portone.io/v2/billing-keys
Query Parameters
| Name | Type | Description |
|---|---|---|
billing_key* | array | 빌링키 |
store_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |
billing_keys * Array[BillingKey]
빌링키 정보
id string
구매자 ID
name string
구매자 이름
birthYear string
구매자 생년
gender Gender
"MALE", "FEMALE", "OTHER"
email string
구매자 이메일
phone_number string
구매자 전화번호
one_line_address string
구매자 주소 (한 줄)
separated_address SeparatedAddress
구매자 주소 (단위별)
zipcode string
구매자 우편번호
⌨ 빌링키 발급
빌링키 발급
POST https://api.portone.io/v2/billing-keys
Request Body
| Name | Type | Description |
|---|---|---|
store_id | string | 하위 상점 ID |
customer | CustomerForm | 고객 정보 |
custom_data | string | |
channel_name* | string | 결제 채널 이름 |
payment_method_option* | InstantBillingKeyPaymentMethodForm | 가능한 결제 수단: 카드, 휴대폰 소액 결제 선택한 결제 수단에 따라
와
중 하나에만 값이 들어있어야 합니다. |
billing_key * string
customer_id * string
requested_at * string
issued_at * string
address_line_1 * string
주소1
address_line_2 * string
주소2
city string
도시
province string
주, 도, 시
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"
customer_id string
가맹점의 고객 고유 ID - 값을 넣지 않으면 PortOne에서 자체 채번합니다.
phone_number string
휴대폰 번호
customer_name CustomerName
고객 이름 정보. full_name만 채워져 있거나, first_name & last_name이 채워져 있어야 함
email string
고객 이메일
zipcode string
우편번호
address Address
주소 형식
gender Gender
성별
"MALE", "FEMALE", "OTHER"
birth_year string
출생연도
birth_month string
출생월
birth_day string
출생일
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"
card InstantBillingKeyCardForm
빌링키 발급 시에 필요한 카드 관련 정보
mobile_phone MobileForm
휴대폰을 이용한 소액결제와 정기결제를 위한 빌링키 발급 시에 사용하는 휴대폰 관련 정보
⌨ 빌링키 단건 조회
빌링키 단건 조회
GET https://api.portone.io/v2/billing-keys/{billing_key}
Path Parameters
| Name | Type | Description |
|---|---|---|
billing_key* | string | 빌링키 |
Query Parameters
| Name | Type | Description |
|---|---|---|
store_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |
billing_key * BillingKey
빌링키 정보
id string
구매자 ID
name string
구매자 이름
birthYear string
구매자 생년
gender Gender
"MALE", "FEMALE", "OTHER"
email string
구매자 이메일
phone_number string
구매자 전화번호
one_line_address string
구매자 주소 (한 줄)
separated_address SeparatedAddress
구매자 주소 (단위별)
zipcode string
구매자 우편번호
⌨ 빌링키 삭제
빌링키 삭제
DELETE https://api.portone.io/v2/billing-keys/{billing_key}
Path Parameters
| Name | Type | Description |
|---|---|---|
billing_key* | string | 빌링키 |
Query Parameters
| Name | Type | Description |
|---|---|---|
store_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. |
deleted_at * string
빌링키 삭제 시각
Last updated