현금영수증 관련 API
현금영수증에 관련된 API 를 확인할 수 있습니다.
⌨ 현금영수증 조회
현금영수증 조회
GET https://api.portone.io/v2/payments/{payment_id}/cash-receipt
Path Parameters
payment_id*
string
결제 ID
Query Parameters
store_id
string
하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
receipt * object
현금영수증 정보
id string
채널 ID
name 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
code * string
"UNAUTHORIZED"
params object
에러 세부사항
code * string
"PAYMENT_NOT_FOUND", "CASH_RECEIPT_NOT_FOUND"
params object
에러 세부사항
code * string
"PORTONE_ERROR"
params object
에러 세부사항
⌨ 현금영수증 발급
현금영수증 발급
POST https://api.portone.io/v2/payments/{payment_id}/cash-receipt
결제 건에 대한 수동 현금영수증 발급
Path Parameters
payment_id*
string
Request Body
store_id
string
channel_name*
string
customer_identifier*
string
type*
CashReceiptType
현금영수증 용도. personal = 소득공제용, corporate = 지출증빙용, anonymous = 국세청번호 자동발급 케이스
order_name*
string
currency*
Currency
화폐
amount*
number
tax_free_amount
number
면세 금액 (기본값:
"0")
product_type
ProductType
상품 유형
customer_name
string
고객 성명
customer_email
string
고객 이메일
receipt_id * string
현금영수증 ID
pg_tx_id * string
PG사 거래ID
issue_number * string
receipt_url * string
code * string
INVALID_REQUEST: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.
CASH_RECEIPT_ALREADY_ISSUED: 이미 발급된 현금영수증입니다.\
"INVALID_REQUEST", "CASH_RECEIPT_ALREADY_ISSUED"
params object
에러 상세 정보를 담은 파라미터 모음
code * string
UNAUTHORIZED: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\
"UNAUTHORIZED"
params object
에러 상세 정보를 담은 파라미터 모음
code * string
PERMISSION_DENIED: 해당 요청을 수행하기 위한 권한이 없습니다.\
"PERMISSION_DENIED"
params object
에러 상세 정보를 담은 파라미터 모음
code * string
STORE_NOT_FOUND: 하위 상점을 찾을 수 없습니다.
CHANNEL_NOT_FOUND: 결제 채널을 찾을 수 없습니다.\
"STORE_NOT_FOUND", "CHANNEL_NOT_FOUND"
params object
에러 상세 정보를 담은 파라미터 모음
code * string
"PORTONE_ERROR", "PG_PROVIDER_ERROR"
params object
에러 상세 정보를 담은 파라미터 모음
현금영수증 용도. personal = 소득공제용, corporate = 지출증빙용, anonymous = 국세청번호 자동발급 케이스
"PERSONAL", "CORPORATE", "ANONYMOUS"
화폐
"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"
상품 유형
"REAL", "DIGITAL"
⌨ 현금영수증 발급 취소
현금영수증 발급 취소
DELETE https://api.portone.io/v2/payments/{payment_id}/cash-receipt
Path Parameters
payment_id*
string
결제 ID
Query Parameters
store_id
string
하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
cancelled_amount * integer
현금영수증 취소 금액
cancelled_at * string
현금영수증 취소 시각
code * string
"INVALID_REQUEST", "CASH_RECEIPT_NOT_ISSUED"
params object
에러 세부사항
code * string
"UNAUTHORIZED"
params object
에러 세부사항
code * string
"PAYMENT_NOT_FOUND", "CASH_RECEIPT_NOT_FOUND"
params object
에러 세부사항
code * string
"PORTONE_ERROR", "PG_PROVIDER_ERROR"
params object
에러 세부사항
Last updated
Was this helpful?
