* 자동 결제 API는 추가 계약 후 사용할 수 있습니다.
발급받은 <code>billingKey</code>로 카드 자동 결제 승인을 요청합니다.

카드 자동 결제 승인 요청

billingKey

금액

할부 개월 수 (기본 값은 일시불, 0)

고객 이메일 (없을 경우 빌링 등록 시 사용된 이메일 사용)

고객 키

고객 휴대폰 (없을 경우 무시됨)

고객 이름 (빌링 인증 했던 이름을 사용하지 않을 때 사용)

주문 번호

주문 정보

면세 금액 (기본 값은 0)

빌링 결제 요청 데이터

결제 승인 일시

결제 잔액

결제 취소 정보

카드 승인 정보

현금영수증 신청 정보

체크아웃

결제 국가

문화비 여부

통화 종류

즉시 할인 적용 정보

즉시 할인 금액 (Deprecated)

간편 결제로 결제 시 간편 결제 타입

간편 결제이며 계좌 결제 금액

간편 결제이며 포인트 결제 금액

실패 사유

해외간편결제 결제 승인 정보

상품권 결제 승인 정보

부분환불 가능여부

마지막 거래 키

상점 MID

결제 수단

휴대폰 결제 승인 정보

주문번호

주문명(상품명)

결제 키

영수증, 매출전표 정보

결제 요청 일시

콜백 검증 키

결제 상태

공급 가액

면세금액

총 금액

거래 키

계좌이체 승인 정보

결제 타입 (일반 결제, 빌링 결제, 커넥트페이 결제)

현금영수증 여부 (Deprecated)

즉시 할인 여부 (Deprecated)

에스크로 여부

부가세

응답 버전

가상계좌 발급 정보

결제 승인

paymentKey로 결제 조회

orderId로 결제 조회

결제 취소

카드 번호 결제

가상계좌 발급 요청

customerKey로 카드 자동 결제 빌링키 발급 요청

authKey로 카드 자동 결제 빌링키 발급 요청

거래 조회

정산 조회

수동 정산 요청

현금영수증 발급

현금영수증 발급 취소

현금영수증 조회

서브몰 등록

지급 가능한 잔액 조회

지급대행 요청

지급대행 단건 조회

지급대행 조회

카드사 혜택 조회

* 자동 결제 API는 추가 계약 후 사용할 수 있습니다.
고객을 특정하는 <code>customerKey</code>와 연결할 빌링키 발급을 요청합니다.

상점에서 고객을 구분하기 위해 발급한 고유 ID입니다. 이 값에 빌링키가 연결됩니다. 영문 대소문자, 숫자, 특수문자 
<code>-</code>
, 
<code>_</code>
, 
<code>=</code>
, 
<code>.</code>
, 
<code>@</code>
로 최소 2자 이상 최대 300자 이하여야 합니다.

customerKey

 카드 번호입니다. 최대 길이는 20자입니다.


cardNumber

cardExpirationYear

cardExpirationMonth

 카드 비밀번호 앞 두자리입니다.


cardPassword

카드 소유자 정보입니다. 생년월일 6자리(
<code>YYMMDD</code>
) 혹은 사업자등록번호 10자리가 들어갑니다.

customerIdentityNumber

 고객 이름입니다. 최대 길이는 100자입니다.


customerName

 고객의 이메일 주소입니다. 결제 결과를 알려줄 때 사용합니다. 최대 길이는 100자입니다.


customerEmail

해외 카드로 결제하는 경우 3DS 인증 적용을 위해 사용합니다. 
3DS 인증 결과를 전송해야 하는 경우에만 필수입니다.

* 자동 결제 API는 추가 계약 후 사용할 수 있습니다.
<a href="/reference/js-sdk#requestbillingauth%EC%B9%B4%EB%93%9C-%EA%B2%B0%EC%A0%9C-%EC%A0%95%EB%B3%B4">requestBillingAuth</a> 호출 후 <a href="/guides/windows/card-billing#%EB%A6%AC%EB%8B%A4%EC%9D%B4%EB%A0%89%ED%8A%B8-url-%ED%99%95%EC%9D%B8%ED%95%98%EA%B8%B0">쿼리 파라미터로 돌아오는</a> <code>authKey</code>, 고객 ID인 <code>customerKey</code>로 빌링키 발급을 요청합니다.
* 자동 결제 빌링키 발급 요청 엔드포인트가 <code>/v1/payments/{authKey}</code>에서 <code>/v1/billing/authorizations/issue</code>로 변경되었습니다. 이전 엔드포인트는 사용을 권장하지 않습니다.

 자동 결제 등록창 호출이 성공하면 리다이렉트 URL에 쿼리 파라미터(Query Parameter)로 포함되어 돌아오는 인증 키 값입니다.


authKey

상점에서 고객을 구분하기 위해 발급한 고객의 고유 ID입니다. 이 값에 빌링키가 연결됩니다. 영문 대소문자, 숫자, 특수문자 
<code>-</code>
, 
<code>_</code>
, 
<code>=</code>
, 
<code>.</code>
, 
<code>@</code>
로 최소 2자 이상 최대 300자 이하여야 합니다.

amount

 상점에서 주문 건을 구분하기 위해 발급한 고유 ID입니다. 영문 대소문자, 숫자, 특수문자(-, _)로 이루어진 6자 이상 64자 이하의 문자열이어야 합니다.


orderId

결제에 대한 주문명입니다. 예를 들면 
<code>생수 외 1건</code>
 같은 형식입니다. 최대 길이는 100자입니다.

orderName

customerMobilePhone

면세 금액입니다. 값을 넣지 않으면 기본값인 
<code>0</code>
으로 설정됩니다.

taxFreeAmount

할부 개월 수입니다. 값은 
<code>2</code>
부터 
<code>12</code>
까지 사용할 수 있습니다. 
<code>0</code>
이 들어가는 경우 할부가 아닌 일시불로 결제됩니다. 값을 넣지 않으면 일시불입니다.

cardInstallmentPlan

특정 기간 동안 발급된 현금영수증을 조회합니다.

주문 건에 대한 현금영수증 발급을 요청합니다.

 현금영수증을 발급할 금액입니다.


 현금영수증 발급에 필요한 개인 식별 번호입니다. 최대 길이는 30자입니다.


registrationNumber

현금영수증의 종류입니다. 
<code>소득공제</code>
, 
<code>지출증빙</code>
 중 하나의 값입니다.

type

<code>receiptKey</code>를 이용해서 현금영수증 발급을 취소합니다.
요청할 때 <code>amount</code> 값을 따로 보내지 않으면 전액 취소됩니다.

 현금영수증 발급을 취소할 금액입니다. 값이 따로 없으면 전액 취소됩니다.


<code>paymentKey</code>에 해당하는 결제를 검증하고 승인합니다.
* 결제 승인 엔드포인트가 <code>/v1/payments/{paymentKey}</code>에서 <code>/v1/payments/confirm</code>으로 변경되었습니다. 이전 엔드포인트는 사용을 권장하지 않습니다.

 결제 건에 대한 고유한 키값입니다. 최대 길이는 200자입니다.


paymentKey

* 카드 번호 결제 API는 추가 계약 후 사용할 수 있습니다.
결제할 카드 번호 및 기타 카드 정보로 결제를 요청합니다.

할부 개월 수입니다. 할부 개월을 직접 설정하기 위해 사용합니다. 값은 
<code>2</code>
부터 
<code>12</code>
까지 사용할 수 있습니다. 
<code>0</code>
이 들어가는 경우 할부가 아닌 일시불로 결제됩니다.

카드사 무이자 할부 적용 여부입니다. 기본값은 
<code>false</code>
 입니다.

useFreeInstallmentPlan

결제할 금액 중 면세 금액입니다. 값을 넣지 않으면 기본값인 
<code>0</code>
으로 설정됩니다.

승인된 결제를 <code>orderId</code>로 조회합니다.

승인된 결제를 <code>paymentKey</code>로 조회합니다.

승인된 결제를 <code>paymentKey</code>로 취소합니다.

 결제를 취소하는 이유입니다. 최대 길이는 200자입니다.


cancelReason

 취소할 금액입니다. 값이 없으면 전액 취소됩니다.


cancelAmount

결제 취소 후 금액이 환불될 계좌의 정보입니다. 
가상계좌 결제에 대해서만 필수입니다.
 다른 결제 수단으로 이루어진 결제를 취소할 때는 사용하지 않습니다.

refundReceiveAccount

취소할 금액 중 면세 금액입니다. 값을 넣지 않으면 기본값인 
<code>0</code>
으로 설정됩니다.

 현재 환불 가능한 금액입니다. 취소 요청을 안전하게 처리하기 위해서 사용합니다.


refundableAmount

* 서브몰 조회 API는 추가 계약 후 사용할 수 있습니다.
상점 하위에 등록되어 있는 서브몰을 조회합니다.

서브몰 조회

* 서브몰 등록 API는 추가 계약 후 사용할 수 있습니다.
상점 하위에 새로운 서브몰을 등록합니다.

 서브몰의 ID입니다. 최대 길이는 20자입니다.


subMallId

서브몰의 타입입니다. 
<code>CORPORATE</code>
(법인), 
<code>INDIVIDUAL</code>
(개인) 중 하나의 값을 넣어주세요.

서브몰의 상호명입니다. 
<code>type</code>
이 
<code>CORPORATE</code>
일 때 필수로 보내야 하는 파라미터입니다. 최대 길이는 60자입니다.

companyName

서브몰의 대표자명입니다. 
<code>type</code>
이 
<code>CORPORATE</code>
일 때 필수로 보내야 하는 파라미터입니다. 최대 길이는 40자입니다.

representativeName

서브몰의 사업자등록번호 입니다. 
<code>type</code>
이 
<code>CORPORATE</code>
일 때 필수로 보내야 하는 파라미터입니다. 길이는 10자입니다.

businessNumber

 서브몰에서 정산 금액을 지급받을 계좌 정보를 담은 객체입니다.


account

 서브몰과 관련된 추가 정보를 key-value 쌍으로 담고있는 객체입니다. 최대 50개의 key-value 쌍을 포함할 수 있습니다. key와 value 모두 문자열 형식이어야 합니다.


metadata

* 지급대행 조회 API는 추가 계약 후 사용할 수 있습니다.
지급대행 요청에서 사용한 <code>payoutDate</code>를 기준으로, 지정한 날짜 사이에 지급되었거나 지급될 예정인 지급대행 건을 조회합니다.

* 지급대행 요청 API는 추가 계약 후 사용할 수 있습니다.
여러 서브몰의 지급 정보를 배열로 보내서 지급대행을 요청합니다.

정산한 금액을 지급할 날짜 정보입니다. ISO 8601 형식인 
<code>yyyy-MM-dd</code>
입니다. (e.g. 
<code>2022-01-01</code>
)

payoutDate

payoutAmount

 지급대행으로 정산할 금액에 대한 세부 내용(적요)으로 서브몰 통장에 표기될 정보입니다. 최대 길이는 7자입니다.


transferSummary

 지급대행과 관련된 추가 정보를 key-value 쌍으로 담고있는 객체입니다. 최대 50개의 key-value 쌍을 포함할 수 있습니다. key와 value 모두 문자열 형식이어야 합니다.


* 지급 가능한 잔액 조회 API는 추가 계약 후 사용할 수 있습니다.
서브몰에 정산하기 전에 상점이 현재 지급할 수 있는 잔액을 먼저 조회합니다.

* 지급대행 단건 조회 API는 추가 계약 후 사용할 수 있습니다.
<code>payoutKey</code>를 Path 파라미터에 추가해서 조회하고 싶은 한 건의 지급 정보를 조회합니다.

* 서브몰 수정 API는 추가 계약 후 사용할 수 있습니다.
<code>submallId</code>에 해당하는 서브몰의 정보를 Request Body 파라미터 값으로 수정합니다.

 서브몰의 상호명입니다. 최대 길이는 60자입니다.


 서브몰의 대표자명입니다. 최대 길이는 40자입니다.


 서브몰의 사업자등록번호 입니다. 길이는 10자입니다.


 서브몰에서 정산 금액을 지급받을 계좌 정보를 담은 객체입니다. 최대 길이는 20자입니다.


 서브몰과 관련된 추가 정보를 담고 있는 객체입니다. key-value 쌍으로 이루어져 있습니다. 최대 50개의 key-value 쌍을 포함할 수 있습니다.


서브몰 수정

* 서브몰 삭제 API는 추가 계약 후 사용할 수 있습니다.
<code>submallId</code>에 해당하는 서브몰 정보를 삭제합니다.

서브몰 삭제

카드사별 할인 프로모션, 할부 혜택 정보를 조회합니다.

지정한 날짜 정보로 정산 기록을 조회합니다.

* 수동 정산 요청 API는 추가 계약 후 사용할 수 있습니다.
매입하고 싶은 결제 건을 <code>paymentKey</code>로 특정해서 카드사에 정산을 요청합니다.

 수동 정산을 요청할 결제 건을 특정하는 키 값 입니다. 최대 길이는 200자입니다.


지정한 날짜 정보로 거래 기록을 조회합니다.

구매자가 원하는 은행의 가상계좌 발급을 요청합니다.

결제에 대한 주문명입니다. 예를 들면 
<code>생수 외 1건</code>
 같은 형식입니다. 최대 길이는 100자입니다.
최소 1글자 이상 100글자 이하여야 합니다.

 입금할 고객 이름입니다. 최대 길이는 100자입니다.


가상계좌를 발급할 은행입니다. 가상계좌 발급이 가능한 
<a href="/guides/apis/virtual-account#%EA%B0%80%EC%83%81%EA%B3%84%EC%A2%8C-%EB%B0%9C%EA%B8%89%EC%9D%B4-%EC%A7%80%EC%9B%90%EB%90%98%EB%8A%94-%EC%9D%80%ED%96%89">은행 코드</a>
를 참고하세요.

bank

가상계좌 타입을 나타냅니다. 
<code>일반</code>
, 
<code>고정</code>
 중 하나입니다. 값이 없으면 일반 가상계좌로 발급됩니다.

accountType

 고정 가상계좌를 사용하는 고객과 매칭시킨 계좌의 고유한 키값으로, 특정 고객에게 같은 가상계좌를 발급할 때 사용됩니다. 최대 길이는 13자입니다.


accountKey

가상계좌가 유효한 시간을 의미합니다. 값을 넣지 않으면 기본값 
<code>168</code>
시간(7일)으로 설정됩니다. 설정할 수 있는 최대값은 
<code>720</code>
시간(30일)입니다.

validHours

입금 기한입니다. 현재 시간을 기준으로 
<code>720</code>
시간(30일) 이내의 특정 시점으로 입금 기한을 직접 설정하고 싶을 때 사용합니다. 
<code>720</code>
시간 이후로 기한을 설정하면 에러가 발생합니다.

dueDate

 가상계좌 웹훅 URL 주소입니다.


virtualAccountCallbackUrl

에스크로 사용 여부입니다. 값을 넣지 않으면 기본값인 
<code>false</code>
로 설정되고 사용자가 에스크로 결제 여부를 선택합니다.

useEscrow

 현금영수증 발급 정보를 담는 객체입니다.


cashReceipt

 각 상품에 대한 상세 정보를 담는 배열입니다.
예를 들어 사용자가 세 가지 종류의 상품을 구매했다면 길이가 3인 배열이어야 합니다. 에스크로 결제를 사용할 때만 필요한 파라미터입니다.


escrowProducts

결제할 때 사용할 통화 단위입니다. 값을 넣지 않으면 기본값은 
<code>KRW</code>
입니다. 원화인 
<code>KRW</code>
만 사용합니다.

API 테스트

카드 자동 결제 승인 요청

파라미터

Request Body 파라미터