결제 관련 API

GET https://api.portone.io/v2/payments/{payment_id}

결제내역 단건조회

결제가 발생한 이후 즉시 조회가 가능한 API입니다.

Parameters

Path

payment_id*

string

결제 ID

Query

store_id

string

하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.

Responses

200

200 응답

payment * Payment

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

404

리소스를 찾을 수 없음

code * string

"PAYMENT_NOT_FOUND"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR"

params object

에러 세부사항

GET https://api.portone.io/v2/payments

결제내역 다건조회

결제내역들을 조회할 수 있는 API입니다. 실제 결제 발생 이후 조회되기까지 지연이 있으니 검증을 위해서는

결제내역 단건조회

를 이용해주세요. 현재 page * limit이 50000 이상이 되는 쿼리를 허용하지 않는 제약을 갖고있습니다. 많은 양의 데이터를 받아올 경우 날짜범위를 좁혀서 사용해주세요. 추후 50000개 이상 대량의 데이터를 한번에 편리하게 쿼리할 수 있도록 하는 수정이 예정되어있습니다.

Parameters

Query

store_id

string

하위 상점 ID - Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제건을 조회합니다.

timestamp_type

string

어떤 시각을 기준으로 조회를 할 것인지 선택합니다.

REQUESTED_AT: 결제 요청 시각을 기준으로 조회합니다.
STATUS_UPDATED_AT: 상태 승인 시각을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다.
- ready -> 결제 요청 시각 기준
- paid -> 결제 완료 시각 기준
- cancelled -> 결제 취소 시각 기준
- failed -> 결제 실패 시각 기준

값을 넣지 않으면 STATUS_UPDATED_AT 으로 자동 적용됩니다.

start

string

결제 요청/상태 승인 시각 범위의 시작 - 값을 넣지 않으면 end의 90일 전으로 설정됩니다.

end

string

결제 요청/상태 승인 시각 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.

status

array

결제상태 리스트 - 값을 넣지 않으면 결제상태 필터링이 적용되지 않습니다.

methods

array

결제수단 리스트 - 값을 넣지 않으면 결제수단 필터링이 적용되지 않습니다.

pg_providers

array

결제대행사 리스트 - 값을 넣지 않으면 결제대행사 필터링이 적용되지 않습니다.

is_test_payment

boolean

테스트결제 필터링

is_scheduled_payment

boolean

정기결제 필터링

text_search_column

string

통합검색 항목

text_search_value

string

통합검색 입력값

page

integer

페이지 - 0부터 시작합니다.

limit

integer

페이지 크기 (최대 1000까지 허용)

sort_by*

string

정렬 기준

REQUESTED_AT

: 결제요청시각

STATUS_UPDATED_AT

: 상태변경시각

sort_order*

string

정렬 방향

DESCENDING

: 내림차순

ASCENDING

: 오름차순

Responses

200

200 응답

current_page * integer

total_page * integer

total_count * integer

payments * Array[Payment]

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR"

params object

에러 세부사항

GET https://api.portone.io/v2/payments/scroll

결제내역 대용량 다건조회

Payment의 생성일시를 기준으로 모든 결제내역들을 조회할 수 있는 결제내역 대용량 다건조회 API입니다.

Parameters

Query

store_id

string

하위 상점 ID - Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제건을 조회합니다.

start

string

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

end

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

end

string

Payment 생성시각 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.

cursor

string

결제내역 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.

limit

integer

페이지 크기 (최대 1000까지 허용)

Responses

200

200 응답

payments * Array[Payment]

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

cursor string

결제내역 리스트 중 어디까지 읽었는지를 나타냅니다.

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR"

params object

에러 세부사항

POST https://api.portone.io/v2/payments/{payment_id}/cancel

결제 취소

Parameters

Path

payment_id*

string

결제 ID

Query

store_id

string

하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.

Body

reason

string

취소 사유

cancel_amount

integer

취소 금액 - 값을 넣지 않으면 전액 취소됩니다.

tax_free_amount

integer

취소 금액 중 면세 금액 - 값을 넣지 않으면 전액 과세됩니다.

vat_amount

integer

취소 금액 중 부가세 금액 (PG사 기본값: null). 결제 시 부가세를 지정했던 경우 필수 입력 바랍니다. 지원되는 PG사: 나이스페이먼츠(NICE), 이니시스(HTML5_INICIS), 웰컴페이먼츠(WELCOME)

check_refundable_amount

integer

결제 건의 취소 가능 잔액 - 값을 넣지 않으면 별도의 검증 처리를 수행하지 않습니다.

refund

RefundAccount

환불 계좌 정보 - 가상계좌 결제인 경우에만 기입할 수 있습니다.

Responses

200

200 응답

cancelled_tx_id * string

취소 대상 거래 아이디

cancellation_id * string

취소 아이디

payment * Payment

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

400

400 에러 응답

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

에러 세부사항

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

404

리소스를 찾을 수 없음

code * string

"PAYMENT_NOT_FOUND"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 세부사항

POST https://api.portone.io/v2/payments/{payment_id}/resend-webhook

웹훅 재발송

tx_id

와

webhook_id

모두 값을 넣지 않으면 대표 트랜잭션의 가장 최근 웹훅 발송 이력을 기준으로 재전송됩니다.

Parameters

Path

payment_id*

string

결제 ID

Query

store_id

string

하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.

Body

tx_id

string

재발송 대상 트랜잭션 아이디 - 값을 넣지 않으면 기본값은 대표 트랜잭션 아이디로 설정됩니다.

webhook_id

string

재발송 대상 웹훅 아이디 - 값을 넣지 않으면 기본값은 가장 최근의 웹훅 아이디로 설정됩니다.

Responses

200

200 응답

tx_id * string

재발송 대상 트랜잭션 아이디

webhook_id string

재발송 대상 웹훅 아이디 (값을 넣지 않으면 가장 최근의 웹훅 아이디 기준으로 재전송) 비동기 웹훅이거나 웹훅 처리에 너무 오랜 시간이 걸리는 경우 값이 비어있을 수 있습니다.

payment * Payment

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

404

리소스를 찾을 수 없음

code * string

"PAYMENT_NOT_FOUND"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR", "WEBHOOK_ERROR"

params object

에러 세부사항

POST https://api.portone.io/v2/test-payments/{payment_id}/notice-virtual-account-deposit

가상계좌 테스트 웹훅 호출

가상계좌 테스트 결제 건에 대한 입금 통보 웹훅을 호출합니다.

Parameters

Path

payment_id*

string

결제 ID

Query

store_id

string

하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.

Responses

200

200 응답

tx_id * string

웹훅 기준 트랜잭션 ID

webhook_id string

재발송 대상 웹훅 아이디 (값을 넣지 않으면 가장 최근의 웹훅 아이디 기준으로 재전송) 비동기 웹훅이거나 웹훅 처리에 너무 오랜 시간이 걸리는 경우 값이 비어있을 수 있습니다.

payment * Payment

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

400

400 에러 응답

code * string

"INVALID_REQUEST"

params object

에러 세부사항

401

인증 실패

code * string

"UNAUTHORIZED"

params object

에러 세부사항

404

리소스를 찾을 수 없음

code * string

"PAYMENT_NOT_FOUND"

params object

에러 세부사항

500

내부 서버 오류

code * string

"PORTONE_ERROR"

params object

에러 세부사항

POST https://api.portone.io/v2/schedules

결제 예약

Parameters

Body

billing_key*

string

빌링키 결제에 사용할 빌링키

store_id

string

빌링키 결제를 진행하는 상점의 id

order_name*

string

주문명

is_cultural_expense

boolean

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

is_escrow

boolean

에스크로 여부 (기본값:"false")

products

Array[Product]

상품 정보 (에스크로 결제 상품 정보)

customer

CustomerFormWithoutId

고객 정보

custom_data

string

고객사에서 추가로 저장할 데이터

total_amount*

number

결제 금액

tax_free_amount

number

면세 금액 (기본값:

"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

Responses

200

결제 예약 성공

id * string

scheduled_at * string

400

잘못된 요청

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

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

하위 상점이나 빌링키를 찾을 수 없습니다.

code * string

STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
BILLING_KEY_NOT_FOUND: 빌링키를 찾을 수 없습니다.\

"STORE_NOT_FOUND", "BILLING_KEY_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

POST https://api.portone.io/v2/payments/{payment_id}/billing-key/pay

빌링키 결제

Parameters

Path

payment_id*

string

결제 ID

Body

billing_key*

string

빌링키 결제에 사용할 빌링키

store_id

string

빌링키 결제를 진행하는 상점의 id

order_name*

string

주문명

is_cultural_expense

boolean

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

is_escrow

boolean

에스크로 여부 (기본값: "false")

products

Array[product_Product]

상품 정보 (에스크로 결제 상품 정보)

customer

CustomerFormWithoutId

고객 정보

custom_data

string

고객사에서 추가로 저장할 데이터

total_amount*

number

결제 금액

tax_free_amount

number

면세 금액 (기본값: "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사 별로 필요한 파라미터를 받습니다.

Responses

200

빌링키 결제 성공

tx_id * string

customer_id * string

requested_at * string

paid_at * string

pg_tx_id * string

PG사 거래ID

400

잘못된 요청

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

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

하위 상점이나 빌링키를 찾을 수 없습니다.

code * string

STORE_NOT_FOUND: 하위_상점을_찾을_수_없습니다.
BILLING_KEY_NOT_FOUND: 빌링키를 찾을 수 없습니다.\

"STORE_NOT_FOUND", "BILLING_KEY_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

POST https://api.portone.io/v2/payments/{payment_id}/instant/pay

키인(수기) 결제 / 가상계좌 발급

Parameters

Path

payment_id*

string

Body

store_id

string

하위 상점 ID

order_name*

string

is_cultural_expense

boolean

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

is_escrow

boolean

에스크로 여부 (기본값: "false")

products

Array[product_Product]

상품 정보. 아래 두 가지 목적으로 사용함.

customer

CustomerForm

고객 정보

custom_data

string

total_amount*

number

결제 금액

tax_free_amount

number

면세 금액 (기본값: "0")

country

country_Country

국가

currency*

currency_Currency

화폐

notice_urls

Array[string]

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다.

channel_key*

string

결제 채널 키

product_type

ProductType

상품 유형

product_count

integer

상품 개수

payment_method_option*

InstantPaymentMethodForm

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

card

와

virtual_account

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

Responses

200

성공

tx_id * string

customer_id * string

requested_at * string

paid_at * string

pg_tx_id * string

PG사 거래ID

400

잘못된 요청

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

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

하위 상점이나 결제 채널을 찾을 수 없습니다.

code * string

STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
CHANNEL_NOT_FOUND: 결제 채널을 찾을 수 없습니다.\

"STORE_NOT_FOUND", "CHANNEL_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

POST https://api.portone.io/v2/payments/{payment_id}/escrow/logis

에스크로 배송정보 등록/변경

Parameters

Path

payment_id*

string

결제 ID

Body

store_id

string

sender*

EscrowSender

receiver*

EscrowReceiver

logistics_form*

LogisticsForm

send_email*

boolean

에스크로 구매 확정시 결제 창에 입력했던 이메일로 해당 사실을 전송할지 여부. 지원 PG: (신)나이스페이먼츠

Responses

200

에스크로 배송정보 등록/변경 성공

company * string

invoice_number * string

sent_at * string

applied_at * string

400

잘못된 요청

code * string

INVALID_REQUEST: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.
NOT_PAID: 지불되지 않은 결제 건입니다.\

"INVALID_REQUEST", "NOT_PAID"

params object

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

하위 상점을 찾을 수 없습니다.

code * string

STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
PAYMENT_NOT_FOUND: 해당하는 결제를 찾을 수 없습니다.\

"STORE_NOT_FOUND", "PAYMENT_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

POST https://api.portone.io/v2/payments/{payment_id}/escrow/complete

에스크로 구매완료

Parameters

Path

payment_id*

string

결제 ID

Body

store_id

string

from_store

boolean

Responses

200

에스크로 구매완료 처리 성공

completed_at * string

400

잘못된 요청

code * string

INVALID_REQUEST: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.
NOT_PAID: 지불되지 않은 결제 건입니다.\

"INVALID_REQUEST", "NOT_PAID"

params object

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

하위 상점을 찾을 수 없습니다.

code * string

STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
PAYMENT_NOT_FOUND: 해당하는 결제를 찾을 수 없습니다.\

"STORE_NOT_FOUND", "PAYMENT_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

DELETE https://api.portone.io/v2/payments/{payment_id}/virtual-account

가상계좌 말소

Parameters

Path

payment_id*

string

결제 ID

Query

store_id

string

하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.

200

가상계좌 말소 처리 성공

payment * Payment

결제내역

Payment

id * string

고객사에서 입력한 결제 ID

merchant_id * string

고객사 ID

store_id * string

하위 상점 ID

transactions * Array[Transaction]

동일한 payment_id로 결제시도된 결제내역들

type GiftCertificateType

"BOOKNLIFE", "SMART_MUNSANG", "CULTURELAND", "HAPPYMONEY"

approval_number * string

상품권 승인번호

id * string

포트원 채번 거래번호

is_primary * boolean

대표 트랜잭션 여부

version * Version

포트원 내부 결제시스템 버전

"V1", "V2"

method PaymentMethod

결제수단 목록

"CARD", "TRANSFER", "VIRTUAL_ACCOUNT", "MOBILE", "GIFT_CERTIFICATE", "EASY_PAY"

channel Channel

결제 채널 정보

Channel

id string

채널 ID

name string

채널 이름

key string

채널 키

type * ChannelType

채널 유형

"LIVE", "TEST"

pg_provider * PgProvider

결제대행사(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인 경우 제공됩니다.

400

잘못된 요청

code * string

INVALID_REQUEST: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.
NOT_PAID: 지불되지 않은 결제 건입니다.\

"INVALID_REQUEST", "NOT_PAID"

params object

에러 상세 정보를 담은 파라미터 모음

401

인증 실패

code * string

UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"

params object

에러 상세 정보를 담은 파라미터 모음

403

권한 없음

code * string

PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\

"PERMISSION_DENIED"

params object

에러 상세 정보를 담은 파라미터 모음

404

리소스를 찾을 수 없음

code * string

STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
PAYMENT_NOT_FOUND: 해당하는 결제를 찾을 수 없습니다.\

"STORE_NOT_FOUND", "PAYMENT_NOT_FOUND"

params object

에러 상세 정보를 담은 파라미터 모음

500

내부 서버 에러

code * string

"PORTONE_ERROR", "PG_PROVIDER_ERROR"

params object

에러 상세 정보를 담은 파라미터 모음

결제 관련 API

⌨ 결제내역 단건조회

Parameters

Path

Query

Responses

⌨ 결제내역 다건조회

Parameters

Query

Responses

⌨ 결제내역 대용량 다건조회

Parameters

Query

Responses

⌨ 결제 취소

Parameters

Path

Query

Body

Responses

⌨ 웹훅 재발송

Parameters

Path

Query

Body

Responses

⌨ 가상계좌 테스트 웹훅 호출

Parameters

Path

Query

Responses

⌨ 결제 예약

Parameters

Body

Responses

⌨ 빌링키 결제

Parameters

Path

Body

Responses

⌨ 키인(수기) 결제 / 가상계좌 발급

Parameters

Path

Body

Responses

⌨ 에스크로 배송정보 등록/변경

Parameters

Path

Body

Responses

⌨ 에스크로 구매완료

Parameters

Path

Body

Responses

- 가상계좌 말소

Parameters

Path

Query