Home
PG 앱
PG 앱 제작방법
API 레퍼런스
결제예약

결제예약

결제처리 전 결제요청시 필요한 데이터를 받아주는 API에 대한 설명입니다.
결제 연동 첫 단계로 결제를 진행하기 위해서 PG사(APP)측에 PG사 사양으로 데이터를 받아오며 결제에 필요한 데이터를 POST 방식으로 form.submit(); 합니다.

PG모듈로부터 PG사(APP)측에서 아래 정의된 사양으로 받은 후 PG사(APP)측 결제요청 가능한 사양으로 변경해서 리턴 처리해주어야 합니다.

① 구간 : PG모듈(EC) → PG사(APP)

② 결제 처리 유형 (APP→PG모듈)
   ㆍ동기방식 (sync)
     - 결제결과를 공통스펙과 함께 응답
     - 후입금 결제수단에 대해서만 통보(WebHook) 호출
   ㆍ비동기방식 (async)
     - 결제결과를 응답코드로만 리턴
     - 결제완료와 입금완료 통보(WebHook) 호출

③ 데이터포멧 : JSON

④ 요청 메소드 : POST

⑤ 인코드 : UTF-8

결제예약 호출 예시
결제 예약데이터 사양
결제예약 응답데이터 사양

결제예약 호출 예시

URL : 결제예약 APP API URL
응답데이터 포맷 : JSON

결제예약 APP API URL

POST 결제예약 APP API URL
Content-Type: application/json
Accept: application/json
Accept-Charset: utf-8

요청코드 예시

curl -X POST '결제예약 APP API URL' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Charset: utf-8' \
-d '{"key1":"value1", "key2":"value2"}' \

결제 예약데이터 사양

결제 예약데이터 사양
파라미터	용도	데이터타입	필수	데이터	비고
request_type	처리 요청타입	varchar(10)	필수	request(※고정값)
partner_id	가맹점 ID	varchar(50)	필수
end_user_ip	가맹점 고객 IP	varchar(20)	필수
shop_name	가맹점 명	varchar(50)
shop_no	가맹점(멀티샵) 번호	int	권장
order_id	가맹점 주문번호	varchar(30)	필수
paymethod	결제수단	varchar(10)			기본연동코드-결제수단
custom_service_code	앱 자체 서비스 식별코드	varchar(50)	권장		ㆍpaymethod 이외의 결제수단 이용시 ㆍ안내 - Admin API로 앱 자체 식별 결제수단명을 등록한 후, 결제예약시 paymethod=etc 로 지정하고 등록한 결제수단 코드를 해당 파라미터로 전달 - Admin API : Create a paymentgateway paymentmethod
currency	결제화폐	char(3)	필수		기본연동코드-결제화폐
country_code	국가코드	char(2)	필수		기본연동코드-국가코드 국가별 언어 구분시 사용
encoding_type	캐릭터셋	varchar(10)	필수		기본연동코드-캐릭터셋
buyer_id	주문자 아이디	varchar(20)	권장
buyer_name	주문자 이름	varchar(20)	필수
buyer_tel	주문자 유선전화	varchar(30)	권장
buyer_phone	주문자 휴대폰번호	varchar(30)	권장
buyer_email	주문자 이메일	varchar(40)	권장
buyer_zip_code	주문자 우편번호	varchar(30)	권장		해외 PG 필수
buyer_addr	주문자 주소	text	권장
receiver_name	수신자 이름	varchar(20)	권장
receiver_phone	수신자 유선전화	varchar(30)	권장
receiver_zip_code	수신자 우편번호	varchar(30)	권장		해외 PG 필수
receiver_addr	수신자 주소	text	권장
goods_name	상품명	varchar(30)	필수
amount	총금액	varchar(12)	필수
amount_tax_free	면세 + 영세	varchar(12)	권장		복합과세 사용시 필수
amount_vat	부가세	varchar(12)	권장		복합과세 사용시 필수
amount_tax	과세	varchar(12)	권장		복합과세 사용시 필수
product_period	용역제공기간	varchar(16)	권장	형식) YYYYMMDDYYYYMMDD	국내PG 필수
return_url	결제결과 리턴 URL	varchar(255)	필수	ㆍ동기방식 : 가맹점도메인/Pay/Recv/openpg/PayReceiveRtn.php ㆍ비동기방식 : 가맹점도메인/Pay/Recv/openpg/PayReceiveRtnPage.php	결제결과를 리턴받는 URL
return_noty_url	결제통보 URL	varchar(255)	필수	형식) 가맹점도메인 /Pay/Recv/openpg/PayReceiveNoty.php	BackEnd로 통보받는 URL
user_agent	유입환경	varchar(255)	필수	ex) Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
mobile_os	모바일 OS	char(3)	권장	ㆍO01 : ANDROID ㆍO02 : IOS	모바일 환경 결제시 필수
mobile_channel	모바일 유입구분	varchar(10)	권장		모바일 환경 결제시 필수
mobile_app_scheme	모바일 APP scheme	varchar(200)	권장		모바일 환경 결제시 필수
mobile_app_partner	모바일 App Name	varchar(50)	권장		모바일 환경 결제시 필수
hash_data	위∙변조 방지 암호화데이터 (HAMC)	text	필수		형식) base64_encode(hash_hmac('sha256', 평문, service_key, true)) ㆍ평문 (파라미터명 오름차순으로 나열) ㆍamount : 총금액 ㆍcurrency : 결제화폐 ㆍorder_id : 가맹점 주문번호 ㆍpartner_id : 가맹점 ID ㆍservice_key : 앱 생성시 개발자센터에서 발급받은 Service_key ex) base64_encode(hash_hmac('sha256', 'amount+currency+order_id+partner_id', service_key, true))
extra_data	cafe24 릴레이 데이터	text(json)	필수		가공하지 않고 받은 그대로 전달하는 필드
additional_payment_info	결제 추가 정보 데이터	text(json)	권장		협의 된 앱에 한해서 필수
가상계좌
icash_expire_date	가상계좌/편의점 입금마감일	varchar(8)	권장	형식) YYYYMMDD
해외결제
ship_country	국가코드	varchar(20)	권장
ship_zip	우편번호	varchar(20)	권장
ship_state	주 / 도	varchar(20)	권장
ship_city	시 / 군	varchar(20)	권장
ship_address	주소1	varchar(20)	권장
ship_address2	주소2	varchar(20)
ship_option_1	배송 추가 옵션	char(1)		ㆍT : 사용 ㆍF : 사용안함(※기본값)

결제예약 응답데이터 사양

결제예약 응답데이터 사양
파라미터	용도	데이터타입	필수	데이터	비고
result_code	응답코드	char(4)	필수		'0000' 이외는 실패
result_message	응답메세지	text	필수		응답코드에 따른 응답메시지 전문 ㆍ메세지 조합 ㆍ성공시 : 성공 ㆍ실패시 : 앱 메세지 - [PG사 리턴코드] PG사 메세지
payment_url	결제가능 URL	varchar(200)	필수	형식)https://결제URL?key=[hash_key]

다음 문서

결제조회

이 페이지가 얼마나 도움이 되었나요?

도움안됨 도움됨

0자 입력 /최대 300자