개발자센터

빌링키 관련 API

빌링키와 관련된 API 기능을 제공합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
Address: OneLineAddress | SeparatedAddress
분리 형식 주소

oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.

Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행
BillingKeyAlreadyDeletedError: { type, message }
빌링키가 이미 삭제된 경우
BillingKeyAlreadyIssuedError: { type, message }
BillingKeyDeleteRequester: "CUSTOMER" | "ADMIN"
빌링키 삭제 요청 주체
BillingKeyFailure: { message, pgCode, pgMessage, ... }
발급 실패 상세 정보
BillingKeyFilterInput: { storeId, timeRangeField, from, ... }
빌링키 다건 조회를 위한 입력 정보
BillingKeyInfo: DeletedBillingKeyInfo | IssuedBillingKeyInfo
빌링키 정보
BillingKeyInfoSummary: { billingKey, channels, issuedAt }
BillingKeyNotFoundError: { type, message }
빌링키가 존재하지 않는 경우
BillingKeyNotIssuedError: { type, message }
BillingKeyPaymentMethod: BillingKeyPaymentMethodCard | BillingKeyPaymentMethodEasyPay | BillingKeyPaymentMethodMobile | ...
빌링키 발급 수단 정보
BillingKeyPaymentMethodCard: { type, card }
카드 정보
BillingKeyPaymentMethodEasyPay: { type, provider, method }
간편 결제 정보
BillingKeyPaymentMethodEasyPayCharge: { type }
충전식 포인트 결제 정보
BillingKeyPaymentMethodEasyPayMethod: BillingKeyPaymentMethodCard | BillingKeyPaymentMethodEasyPayCharge | BillingKeyPaymentMethodTransfer
간편 결제 수단
BillingKeyPaymentMethodMobile: { type, phoneNumber }
모바일 정보
BillingKeyPaymentMethodPaypal: { type }
페이팔 정보
BillingKeyPaymentMethodTransfer: { type, bank, accountNumber }
계좌이체 정보
BillingKeyPaymentMethodType: "CARD" | "MOBILE" | "EASY_PAY" | ...
빌링키 결제 수단
BillingKeySortBy: "REQUESTED_AT" | "ISSUED_AT" | "DELETED_AT" | ...
빌링키 정렬 기준
BillingKeySortInput: { by, order }
빌링키 다건 조회 시 정렬 조건
BillingKeyStatus: "ISSUED" | "DELETED"
빌링키 상태
BillingKeyTextSearch: { field, value }
통합검색 입력 정보
BillingKeyTextSearchField: "CARD_BIN" | "CARD_NUMBER" | "PG_MERCHANT_ID" | ...
통합검색 항목
BillingKeyTimeRangeField: "REQUESTED_AT" | "ISSUED_AT" | "DELETED_AT" | ...
빌링키 다건 조회 시, 시각 범위를 적용할 필드
Card: { publisher, issuer, brand, ... }
카드 상세 정보
CardBrand: "LOCAL" | "MASTER" | "UNIONPAY" | ...
카드 브랜드
CardCredential: { number, expiryYear, expiryMonth, ... }
카드 인증 관련 정보
CardOwnerType: "PERSONAL" | "CORPORATE"
카드 소유주 유형
CardType: "CREDIT" | "DEBIT" | "GIFT"
카드 유형
ChannelGroupSummary: { id, name, isForTest }
채널 그룹 정보
ChannelNotFoundError: { type, message }
요청된 채널이 존재하지 않는 경우
ChannelSpecificError: { type, message, failures, ... }
여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우
ChannelSpecificFailure: ChannelSpecificFailureInvalidRequest | ChannelSpecificFailurePgProvider
ChannelSpecificFailureInvalidRequest: { type, channel, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

ChannelSpecificFailurePgProvider: { type, channel, message, ... }
PG사에서 오류를 전달한 경우
ConfirmBillingKeyBody: { storeId, billingIssueToken, isTest, ... }
빌링키 발급 승인 입력 정보
ConfirmBillingKeyError: BillingKeyAlreadyIssuedError | BillingKeyNotFoundError | ForbiddenError | ...
ConfirmBillingKeyIssueAndPayBody: { storeId, billingIssueToken, paymentId, ... }
빌링키 발급 및 초회 결제 승인 입력 정보
ConfirmBillingKeyIssueAndPayError: BillingKeyAlreadyIssuedError | BillingKeyNotFoundError | ForbiddenError | ...
ConfirmedBillingKeyIssueAndPaySummary: { billingKey, paymentId }
빌링키 발급 및 초회 결제 수동 승인 완료 응답
ConfirmedBillingKeySummary: { billingKey }
빌링키 발급 수동 승인 완료 응답
Country: "AD" | "AE" | "AF" | ...
국가
Currency: "KRW" | "USD" | "JPY" | ...
통화
Customer: { id, name, birthYear, ... }
고객 정보
CustomerInput: { id, name, birthYear, ... }
고객 정보 입력 정보
CustomerNameInput: { full, separated }
고객 이름 입력 정보

두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.

CustomerSeparatedName: { first, last }
고객 분리형 이름
DeleteBillingKeyError: BillingKeyAlreadyDeletedError | BillingKeyNotFoundError | BillingKeyNotIssuedError | ...
DeleteBillingKeyResponse: { deletedAt }
빌링키 삭제 성공 응답
DeletedBillingKeyInfo: { status, billingKey, merchantId, ... }
빌링키 삭제 완료 상태 건
EasyPayProvider: "SAMSUNGPAY" | "KAKAOPAY" | "NAVERPAY" | ...
간편 결제사
FailedPgBillingKeyIssueResponse: { type, channel, failure }
빌링키 발급 실패 채널 응답
ForbiddenError: { type, message }
요청이 거절된 경우
Gender: "MALE" | "FEMALE" | "OTHER"
성별
GetBillingKeyInfoError: BillingKeyNotFoundError | ForbiddenError | InvalidRequestError | ...
GetBillingKeyInfosBody: { page, sort, filter }

빌링키 다건 조회를 위한 입력 정보

GetBillingKeyInfosError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetBillingKeyInfosResponse: { items, page }
빌링키 다건 조회 성공 응답 정보
InformationMismatchError: { type, message }
정보가 일치하지 않는 경우
InstantBillingKeyPaymentMethodInput: { card }
빌링키 발급 시 결제 수단 입력 양식

card를 반드시 입력해 주세요.

InstantBillingKeyPaymentMethodInputCard: { credential }
카드 수단 정보 입력 양식
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

IssueBillingKeyBody: { storeId, method, channelKey, ... }
빌링키 발급 요청 양식
IssueBillingKeyError: ChannelNotFoundError | ChannelSpecificError | ForbiddenError | ...
IssueBillingKeyResponse: { billingKeyInfo, channelSpecificFailures }
빌링키 발급 성공 응답
IssuedBillingKeyInfo: { status, billingKey, merchantId, ... }
빌링키 발급 완료 상태 건
IssuedPgBillingKeyIssueResponse: { type, channel, pgTxId, ... }
빌링키 발급 성공 채널 응답
OneLineAddress: { type, oneLine }
한 줄 형식 주소

한 줄 형식 주소만 존재합니다.

PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PaymentClientType: "SDK_MOBILE" | "SDK_PC" | "API"
결제가 발생한 클라이언트 환경
PaymentScheduleAlreadyExistsError: { type, message }
결제 예약건이 이미 존재하는 경우
PgBillingKeyIssueResponse: FailedPgBillingKeyIssueResponse | IssuedPgBillingKeyIssueResponse
채널 별 빌링키 발급 응답
PgCompany: "INICIS" | "NICE" | "KCP" | ...
PG사
PgProvider: "HTML5_INICIS" | "PAYPAL" | "PAYPAL_V2" | ...
PG사 결제 모듈
PgProviderError: { type, message, pgCode, ... }
PG사에서 오류를 전달한 경우
PortOneVersion: "V1" | "V2"
포트원 버전
SelectedChannel: { type, id, key, ... }
(결제, 본인인증 등에) 선택된 채널 정보
SelectedChannelType: "LIVE" | "TEST"
채널 타입
SeparatedAddress: { type, oneLine, addressLine1, ... }
분리 형식 주소

한 줄 형식 주소와 분리 형식 주소 모두 존재합니다. 한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.

SeparatedAddressInput: { addressLine1, addressLine2, city, ... }
분리 형식 주소 입력 정보
SortOrder: "DESC" | "ASC"
정렬 방식
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우