# 결제 관련 API {% hint style="warning" %} **Deprecated** 이 문서는 더 이상 관리되지 않습니다. [PortOne 개발자센터](https://developers.portone.io/)를 이용해주세요. {% endhint %} ## ⌨ 결제내역 단건조회 ## 결제내역 단건조회 `GET` `https://api.portone.io/v2/payments/{payment_id}` 결제가 발생한 이후 즉시 조회가 가능한 API입니다. #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Query Parameters | Name | Type | Description | | --------- | ------ | ---------------------------------------------------------- | | store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. | {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`payment`** **\*** **Payment** 결제내역

Payment

**`id`** **\*** **string** 가맹점에서 입력한 결제 ID *** **`merchant_id`** **\*** **string** 가맹점 ID *** **`store_id`** **\*** **string** 하위 상점 ID *** **`transactions`** **\*** **Array\[Transaction]** 동일한 `payment_id`로 결제시도된 결제내역들 ***

*** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

**`publisher`** **string** 발행사 코드 *** **`issuer`** **string** 발급사 코드 *** **`brand`** **CardBrand** 카드 브랜드 `"LOCAL"`, `"MASTER"`, `"UNIONPAY"`, `"VISA"`, `"JCB"`, `"AMEX"`, `"DINERS"` *** **`card_type`** **CardType** 카드 종류 `"CREDIT"`, `"DEBIT"`, `"GIFT"` *** **`card_owner_type`** **CardOwnerType** 카드 소유주 유형 `"PERSONAL"`, `"CORPORATE"` *** **`bin`** **string** 카드 빈넘버 *** **`name`** **string** 카드전표인자명 ***

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

*** **`card_point_used`** **boolean** 카드 포인트 사용여부 *** {% endtab %} {% tab title="CardDetail" %} **`publisher`** **string** 발행사 코드 *** **`issuer`** **string** 발급사 코드 *** **`brand`** **CardBrand** 카드 브랜드 `"LOCAL"`, `"MASTER"`, `"UNIONPAY"`, `"VISA"`, `"JCB"`, `"AMEX"`, `"DINERS"` *** **`card_type`** **CardType** 카드 종류 `"CREDIT"`, `"DEBIT"`, `"GIFT"` *** **`card_owner_type`** **CardOwnerType** 카드 소유주 유형 `"PERSONAL"`, `"CORPORATE"` *** **`bin`** **string** 카드 빈넘버 *** **`name`** **string** 카드전표인자명 *** {% endtab %} {% tab title="EasyPay" %} **`easy_pay_provider`** **\*** **EasyPayProvider** 간편결제 PG사 `"PAYCO"`, `"SAMSUNGPAY"`, `"SSGPAY"`, `"KAKAOPAY"`, `"NAVERPAY"`, `"CHAI"`, `"LPAY"`, `"KPAY"`, `"TOSSPAY"`, `"LGPAY"`, `"PINPAY"`, `"APPLEPAY"` *** **`card`** **Card** 카드 결제 정보

Card

**`detail`** **CardDetail** 카드 정보 *** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보 *** **`card_point_used`** **boolean** 카드 포인트 사용여부 ***

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

*** {% endtab %} {% endtabs %} {% tabs %} {% tab title="GiftCertificate" %} **`type`** **GiftCertificateType** `"BOOKNLIFE"`, `"SMART_MUNSANG"`, `"CULTURELAND"`, `"HAPPYMONEY"` *** **`approval_number`** **\*** **string** 상품권 승인번호 *** {% endtab %} {% tab title="Installment" %} **`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 *** {% endtab %} {% tab title="Mobile" %} **`carrier`** **Carrier** 통신사 `"SKT"`, `"KT"`, `"LGU"`, `"HELLO"`, `"KCT"`, `"SK7"` *** **`phone_number`** **string** 휴대전화번호 *** {% endtab %} {% tab title="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** 상세 주소 *** {% endtab %} {% endtabs %} {% tabs %} {% tab title="Transaction" %} **`id`** **\*** **string** 포트원 채번 거래번호 *** **`is_primary`** **\*** **boolean** 대표 트랜잭션 여부 *** **`version`** **\*** **Version** 포트원 내부 결제시스템 버전 `"V1"`, `"V2"` *** **`method`** **method\_PaymentMethod** 결제수단 목록 `"CARD"`, `"TRANSFER"`, `"VIRTUAL_ACCOUNT"`, `"MOBILE"`, `"GIFT_CERTIFICATE"`, `"EASY_PAY"` *** **`channel`** **channel\_Channel** 결제 채널 정보

channel_Channel

**`id`** **string** 채널 ID *** **`name`** **string** 채널 이름 *** **`type`** **\*** **channel\_ChannelType** 채널 유형 `"LIVE"`, `"TEST"` *** **`pg_provider`** **\*** **pg\_provider\_PgProvider-2** 결제대행사(PG사) `"HTML5_INICIS"`, `"PAYPAL"`, `"PAYPAL_V2"`, `"INICIS"`, `"DANAL"`, `"NICE"`, `"DANAL_TPAY"`, `"JTNET"`, `"UPLUS"`, `"NAVERPAY"`, `"KAKAO"`, `"SETTLE"`, `"KCP"`, `"MOBILIANS"`, `"KAKAOPAY"`, `"NAVERCO"`, `"SYRUP"`, `"KICC"`, `"EXIMBAY"`, `"SMILEPAY"`, `"PAYCO"`, `"KCP_BILLING"`, `"ALIPAY"`, `"PAYPLE"`, `"CHAI"`, `"BLUEWALNUT"`, `"SMARTRO"`, `"SMARTRO_V2"`, `"PAYMENTWALL"`, `"TOSSPAYMENTS"`, `"KCP_QUICK"`, `"DAOU"`, `"GALAXIA"`, `"TOSSPAY"`, `"KCP_DIRECT"`, `"SETTLE_ACC"`, `"SETTLE_FIRM"`, `"INICIS_UNIFIED"`, `"KSNET"`, `"PINPAY"` *** **`pg_merchant_id`** **\*** **string** PG사에 등록된 가맹점 ID ***

*** **`schedule_id`** **string** 예약결제 ID - 예약결제에만 해당됩니다. *** **`billing_key`** **string** 결제를 발생시킨 빌링키 - 빌링키결제에만 해당됩니다. *** **`notifications`** **Array\[notification\_Notification]** 웹훅 발송 내역

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

*** **`status_updated_at`** **string** 상태변경시각 *** **`updated_at`** **\*** **string** 수정 시각 *** **`order_name`** **\*** **string** 주문명 *** **`status`** **\*** **TransactionStatus** 결제 건의 상태를 나타내는 enum string `"READY"`, `"PENDING"`, `"VIRTUAL_ACCOUNT_ISSUED"`, `"PAID"`, `"FAILED"`, `"PARTIAL_CANCELLED"`, `"CANCELLED"` *** **`amount`** **\*** **TransactionAmount** 결제 금액 및 통화 관련 세부 정보

TransactionAmount

**`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"` *** **`total`** **\*** **integer** 결제 요청 금액 *** **`tax_free`** **\*** **integer** 면세금액 *** **`vat`** **integer** 부가세 *** **`supply`** **integer** 공급가액 *** **`discount`** **\*** **integer** 할인금액 (카드사 프로모션, 아임포트 프로모션, 적립형 포인트 결제, 쿠폰 할인 등을 포함) *** **`paid`** **\*** **integer** 실제 결제 금액 *** **`cancelled`** **\*** **integer** 취소 금액 *** **`cancelled_tax_free`** **\*** **integer** 취소 금액 중 면세 금액 ***

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

**`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** 구매자 우편번호 ***

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

**`platform_type`** **\*** **string** 결제를 요청한 단말의 플랫폼 분류 `"PC"`, `"MOBILE"`, `"API"` *** **`user_agent`** **string** 결제근원의 환경 정보 (Http 의 User-Agent header value) *** **`url`** **string** 결제근원의 페이지 url *** **`ip_address`** **\*** **string** 결제근원의 IP 주소 ***

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

**`company`** **\*** **string** 택배사 *** **`invoice_number`** **\*** **string** 송장번호 *** **`status`** **EscrowStatus** 에스크로 상태 `"REGISTERED"`, `"COMPLETED"`, `"CONFIRMED"`, `"AUTO_CONFIRMED"`, `"REJECTED"`, `"CANCEL"`, `"REJECT_CONFIRMED"` *** **`sent_at`** **string** 발송 일시 (배송이 발송되었을 경우 제공) *** **`applied_at`** **string** 배송등록 처리 일자 ***

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

**`id`** **\*** **string** 상품 ID *** **`name`** **\*** **string** 상품명 *** **`tag`** **string** 상품 태그(카테고리) *** **`code`** **string** 상품 코드 *** **`amount`** **\*** **integer** 상품 단위가격 *** **`quantity`** **\*** **integer** 주문 수량 ***

*** **`product_count`** **integer** 상품 갯수 *** **`custom_data`** **string** 가맹점의 결제 데이터 추가 정보 *** **`requested_at`** **\*** **string** 결제요청시각 *** **`promotion_id`** **string** 포트원 프로모션 아이디 *** **`failure`** **PaymentFailure** 결제 실패 정보

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

*** **`failed_at`** **string** 결제실패시각 - `status`가 `FAILED`인 경우 제공됩니다. *** **`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"` *** **`paid_at`** **string** 결제완료시각 - `status`가 `COMPLETED`로 되었을 경우 제공됩니다. *** **`payment_method_detail`** **PaymentMethodDetail** 결제 수단 정보

PaymentMethodDetail

**`card`** **Card** 카드 결제 정보 *** **`transfer`** **Transfer** 계좌이체 정보 *** **`virtual_account`** **VirtualAccount** 가상계좌 결제 정보 *** **`mobile`** **Mobile** 모바일결제 정보 *** **`gift_certificate`** **GiftCertificate** 상품권 결제 정보 *** **`easy_pay`** **EasyPay** 간편결제 정보 (충전식 간편결제일 경우 card와 transfer 값이 null임) ***

*** **`pg_tx_id`** **string** PG사 거래ID - `status`가 `COMPLETED`로 되었을 경우 제공됩니다. *** **`pg_response`** **string** PG사 거래 응답 본문 - `status`가 `COMPLETED`로 되었을 경우 제공됩니다. *** **`cash_receipt`** **CashReceiptDetail** 현금영수증 정보

CashReceiptDetail

**`pg_receipt_id`** **string** PG사 현금영수증 발급 ID *** **`issue_number`** **\*** **string** 현금영수증 승인번호 *** **`type`** **CashReceiptType** `"PERSONAL"`, `"CORPORATE"`, `"ANONYMOUS"` *** **`amount`** **\*** **integer** 금액 *** **`tax_free_amount`** **integer** 면세금액 *** **`status`** **CashReceiptStatus** `"ISSUED"`, `"CANCELLED"` *** **`issued_at`** **\*** **string** 발급일시 *** **`cancelled_at`** **string** 취소일시 (`status`가 `CANCELLED`인 경우 제공) *** **`receipt_url`** **string** 영수증 url ***

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

**`id`** **\*** **string** 취소 ID *** **`pg_cancellation_id`** **\*** **string** PG사 취소 ID *** **`cancel_amount`** **\*** **integer** 취소 금액 *** **`tax_free_amount`** **\*** **integer** 취소 면세 금액 *** **`easy_pay_discount_amount`** **integer** 적립형 포인트의 환불 금액 *** **`reason`** **\*** **string** 취소 사유 *** **`cancelled_at`** **string** 취소일시 *** **`requested_at`** **\*** **string** 취소요청일시 *** **`status`** **\*** **CancellationStatus** 취소 상태 `"REQUESTED"`, `"FAILED"`, `"SUCCEEDED"` ***

*** **`cancelled_at`** **string** 결제취소시각 - `status`가 `CANCELLED`인 경우 제공됩니다. *** {% endtab %} {% tab title="Transfer" %} **`bank_code`** **string** 표준 은행 코드 *** {% endtab %} {% tab title="VirtualAccount" %} **`bank_code`** **string** 표준 은행 코드 *** **`account_number`** **\*** **string** 계좌번호 *** **`account_type`** **VirtualAccountType** 계좌 유형 `"FIXED"`, `"NORMAL"` *** **`remittee_name`** **string** 계좌주 *** **`remitter_name`** **string** 송금인 (입금자) *** **`expired_at`** **string** 입금만료시점 *** **`issued_at`** **string** 계좌발급시점 *** **`refund_status`** **RefundStatus** 가상계좌 결제가 환불 단계일 때의 환불 상태 `"PENDING"`, `"PARTIAL_FAILED"`, `"FAILED"`, `"COMPLETED"` *** {% endtab %} {% tab title="Webhook" %} **`id`** **\*** **string** 웹훅 ID *** **`status`** **WebhookStatus** 웹훅 전송 상태 `"SUCCEEDED"`, `"REQUEST_FAILED"`, `"CONNECT_FAILED"` *** **`type`** **WebhookType** 웹훅 유형 `"READY"`, `"PAID"`, `"FAILED"`, `"CANCELLED"`, `"PARTIAL_CANCELLED"`, `"VIRTUAL_ACCOUNT_ISSUED"`, `"CANCEL_PENDING"` *** **`url`** **\*** **string** 웹훅이 발송된 url *** **`is_async`** **boolean** 비동기 웹훅 여부 *** **`current_execution`** **integer** 현재 발송 횟수 *** **`max_execution`** **integer** 최대 발송 횟수 *** **`webhook_trigger`** **WebhookTrigger** 웹훅 실행 주체 `"NOTIFICATION_SETTING"`, `"MANUAL"`, `"VIRTUAL_ACCOUNT_DEPOSIT"`, `"ASYNC_CANCEL_APPROVED"` *** **`request`** **WebhookRequest** 웹훅 요청 정보

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

**`code`** **\*** **string** 웹훅 응답 http 코드 *** **`header`** **\*** **object** 응답 header *** **`body`** **\*** **string** 응답 body *** **`responded_at`** **\*** **string** 응답 시각 ***

*** **`triggered_at`** **string** 웹훅 처리 시작 시각 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"UNAUTHORIZED"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 리소스를 찾을 수 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 오류" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} ## ⌨ 결제내역 다건조회 ## 결제내역 다건조회 `GET` `https://api.portone.io/v2/payments` 결제내역들을 조회할 수 있는 API입니다. 실제 결제 발생 이후 조회되기까지 지연이 있으니 검증을 위해서는 [결제내역 단건조회](#getPayment) 를 이용해주세요. 현재 page \* limit이 50000 이상이 되는 쿼리를 허용하지 않는 제약을 갖고있습니다. 많은 양의 데이터를 받아올 경우 날짜범위를 좁혀서 사용해주세요. 추후 50000개 이상 대량의 데이터를 한번에 편리하게 쿼리할 수 있도록 하는 수정이 예정되어있습니다. #### Query Parameters | Name | Type | Description | | --------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | store\_id | string | 하위 상점 ID - Merchant 사용자만 사용가능하며, 지정되지 않은 경우 가맹점 전체 결제건을 조회합니다. | | start | string |

결제 상태 승인시각 범위의 시작 - 값을 넣지 않으면

end

의 90일 전으로 설정됩니다. (결제건의 최종 상태에 따라 다른 검색기준이 적용됩니다. 'ready' -> 결제시작 시각 기준, 'paid' -> 결제완료 시각 기준, 'cancelled' -> 결제취소 시각 기준, 'failed' -> 결제실패 시각 기준)

정렬 기준

REQUESTED\_AT

: 결제요청시각

STATUS\_UPDATED\_AT

: 상태변경시각

| | sort\_order\* | string |

정렬 방향

DESCENDING

: 내림차순

ASCENDING

: 오름차순

| {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`current_page`** **\*** **integer** *** **`total_page`** **\*** **integer** *** **`total_count`** **\*** **integer** *** **`payments`** **\*** **Array\[Payment]** 결제내역

Payment

*** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

Card

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

channel_Channel

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

TransactionAmount

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

PaymentMethodDetail

CashReceiptDetail

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

Payment 생성시각 범위의 시작 - 값을 넣지 않으면

end

의 90일 전으로 설정됩니다.

| | end | string | Payment 생성시각 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다. | | cursor | string | 결제내역 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다. | | limit | integer | 페이지 크기 (최대 1000까지 허용) | {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`payments`** **\*** **Array\[Payment]** 결제내역

Payment

*** **`cursor`** **string** 결제내역 리스트 중 어디까지 읽었는지를 나타냅니다. *** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

Card

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

channel_Channel

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

TransactionAmount

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

PaymentMethodDetail

CashReceiptDetail

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

*** **`triggered_at`** **string** 웹훅 처리 시작 시각 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"UNAUTHORIZED"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 오류" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} ## ⌨ 결제 취소 ## 결제 취소 `POST` `https://api.portone.io/v2/payments/{payment_id}/cancel` #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Query Parameters | Name | Type | Description | | --------- | ------ | ---------------------------------------------------------- | | store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. | #### Request Body | Name | Type | Description | | ------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------- | | reason | string | 취소 사유 | | cancel\_amount | integer | 취소 금액 - 값을 넣지 않으면 전액 취소됩니다. | | tax\_free\_amount | integer | 취소 금액 중 면세 금액 - 값을 넣지 않으면 전액 과세됩니다. | | vat\_amount | integer | 취소 금액 중 부가세 금액 (PG사 기본값: null). 결제 시 부가세를 지정했던 경우 필수 입력 바랍니다. 지원되는 PG사: 나이스페이먼츠(NICE), 이니시스(HTML5\_INICIS) | | check\_refundable\_amount | integer | 결제 건의 취소 가능 잔액 - 값을 넣지 않으면 별도의 검증 처리를 수행하지 않습니다. | | refund | RefundAccount | 환불 계좌 정보 - 가상계좌 결제인 경우에만 기입할 수 있습니다. | {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`cancelled_tx_id`** **\*** **string** 취소 대상 거래 아이디 *** **`cancellation_id`** **\*** **string** 취소 아이디 *** **`payment`** **\*** **Payment** 결제내역

Payment

*** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

Card

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

channel_Channel

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

TransactionAmount

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

PaymentMethodDetail

CashReceiptDetail

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

*** **`triggered_at`** **string** 웹훅 처리 시작 시각 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 400 에러 응답" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"INVALID_REQUEST"`, `"NOT_PAID"`, `"PAYMENT_ALREADY_CANCELLED"`, `"REFUNDABLE_AMOUNT_CONSISTENCY_BROKEN"`, `"CANCEL_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_CANCELLABLE_AMOUNT"`, `"CANCEL_TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_CANCEL_AMOUNT"`, `"CANCEL_TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_CANCELLABLE_TAX_FREE_AMOUNT"`, `"CANCEL_TAX_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_CANCELLABLE_TAX_AMOUNT"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"UNAUTHORIZED"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 리소스를 찾을 수 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 오류" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="RefundAccount" %} **`bank`** **\*** **string** 은행 *** **`account_holder`** **\*** **string** 예금주 *** **`account_number`** **\*** **string** 계좌번호 *** **`phone_number`** **string** 예금주 연락처 - 스마트로 가상계좌 결제인 경우에 필요합니다. *** {% endtab %} {% endtabs %} ## ⌨ 웹훅 재발송 ## 웹훅 재발송 `POST` `https://api.portone.io/v2/payments/{payment_id}/resend-webhook` `tx_id` 와 `webhook_id` 모두 값을 넣지 않으면 대표 트랜잭션의 가장 최근 웹훅 발송 이력을 기준으로 재전송됩니다. #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Query Parameters | Name | Type | Description | | --------- | ------ | ---------------------------------------------------------- | | store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. | #### Request Body | Name | Type | Description | | ----------- | ------ | ---------------------------------------------------- | | tx\_id | string | 재발송 대상 트랜잭션 아이디 - 값을 넣지 않으면 기본값은 대표 트랜잭션 아이디로 설정됩니다. | | webhook\_id | string | 재발송 대상 웹훅 아이디 - 값을 넣지 않으면 기본값은 가장 최근의 웹훅 아이디로 설정됩니다. | {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`tx_id`** **\*** **string** 재발송 대상 트랜잭션 아이디 *** **`webhook_id`** **string** 재발송 대상 웹훅 아이디 (값을 넣지 않으면 가장 최근의 웹훅 아이디 기준으로 재전송) 비동기 웹훅이거나 웹훅 처리에 너무 오랜 시간이 걸리는 경우 값이 비어있을 수 있습니다. *** **`payment`** **\*** **Payment** 결제내역

Payment

*** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

Card

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

channel_Channel

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

TransactionAmount

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

PaymentMethodDetail

CashReceiptDetail

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

*** **`triggered_at`** **string** 웹훅 처리 시작 시각 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"UNAUTHORIZED"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 리소스를 찾을 수 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 오류" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"WEBHOOK_ERROR"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} ## ⌨ 가상계좌 테스트 웹훅 호출 ## 가상계좌 테스트 웹훅 호출 `POST` `https://api.portone.io/v2/test-payments/{payment_id}/notice-virtual-account-deposit` 가상계좌 테스트 결제 건에 대한 입금 통보 웹훅을 호출합니다. #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Query Parameters | Name | Type | Description | | --------- | ------ | ---------------------------------------------------------- | | store\_id | string | 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다. | {% tabs %} {% tab title="200 200 응답" %} {% tabs %} {% tab title="Response" %} **`tx_id`** **\*** **string** 웹훅 기준 트랜잭션 ID *** **`webhook_id`** **string** 재발송 대상 웹훅 아이디 (값을 넣지 않으면 가장 최근의 웹훅 아이디 기준으로 재전송) 비동기 웹훅이거나 웹훅 처리에 너무 오랜 시간이 걸리는 경우 값이 비어있을 수 있습니다. *** **`payment`** **\*** **Payment** 결제내역

Payment

*** {% endtab %} {% tab title="Card" %} **`detail`** **CardDetail** 카드 정보

CardDetail

*** **`number`** **string** 마스킹된 카드 번호 *** **`approval_number`** **string** 승인 번호 *** **`installment`** **Installment** 할부 정보

Installment

**`month`** **\*** **integer** 할부 개월 수 *** **`is_interest_free`** **\*** **boolean** 무이자할부 여부 ***

Card

*** **`charge`** **Charge** 충전식 포인트 결제 정보

Charge

**`bank_code`** **string** 표준 은행 코드 (계좌 이체시 입력됨) ***

*** **`transfer`** **Transfer** 계좌이체 정보

Transfer

**`bank_code`** **string** 표준 은행 코드 ***

channel_Channel

notification_Notification

**`webhook`** **Webhook** 웹훅 정보 ***

TransactionAmount

*** **`customer`** **\*** **Customer** 구매자 정보

Customer

*** **`origin`** **\*** **Origin** 결제를 요청한 근원에 대한 정보

Origin

*** **`is_cultural_expense`** **boolean** 문화비 지출 여부 *** **`is_escrow`** **\*** **boolean** 에스크로 여부 *** **`escrow_detail`** **EscrowDetail** 에스크로 결제 정보

EscrowDetail

*** **`products`** **Array\[Product]** 상품 정보 - 에스크로 결제 시 에스크로 상품 정보로 활용됩니다.

Product

PaymentFailure

**`reason`** **string** 실패 이유 *** **`pg_code`** **string** PG사 전달 에러 코드 *** **`pg_message`** **string** PG사 전달 에러 메세지 ***

PaymentMethodDetail

CashReceiptDetail

*** **`cancellations`** **Array\[Cancellation]** 취소내역 - `status`가 `CANCELLED`인 경우 제공됩니다.

Cancellation

WebhookRequest

**`header`** **object** 요청 header *** **`body`** **\*** **string** 요청 body *** **`requested_at`** **string** 요청 시각 ***

*** **`response`** **WebhookResponse** 웹훅 응답 정보

WebhookResponse

*** **`triggered_at`** **string** 웹훅 처리 시작 시각 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 400 에러 응답" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"INVALID_REQUEST"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"UNAUTHORIZED"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 리소스를 찾을 수 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 오류" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"` *** **`params`** **object** 에러 세부사항 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} ## ⌨ 결제 예약 ## 결제 예약 `POST` `https://api.portone.io/v2/schedules` #### Request Body | Name | Type | Description | | ----------------------------------------------- | --------------------- | -------------------------------------------------------- | | billing\_key\* | string | 빌링키 결제에 사용할 빌링키 | | store\_id | string | 빌링키 결제를 진행하는 상점의 id | | order\_name\* | string | 주문명 | | is\_cultural\_expense | boolean |

문화비 지출 여부 (기본값:

"false")

| | is\_escrow | boolean |

에스크로 여부 (기본값:

"false")

면세 금액 (기본값:

"0")

| | country | Country | 국가 | | currency\* | Currency | 화폐 | | notice\_urls | Array\[string] | 결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. | | card\_installment\_plan | integer | 할부 개월 수 | | use\_free\_interest\_from\_mall | boolean | 무이자 할부 이자를 상점이 부담할지 여부 | | product\_type | ProductType | 상품 유형 | | product\_count | integer | 상품 개수 | | use\_card\_point | boolean | 카드 포인트 사용 여부 | | bypass | string | 각 PG사 별로 필요한 파라미터를 받습니다. | | payment\_id\* | string | | | scheduled\_at\* | string | | {% tabs %} {% tab title="200 결제 예약 성공" %} {% tabs %} {% tab title="Response" %} **`id`** **\*** **string** *** **`scheduled_at`** **\*** **string** *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 잘못된 요청" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\ `PAST_SCHEDULED`: 현재 시각보다 이전의 시각으로 예약을 요청하였습니다.\ `PAYMENT_ALREADY_EXISTS`: 해당 payment는 이미 결제되었거나 가상계좌 입금 대기 상태입니다.\ `PAYMENT_ALREADY_SCHEDULED`: 이미 존재하는 예약건입니다.\ `BILLING_KEY_DELETED`: 삭제된\_빌링키로\_예약을\_시도했습니다.\\ `"INVALID_REQUEST"`, `"PAST_SCHEDULED"`, `"PAYMENT_ALREADY_EXISTS"`, `"PAYMENT_ALREADY_SCHEDULED"`, `"BILLING_KEY_DELETED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\ `"UNAUTHORIZED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="403 권한 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\ `"PERMISSION_DENIED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 하위 상점이나 빌링키를 찾을 수 없습니다." %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\ `BILLING_KEY_NOT_FOUND`: 빌링키를 찾을 수 없습니다.\\ `"STORE_NOT_FOUND"`, `"BILLING_KEY_NOT_FOUND"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 에러" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="Address" %} **`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"` *** {% endtab %} {% tab title="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"` {% endtab %} {% tab title="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"` {% endtab %} {% tab title="CustomerFormWithoutId" %} **`phone_number`** **string** 휴대폰 번호 *** **`customer_name`** **CustomerName** 고객 이름 정보. full\_name만 채워져 있거나, first\_name & last\_name이 채워져 있어야 함

CustomerName

**`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** ***

*** **`email`** **string** 고객 이메일 *** **`zipcode`** **string** 우편번호 *** **`address`** **Address** 주소 형식

Address

**`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"` ***

*** **`gender`** **Gender** 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` *** **`birth_year`** **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"` *** **`birth_month`** **string** 출생월 *** **`birth_day`** **string** 출생일 *** {% endtab %} {% endtabs %} {% tabs %} {% tab title="CustomerName" %} **`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** *** {% endtab %} {% tab title="Gender" %} 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` {% endtab %} {% tab title="Product" %} **`id`** **\*** **string** *** **`name`** **\*** **string** *** **`tag`** **string** *** **`code`** **string** *** **`quantity`** **\*** **integer** *** **`amount`** **\*** **number** *** **`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"` *** {% endtab %} {% tab title="ProductType" %} 상품 유형 `"REAL"`, `"DIGITAL"` {% endtab %} {% endtabs %} ## ⌨ 빌링키 결제 ## 빌링키 결제 `POST` `https://api.portone.io/v2/payments/{payment_id}/billing-key/pay` #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Request Body | Name | Type | Description | | ----------------------------------------------- | ------------------------ | -------------------------------------------------------- | | billing\_key\* | string | 빌링키 결제에 사용할 빌링키 | | store\_id | string | 빌링키 결제를 진행하는 상점의 id | | order\_name\* | string | 주문명 | | is\_cultural\_expense | boolean |

문화비 지출 여부 (기본값:

"false")

| | is\_escrow | boolean |

에스크로 여부 (기본값:

"false")

면세 금액 (기본값:

"0")

| | country | country\_Country | 국가 | | currency\* | currency\_Currency | 화폐 | | notice\_urls | Array\[string] | 결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. | | card\_installment\_plan | integer | 할부 개월 수 | | use\_free\_interest\_from\_mall | boolean | 무이자 할부 이자를 상점이 부담할지 여부 | | product\_type | ProductType | 상품 유형 | | product\_count | integer | 상품 개수 | | use\_card\_point | boolean | 카드 포인트 사용 여부 | | bypass | string | 각 PG사 별로 필요한 파라미터를 받습니다. | {% tabs %} {% tab title="200 빌링키 결제 성공" %} {% tabs %} {% tab title="Response" %} **`tx_id`** **\*** **string** *** **`customer_id`** **\*** **string** *** **`requested_at`** **\*** **string** *** **`paid_at`** **\*** **string** *** **`pg_tx_id`** **\*** **string** PG사 거래ID *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 잘못된 요청" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\ `TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_TOTAL_AMOUNT`: 면세금액은 결제금액보다 작거나 같아야 합니다.\ `BILLING_KEY_ALREADY_DELETED`: 삭제된 빌링키로 결제를 시도하셨습니다.\ `PAYMENT_ALREADY_PAID`: 이미 결제되었습니다.\\ `"INVALID_REQUEST"`, `"TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_TOTAL_AMOUNT"`, `"BILLING_KEY_ALREADY_DELETED"`, `"PAYMENT_ALREADY_PAID"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\ `"UNAUTHORIZED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="403 권한 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\ `"PERMISSION_DENIED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 하위 상점이나 빌링키를 찾을 수 없습니다." %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `STORE_NOT_FOUND`: 하위\_상점을\_찾을\_수\_없습니다.\ `BILLING_KEY_NOT_FOUND`: 빌링키를 찾을 수 없습니다.\\ `"STORE_NOT_FOUND"`, `"BILLING_KEY_NOT_FOUND"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 에러" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="Address" %} **`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` *** {% endtab %} {% tab title="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"` {% endtab %} {% tab title="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"` {% endtab %} {% tab title="CustomerFormWithoutId" %} **`phone_number`** **string** 휴대폰 번호 *** **`customer_name`** **CustomerName** 고객 이름 정보. full\_name만 채워져 있거나, first\_name & last\_name이 채워져 있어야 함

CustomerName

**`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** ***

*** **`email`** **string** 고객 이메일 *** **`zipcode`** **string** 우편번호 *** **`address`** **Address** 주소 형식

Address

**`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` ***

*** **`gender`** **gender\_Gender** 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` *** **`birth_year`** **string** 출생연도 *** **`country`** **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"` *** **`birth_month`** **string** 출생월 *** **`birth_day`** **string** 출생일 *** {% endtab %} {% endtabs %} {% tabs %} {% tab title="CustomerName" %} **`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** *** {% endtab %} {% tab title="gender\_Gender" %} 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` {% endtab %} {% tab title="product\_Product" %} **`id`** **\*** **string** *** **`name`** **\*** **string** *** **`tag`** **string** *** **`code`** **string** *** **`quantity`** **\*** **integer** *** **`amount`** **\*** **number** *** **`currency`** **\*** **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"` *** {% endtab %} {% tab title="ProductType" %} 상품 유형 `"REAL"`, `"DIGITAL"` {% endtab %} {% endtabs %} ## ⌨ 키인(수기) 결제 ## 키인(수기) 결제 `POST` `https://api.portone.io/v2/payments/{payment_id}/instant/pay` #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | | #### Request Body | Name | Type | Description | | --------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | store\_id | string | 하위 상점 ID | | order\_name\* | string | | | is\_cultural\_expense | boolean |

문화비 지출 여부 (기본값:

"false")

| | is\_escrow | boolean |

에스크로 여부 (기본값:

"false")

면세 금액 (기본값:

"0")

가능한 결제 수단: 카드, 가상계좌 선택한 결제 수단에 따라

card

와

virtual\_account

중 하나에만 값이 들어있어야 합니다.

| {% tabs %} {% tab title="200 키인(수기) 결제 성공" %} {% tabs %} {% tab title="Response" %} **`tx_id`** **\*** **string** *** **`customer_id`** **\*** **string** *** **`requested_at`** **\*** **string** *** **`paid_at`** **\*** **string** *** **`pg_tx_id`** **\*** **string** PG사 거래ID *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 잘못된 요청" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\ `TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_TOTAL_AMOUNT`: 면세금액은\_결제금액보다\_작거나\_같아야\_합니다.\ `PAYMENT_ALREADY_PAID`: 이미 결제되었습니다.\\ `"INVALID_REQUEST"`, `"TAX_FREE_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_TOTAL_AMOUNT"`, `"PAYMENT_ALREADY_PAID"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\ `"UNAUTHORIZED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="403 권한 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\ `"PERMISSION_DENIED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 하위 상점이나 결제 채널을 찾을 수 없습니다." %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\ `CHANNEL_NOT_FOUND`: 결제 채널을 찾을 수 없습니다.\\ `"STORE_NOT_FOUND"`, `"CHANNEL_NOT_FOUND"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 에러" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="Address" %} **`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` *** {% endtab %} {% tab title="Bank" %} 은행 `"BANK_OF_KOREA"`, `"KOREA_DEVELOPMENT_BANK"`, `"INDUSTRIAL_BANK_OF_KOREA"`, `"KOOKMIN_BANK"`, `"SUHYUP_BANK"`, `"EXPORT_IMPORT_BANK_OF_KOREA"`, `"NH_NONGHYUP_BANK"`, `"LOCAL_NONGHYUP"`, `"WOORI_BANK"`, `"SC_BANK_KOREA"`, `"CITI_BANK_KOREA"`, `"DAEGU_BANK"`, `"BUSAN_BANK"`, `"GWANGJU_BANK"`, `"JEJU_BANK"`, `"JEONBUK_BANK"`, `"KYONGNAM_BANK"`, `"KFCC"`, `"SHINHYUP"`, `"SAVINGS_BANK_KOREA"`, `"MORGAN_STANLEY_BANK"`, `"HSBC_BANK"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN_CHASE_BANK"`, `"MIZUHO_BANK"`, `"MUFG_BANK"`, `"BANK_OF_AMERICA_BANK"`, `"BNP_PARIBAS_BANK"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"NATIONAL_FORESTRY_COOPERATIVE_FEDERATION"`, `"UNITED_OVERSEAS_BANK"`, `"BANK_OF_COMMUNICATIONS"`, `"CHINA_CONSTRUCTION_BANK"`, `"EPOST"`, `"KODIT"`, `"KIBO"`, `"HANA_BANK"`, `"SHINHAN_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`, `"KCIS"`, `"DAISHIN_SAVINGS_BANK"`, `"SBI_SAVINGS_BANK"`, `"HK_SAVINGS_BANK"`, `"WELCOME_SAVINGS_BANK"`, `"SHINHAN_SAVINGS_BANK"`, `"KYOBO_SECURITIES"`, `"DAISHIN_SECURITIES"`, `"MERITZ_SECURITIES"`, `"MIRAE_ASSET_SECURITIES"`, `"BOOKOOK_SECURITIES"`, `"SAMSUNG_SECURITIES"`, `"SHINYOUNG_SECURITIES"`, `"SHINHAN_FINANCIAL_INVESTMENT"`, `"YUANTA_SECURITIES"`, `"EUGENE_INVESTMENT_SECURITIES"`, `"KAKAO_PAY_SECURITIES"`, `"TOSS_SECURITIES"`, `"KOREA_FOSS_SECURITIES"`, `"HANA_FINANCIAL_INVESTMENT"`, `"HI_INVESTMENT_SECURITIES"`, `"KOREA_INVESTMENT_SECURITIES"`, `"HANWHA_INVESTMENT_SECURITIES"`, `"HYUNDAI_MOTOR_SECURITIES"`, `"DB_FINANCIAL_INVESTMENT"`, `"KB_SECURITIES"`, `"KTB_INVESTMENT_SECURITIES"`, `"NH_INVESTMENT_SECURITIES"`, `"SK_SECURITIES"`, `"SGI"`, `"KIWOOM_SECURITIES"`, `"EBEST_INVESTMENT_SECURITIES"`, `"CAPE_INVESTMENT_CERTIFICATE"` {% endtab %} {% tab title="CardCredential" %} **`card_number`** **\*** **string** *** **`expiry_month`** **\*** **string** *** **`expiry_year`** **\*** **string** *** **`birth_or_business_registration_number`** **\*** **string** *** **`password_two_digits`** **\*** **string** *** {% endtab %} {% tab title="cash\_receipt\_type\_CashReceiptType" %} 현금영수증 용도. personal = 소득공제용, corporate = 지출증빙용, anonymous = 국세청번호 자동발급 케이스 `"PERSONAL"`, `"CORPORATE"`, `"ANONYMOUS"` {% endtab %} {% endtabs %} {% tabs %} {% tab title="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"` {% endtab %} {% tab title="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"` {% endtab %} {% tab title="CustomerForm" %} **`customer_id`** **string** 가맹점의 고객 고유 ID - 값을 넣지 않으면 PortOne에서 자체 채번합니다. *** **`phone_number`** **string** 휴대폰 번호 *** **`customer_name`** **CustomerName** 고객 이름 정보. full\_name만 채워져 있거나, first\_name & last\_name이 채워져 있어야 함

CustomerName

**`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** ***

*** **`email`** **string** 고객 이메일 *** **`zipcode`** **string** 우편번호 *** **`address`** **Address** 주소 형식

Address

**`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` ***

*** **`gender`** **gender\_Gender** 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` *** **`birth_year`** **string** 출생연도 *** **`birth_month`** **string** 출생월 *** **`birth_day`** **string** 출생일 *** **`country`** **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"` *** {% endtab %} {% tab title="CustomerName" %} **`full_name`** **string** *** **`first_name`** **string** *** **`last_name`** **string** *** {% endtab %} {% endtabs %} {% tabs %} {% tab title="gender\_Gender" %} 성별 `"MALE"`, `"FEMALE"`, `"OTHER"` {% endtab %} {% tab title="InstantCardForm" %} **`card_credential`** **\*** **CardCredential** 카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보

CardCredential

**`card_number`** **\*** **string** *** **`expiry_month`** **\*** **string** *** **`expiry_year`** **\*** **string** *** **`birth_or_business_registration_number`** **\*** **string** *** **`password_two_digits`** **\*** **string** ***

*** **`cvc`** **string** *** **`vbv`** **VBV** 3DS 인증 결과를 담는 객체 (Verified by Visa)

VBV

**`cavv`** **\*** **string** *** **`xid`** **\*** **string** *** **`eci`** **\*** **string** ***

*** **`card_installment_plan`** **integer** 카드 할부 개월 수 *** **`use_free_installment_plan`** **boolean** 무이자 할부 적용 여부 *** **`use_free_interest_from_mall`** **boolean** *** {% endtab %} {% tab title="InstantPaymentMethodForm" %} **`card`** **InstantCardForm** 카드를 이용한 결제 & 빌링키 발급 시에 필요한 카드 관련 정보

InstantCardForm

**`card_credential`** **\*** **CardCredential** 카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보 *** **`cvc`** **string** *** **`vbv`** **VBV** 3DS 인증 결과를 담는 객체 (Verified by Visa) *** **`card_installment_plan`** **integer** 카드 할부 개월 수 *** **`use_free_installment_plan`** **boolean** 무이자 할부 적용 여부 *** **`use_free_interest_from_mall`** **boolean** ***

*** **`virtual_account`** **InstantVirtualAccountForm** 가상계좌 발급을 위해 필요한 가상계좌 발급 관련 정보

InstantVirtualAccountForm

**`bank`** **\*** **Bank** 은행 `"BANK_OF_KOREA"`, `"KOREA_DEVELOPMENT_BANK"`, `"INDUSTRIAL_BANK_OF_KOREA"`, `"KOOKMIN_BANK"`, `"SUHYUP_BANK"`, `"EXPORT_IMPORT_BANK_OF_KOREA"`, `"NH_NONGHYUP_BANK"`, `"LOCAL_NONGHYUP"`, `"WOORI_BANK"`, `"SC_BANK_KOREA"`, `"CITI_BANK_KOREA"`, `"DAEGU_BANK"`, `"BUSAN_BANK"`, `"GWANGJU_BANK"`, `"JEJU_BANK"`, `"JEONBUK_BANK"`, `"KYONGNAM_BANK"`, `"KFCC"`, `"SHINHYUP"`, `"SAVINGS_BANK_KOREA"`, `"MORGAN_STANLEY_BANK"`, `"HSBC_BANK"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN_CHASE_BANK"`, `"MIZUHO_BANK"`, `"MUFG_BANK"`, `"BANK_OF_AMERICA_BANK"`, `"BNP_PARIBAS_BANK"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"NATIONAL_FORESTRY_COOPERATIVE_FEDERATION"`, `"UNITED_OVERSEAS_BANK"`, `"BANK_OF_COMMUNICATIONS"`, `"CHINA_CONSTRUCTION_BANK"`, `"EPOST"`, `"KODIT"`, `"KIBO"`, `"HANA_BANK"`, `"SHINHAN_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`, `"KCIS"`, `"DAISHIN_SAVINGS_BANK"`, `"SBI_SAVINGS_BANK"`, `"HK_SAVINGS_BANK"`, `"WELCOME_SAVINGS_BANK"`, `"SHINHAN_SAVINGS_BANK"`, `"KYOBO_SECURITIES"`, `"DAISHIN_SECURITIES"`, `"MERITZ_SECURITIES"`, `"MIRAE_ASSET_SECURITIES"`, `"BOOKOOK_SECURITIES"`, `"SAMSUNG_SECURITIES"`, `"SHINYOUNG_SECURITIES"`, `"SHINHAN_FINANCIAL_INVESTMENT"`, `"YUANTA_SECURITIES"`, `"EUGENE_INVESTMENT_SECURITIES"`, `"KAKAO_PAY_SECURITIES"`, `"TOSS_SECURITIES"`, `"KOREA_FOSS_SECURITIES"`, `"HANA_FINANCIAL_INVESTMENT"`, `"HI_INVESTMENT_SECURITIES"`, `"KOREA_INVESTMENT_SECURITIES"`, `"HANWHA_INVESTMENT_SECURITIES"`, `"HYUNDAI_MOTOR_SECURITIES"`, `"DB_FINANCIAL_INVESTMENT"`, `"KB_SECURITIES"`, `"KTB_INVESTMENT_SECURITIES"`, `"NH_INVESTMENT_SECURITIES"`, `"SK_SECURITIES"`, `"SGI"`, `"KIWOOM_SECURITIES"`, `"EBEST_INVESTMENT_SECURITIES"`, `"CAPE_INVESTMENT_CERTIFICATE"` *** **`account_expiry`** **\*** **object** valid\_hours와 due\_date 둘 중 하나의 값만 채워야 함 *** **`account_type`** **\*** **virtual\_account\_type\_VirtualAccountType** 가상계좌 유형(일반 or 고정) `"NORMAL"`, `"FIXED"` *** **`pg_account_id`** **string** 고정식 가상계좌 방식에서, 가맹점이 가상계좌 번호를 관리하지 않고 PG사가 pg\_account\_id에 매핑되는 가상계좌 번호를 내려줄 때 사용하는 필드입니다. 동일한 pg\_account\_id로 가상계좌 발급 요청시에는 항상 같은 가상계좌 번호가 내려옵니다. account\_type이 FIXED일 때만 유효하며, account\_number 필드와 함께 사용할 수 없습니다. *** **`account_number`** **string** 고정식 가상계좌 방식에서, PG사로부터 일정 갯수의 가상계좌 번호를 미리 전달받았을 때 사용하는 필드입니다. 가맹점으로부터 전달받은 가상계좌 번호를 직접 입력하면 됩니다. account\_type이 FIXED일 때만 유효하며, pg\_account\_id 필드와 함께 사용할 수 없습니다. *** **`cash_receipt_form`** **object** 현금영수증 발급을 위해 필요한 정보 *** **`remittee_name`** **string** 예금주명 ***

*** {% endtab %} {% tab title="InstantVirtualAccountForm" %} **`bank`** **\*** **Bank** 은행 `"BANK_OF_KOREA"`, `"KOREA_DEVELOPMENT_BANK"`, `"INDUSTRIAL_BANK_OF_KOREA"`, `"KOOKMIN_BANK"`, `"SUHYUP_BANK"`, `"EXPORT_IMPORT_BANK_OF_KOREA"`, `"NH_NONGHYUP_BANK"`, `"LOCAL_NONGHYUP"`, `"WOORI_BANK"`, `"SC_BANK_KOREA"`, `"CITI_BANK_KOREA"`, `"DAEGU_BANK"`, `"BUSAN_BANK"`, `"GWANGJU_BANK"`, `"JEJU_BANK"`, `"JEONBUK_BANK"`, `"KYONGNAM_BANK"`, `"KFCC"`, `"SHINHYUP"`, `"SAVINGS_BANK_KOREA"`, `"MORGAN_STANLEY_BANK"`, `"HSBC_BANK"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN_CHASE_BANK"`, `"MIZUHO_BANK"`, `"MUFG_BANK"`, `"BANK_OF_AMERICA_BANK"`, `"BNP_PARIBAS_BANK"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"NATIONAL_FORESTRY_COOPERATIVE_FEDERATION"`, `"UNITED_OVERSEAS_BANK"`, `"BANK_OF_COMMUNICATIONS"`, `"CHINA_CONSTRUCTION_BANK"`, `"EPOST"`, `"KODIT"`, `"KIBO"`, `"HANA_BANK"`, `"SHINHAN_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`, `"KCIS"`, `"DAISHIN_SAVINGS_BANK"`, `"SBI_SAVINGS_BANK"`, `"HK_SAVINGS_BANK"`, `"WELCOME_SAVINGS_BANK"`, `"SHINHAN_SAVINGS_BANK"`, `"KYOBO_SECURITIES"`, `"DAISHIN_SECURITIES"`, `"MERITZ_SECURITIES"`, `"MIRAE_ASSET_SECURITIES"`, `"BOOKOOK_SECURITIES"`, `"SAMSUNG_SECURITIES"`, `"SHINYOUNG_SECURITIES"`, `"SHINHAN_FINANCIAL_INVESTMENT"`, `"YUANTA_SECURITIES"`, `"EUGENE_INVESTMENT_SECURITIES"`, `"KAKAO_PAY_SECURITIES"`, `"TOSS_SECURITIES"`, `"KOREA_FOSS_SECURITIES"`, `"HANA_FINANCIAL_INVESTMENT"`, `"HI_INVESTMENT_SECURITIES"`, `"KOREA_INVESTMENT_SECURITIES"`, `"HANWHA_INVESTMENT_SECURITIES"`, `"HYUNDAI_MOTOR_SECURITIES"`, `"DB_FINANCIAL_INVESTMENT"`, `"KB_SECURITIES"`, `"KTB_INVESTMENT_SECURITIES"`, `"NH_INVESTMENT_SECURITIES"`, `"SK_SECURITIES"`, `"SGI"`, `"KIWOOM_SECURITIES"`, `"EBEST_INVESTMENT_SECURITIES"`, `"CAPE_INVESTMENT_CERTIFICATE"` *** **`account_expiry`** **\*** **object** valid\_hours와 due\_date 둘 중 하나의 값만 채워야 함

account_expiry

**`valid_hours`** **integer** *** **`due_date`** **string** ***

*** **`account_type`** **\*** **virtual\_account\_type\_VirtualAccountType** 가상계좌 유형(일반 or 고정) `"NORMAL"`, `"FIXED"` *** **`pg_account_id`** **string** 고정식 가상계좌 방식에서, 가맹점이 가상계좌 번호를 관리하지 않고 PG사가 pg\_account\_id에 매핑되는 가상계좌 번호를 내려줄 때 사용하는 필드입니다. 동일한 pg\_account\_id로 가상계좌 발급 요청시에는 항상 같은 가상계좌 번호가 내려옵니다. account\_type이 FIXED일 때만 유효하며, account\_number 필드와 함께 사용할 수 없습니다. *** **`account_number`** **string** 고정식 가상계좌 방식에서, PG사로부터 일정 갯수의 가상계좌 번호를 미리 전달받았을 때 사용하는 필드입니다. 가맹점으로부터 전달받은 가상계좌 번호를 직접 입력하면 됩니다. account\_type이 FIXED일 때만 유효하며, pg\_account\_id 필드와 함께 사용할 수 없습니다. *** **`cash_receipt_form`** **object** 현금영수증 발급을 위해 필요한 정보

cash_receipt_form

**`receipt_type`** **\*** **cash\_receipt\_type\_CashReceiptType** 현금영수증 용도. personal = 소득공제용, corporate = 지출증빙용, anonymous = 국세청번호 자동발급 케이스 `"PERSONAL"`, `"CORPORATE"`, `"ANONYMOUS"` *** **`registration_number`** **\*** **string** 현금영수증 신청 번호 *** **`business_number`** **string** 현금영수증을 발급할 사업자등록번호 ***

*** **`remittee_name`** **string** 예금주명 *** {% endtab %} {% endtabs %} {% tabs %} {% tab title="product\_Product" %} **`id`** **\*** **string** *** **`name`** **\*** **string** *** **`tag`** **string** *** **`code`** **string** *** **`quantity`** **\*** **integer** *** **`amount`** **\*** **number** *** **`currency`** **\*** **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"` *** {% endtab %} {% tab title="ProductType" %} 상품 유형 `"REAL"`, `"DIGITAL"` {% endtab %} {% tab title="VBV" %} **`cavv`** **\*** **string** *** **`xid`** **\*** **string** *** **`eci`** **\*** **string** *** {% endtab %} {% tab title="virtual\_account\_type\_VirtualAccountType" %} 가상계좌 유형(일반 or 고정) `"NORMAL"`, `"FIXED"` {% endtab %} {% endtabs %} ## ⌨ 에스크로 배송정보 등록/변경 ## 에스크로 배송정보 등록/변경 `POST` `https://api.portone.io/v2/payments/{payment_id}/escrow/logis` #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Request Body | Name | Type | Description | | ------------------------------------------------- | -------------- | ----------- | | store\_id | string | | | sender\* | EscrowSender | | | receiver\* | EscrowReceiver | | | logistics\_form\* | LogisticsForm | | {% tabs %} {% tab title="200 에스크로 배송정보 등록/변경 성공" %} {% tabs %} {% tab title="Response" %} **`company`** **\*** **string** *** **`invoice_number`** **\*** **string** *** **`sent_at`** **\*** **string** *** **`applied_at`** **\*** **string** *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 잘못된 요청" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\ `NOT_PAID`: 지불되지 않은 결제 건입니다.\\ `"INVALID_REQUEST"`, `"NOT_PAID"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\ `"UNAUTHORIZED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="403 권한 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\ `"PERMISSION_DENIED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 하위 상점을 찾을 수 없습니다." %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\ `PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\\ `"STORE_NOT_FOUND"`, `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 에러" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="Address" %} **`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` *** {% endtab %} {% tab title="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"` {% endtab %} {% tab title="EscrowReceiver" %} **`name`** **string** *** **`phone_number`** **string** *** **`post_code`** **string** *** **`address`** **Address** 주소 형식

Address

**`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` ***

*** {% endtab %} {% tab title="EscrowSender" %} **`name`** **string** *** **`phone_number`** **string** *** **`post_code`** **string** *** **`relationship`** **string** *** **`address`** **Address** 주소 형식

Address

**`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` ***

*** {% endtab %} {% endtabs %} {% tabs %} {% tab title="LogisticsForm" %} **`company`** **\*** **string** `"HYUNDAI"`, `"HANARO"`, `"SAGAWA"`, `"KGB"`, `"YELLOWCAP"`, `"DONGBU"`, `"EPOST"`, `"CJGLS"`, `"HANJIN"`, `"DAESIN"`, `"ETC"`, `"ILYANG"`, `"KYONGDONG"`, `"CHUNIL"` *** **`invoice_number`** **\*** **string** *** **`sent_at`** **\*** **string** *** **`received_at`** **string** *** **`address`** **Address** 주소 형식

Address

**`address_line_1`** **\*** **string** 주소1 *** **`address_line_2`** **\*** **string** 주소2 *** **`city`** **string** 도시 *** **`province`** **string** 주, 도, 시 *** **`country`** **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"` ***

*** {% endtab %} {% endtabs %} ## ⌨ 에스크로 구매완료 ## 에스크로 구매완료 `POST` `https://api.portone.io/v2/payments/{payment_id}/escrow/complete` #### Path Parameters | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | payment\_id\* | string | 결제 ID | #### Request Body | Name | Type | Description | | ----------- | ------- | ----------- | | store\_id | string | | | from\_store | boolean | | {% tabs %} {% tab title="200 에스크로 구매완료 처리 성공" %} {% tabs %} {% tab title="Response" %} **`completed_at`** **\*** **string** *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="400 잘못된 요청" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\ `NOT_PAID`: 지불되지 않은 결제 건입니다.\\ `"INVALID_REQUEST"`, `"NOT_PAID"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="401 인증 실패" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\ `"UNAUTHORIZED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="403 권한 없음" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\ `"PERMISSION_DENIED"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="404 하위 상점을 찾을 수 없습니다." %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\ `PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\\ `"STORE_NOT_FOUND"`, `"PAYMENT_NOT_FOUND"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% tab title="500 내부 서버 에러" %} {% tabs %} {% tab title="Response" %} **`code`** **\*** **string** `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"` *** **`params`** **object** 에러 상세 정보를 담은 파라미터 모음 *** {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://portone.gitbook.io/docs/api-v2/payment.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.