⌨️수납번호 발급 API
편의점 결제를 위한 수납번호를 발급합니다.
편의점결제 수납번호(barcode)를 발급 또는 등록합니다.
편의점결제 수납번호(barcode) 발급
POST
https://api.iamport.kr/cvs
편의점결제를 위한 수납번호(barcode)를 사전 발급 또는 등록합니다. 고객은 발급 또는 등록된 수납번호(barcode)에 해당되는 바코드 이미지 또는 수납번호를 편의점 방문시 제시함으로써 현장 결제가 이뤄지게 됩니다.
Request Body
Name | Type | Description |
---|---|---|
merchant_uid* | String(40) | 주문번호 |
amount* | double | 결제금액 |
barcode | String | 바코드 |
expired_at | integer | 편의점 수납가능한 결제기한 Unix Timestamp |
name | String(40) | 제품명 |
buyer_name | String(16) | 주문자명 |
buyer_email | String(64) | 주문자 E-mail주소 |
buyer_tel | String(16) | 주문자 전화번호 |
buyer_addr | String(128) | 주문자 주소 |
buyer_postcode | String(8) | 주문자 우편번호 |
pg | String | PG구분코드 |
confirm_url | String | 수납가능여부 체크 URL |
notice_url | String | 편의점결제 수납성공 시 통지받을 URL 선언되지 않으면 포트원 관리자 페이지에 정의된 Notification URL값을 사용 |
custom_data | Array | 에코항목 |
code
integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
response
(PaymentAnnotation, optional)
code
integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
imp_uid
* string
포트원 결제 고유 UID
merchant_uid
string
주문번호
pay_method
string
결제수단 구분코드
channel
string
결제환경 구분코드
pc: (인증방식)PC결제
mobile: (인증방식)모바일결제
api: 정기결제 또는 비인증 결제
pg_provider
string
PG사 구분코드
emb_pg_provider
string
허브형결제 PG사 구분코드
pg_tid
string
pg사 거래번호
pg_id
string
PG사 MID
escrow
boolean
에스크로 결제여부
apply_num
string
신용카드 승인번호
bank_code
string
은행 표준코드
(링크보기)
``
bank_name
string
은행 명칭
card_code
string
카드사 코드번호
(금융결제원 표준코드번호 : 링크 )
card_name
string
카드사명
card_quota
integer
할부개월 수
(0이면 일시불)
card_number
string
마스킹 카드번호
card_type
string
카드 구분코드
0 : 신용카드
1 : 체크카드
vbank_code
string
가상계좌 은행 표준코드
(하단이미지 참고)
vbank_name
** string
입금받을 가상계좌 은행명
vbank_holder
string
입금받을 가상계좌 예금주
vbank_date
string
입금받을 가상계좌 마감기한
(UNIX timestamp)
vbank_issued_at
string
가상계좌 생성 시각
(UNIX timestamp)
name
string
제품명
amount
integer
주문(결제)금액
cancel_amount
integer
결제취소금액
currency
string
통화구분코드
USD
KRW
EUR
buyer_name
string
주문자명
buyer_email
string
주문자 Email주소
\
buyer_tel
string
주문자 전화번호
buyer_addr
string
주문자 주소
buyer_postcode
string
주문자 우편번호
custom_data
string
echo data
JSON string으로 전달
user_agent
string
UserAgent
결제를 시작한 단말기 정
status
string
결제상태 구분코드
ready
paid
cancelled
failed
started_at
string
결제시작시점
(UNIX timestamp)
paid_at
string
결제완료시점
(UNIX timestamp)\
failed_at
string
결제실패시점
(UNIX timestamp)
cancelled_at
string
결제취소시점
(UNIX timestamp)
fail_reason
string
결제실패 사유
cancel_reason
string
결제취소 사유
receipt_url
string
신용카드 매출전표 확인 URL
cash_receipt_issued
boolean
현금영수증 자동발급 여부
customer_uid
string
해당 결제처리에 사용된 customer_uid
customer_uid_usage
string
customer_uid 사용 구분코드
issue : 빌링키 발급
payment : 결제
payment.scheduled : 예약결제
cancel_history
(Array[PaymentCancelAnnotation], optional):
취소/부분취소 내역
pg_tid
string
PG사 승인취소번호
amount
integer
취소 금액
cancelled_at
string
결제취소된 시각 UNIX timestamp
reason
* string
결제취소 사유
receipt_url
* string
취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음
주요 요청 파라미터 상세 설명
barcodestring
바코드번호
가맹점에서 직접 생성/관리하는 바코드(barcode)번호가 있는 경우 갤럭시아컴즈로부터 신규 수납번호(barcode)를 발급요청하지 않고 가맹점에서 관리하는 바코드(barcode)번호를 등록하여 수납번호로 활용할 수 있다.
expired_at integer
편의점 수납가능한 결제기한
정의하지 않으면 갤럭시아컴즈와 계약시 협의한 기본값이 적용됨
pg
``** ``**string
PG사 구분자
갤럭시아컴즈 상점아이디를 2개 이상 동시에 사용하시려는 경우 설정하시면 됩니다.
galaxia.{상점아이디} 형태로 지정
confirm_url
string
고객이 편의점결제 수납시도 시 수납가능여부를 체크하기 위한 URL. 설정하지 않은 결제에 대해서는 항상 수납가능으로 간주하고 수납성공진행 됨.
설정된 결제에 대해서는 해당 URL로 아래와 같은 형식의 데이터가 Webhook(HTTP POST)으로 전송됩니다.
200응답 == 수납가능 / 그 외응답 == 수납불가 처리
Swagger Test Link
Last updated