현금 영수증 관련 API
현금 영수증과 관련된 API 기능을 제공합니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
CancelCashReceiptError: | | | ...
CancelCashReceiptResponse: { cancelledAmount, cancelledAt }
현금 영수증 취소 성공 응답
CancelledCashReceipt: { status, merchantId, storeId, ... }
발급 취소
CashReceipt: | |
현금영수증 내역
CashReceiptAlreadyIssuedError: { type, message }
현금영수증이 이미 발급된 경우
CashReceiptFilterInput: { storeId, timeRangeField, from, ... }
현금영수증 다건 조회를 위한 입력 정보
CashReceiptNotFoundError: { type, message }
현금영수증이 존재하지 않는 경우
CashReceiptNotIssuedError: { type, message }
현금영수증이 발급되지 않은 경우
CashReceiptSortBy: "ISSUED_AT" | "CANCELLED_AT" | "STATUS_UPDATED_AT"
현금영수증 정렬 기준
CashReceiptSortInput: { by, order }
현금영수증 다건 조회 시 정렬 조건
CashReceiptStatus: "ISSUED" | "CANCELLED" | "FAILED"
현금영수증 발급 건 상태
CashReceiptSummary: { issueNumber, url, pgReceiptId }
현금영수증 내역
CashReceiptTimeRangeField: "ISSUED_AT" | "CANCELLED_AT" | "STATUS_UPDATED_AT"
현금영수증 다건 조회 시, 시각 범위를 적용할 필드
CashReceiptType: "PERSONAL" | "CORPORATE"
발급 유형
ChannelNotFoundError: { type, message }
요청된 채널이 존재하지 않는 경우
Currency: "KRW" | "USD" | "JPY" | ...
통화
ForbiddenError: { type, message }
요청이 거절된 경우
GetCashReceiptError: | | | ...
GetCashReceiptsBody: { page, sort, filter }
현금영수증 다건 조회를 위한 입력 정보
GetCashReceiptsError: | |
GetCashReceiptsResponse: { items, page }
현금영수증 다건 조회 성공 응답 정보
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
IssueCashReceiptBody: { storeId, paymentId, channelKey, ... }
현금영수증 발급 요청 양식
IssueCashReceiptCustomerInput: { identityNumber, identityNumberType, name, ... }
현금영수증 발급 시 고객 관련 입력 정보
IssueCashReceiptCustomerInputIdentityNumberType: "PHONE" | "CARD" | "BUSINESS"
현금영수증 발급 시 고객 식별 정보 유형
IssueCashReceiptError: | | | ...
IssueCashReceiptPaymentMethodType: "TRANSFER" | "VIRTUAL_ACCOUNT"
현금영수증 발급 가능 결제 수단
IssueCashReceiptResponse: { cashReceipt }
현금 영수증 발급 성공 응답
IssueFailedCashReceipt: { status, merchantId, storeId, ... }
발급 실패
IssuedCashReceipt: { status, merchantId, storeId, ... }
발급 완료
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PaymentAmountInput: { total, taxFree, vat }
금액 세부 입력 정보
PaymentProductType: "PHYSICAL" | "DIGITAL"
상품 유형
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"
채널 타입
SortOrder: "DESC" | "ASC"
정렬 방식