결제처리 후 리턴받은 결제 결과 데이터를 제공하는 API에 대한 설명입니다.
동기방식 결제결과 조회시 호출합니다.
- Home
- PG 앱
- PG 앱 제작방법
- API 레퍼런스
- 결제조회
결제조회
결제조회 호출 예시
- 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"}' \
결제조회 요청 사양
| 파라미터 | 용도 | 데이터타입 | 필수 | 데이터 | 비고 |
|---|---|---|---|---|---|
| key | 결제조회용 고유 키 | varchar(30) | 필수 | 결제예약 API 리턴값 'payment_url'에 포함된 key |
결제조회 응답데이터 사양
| 파라미터 | 용도 | 데이터타입 | 필수 | 데이터 | 비고 |
|---|---|---|---|---|---|
| partner_id | 가맹점ID | varchar(50) | 필수 | ||
| paymethod | 결제수단 | varchar(10) | 필수 | 기본연동코드-결제수단 | |
| custom_service_name | 앱 자체 서비스 식별명 | varchar(50) | 권장 | paymethod 이외의 결제수단 이용시 ㆍ안내 - Admin API로 앱 자체 식별 결제수단명을 등록한 후, 결제예약시 paymethod=etc 로 지정하고 등록한 결제수단명을 해당 파라미터로 전달 - Admin API : Create a paymentgateway paymentmethod |
|
| tid | PG사 거래번호 | varchar(100) | 필수 | ||
| amount | 실결제금액 | varchar(12) | 필수 | ||
| order_id | 가맹점 주문번호 | varchar(30) | 필수 | ||
| cancel_mode | 취소 방식 | varchar(10) | 권장 | ㆍsync : 동기 (※기본값) ㆍasync : 비동기 |
ㆍsync (동기) : 요청 즉시 결제취소 결과 리턴해주는 방식일 경우 ㆍasync (비동기) : 요청 후 결제취소 결과는 별도 통보(webhook)로 전달하는 방식일 경우 |
| all_cancel_tf | 전체취소 가능여부 | char(1) | 필수 | ㆍT : 가능(※기본값) ㆍF : 불가능 |
|
| part_cancel_tf | 부분취소 가능여부 | char(1) | 권장 | ㆍT : 가능 ㆍF : 불가능(※기본값) |
|
| escrow_tf | PG에스크로 실결제여부 | varchar(30) | 권장 | ㆍT : 사용 ㆍF : 사용안함(※기본값) |
|
| currency | 결제화폐 | char(3) | 필수 | 기본연동코드-결제화폐 | |
| payed_tf | 입금처리 완료여부 | char(1) | 필수 | ㆍT : 입금완료 ㆍF : 입금대기(※기본값) |
무통장성 거래의 경우 결제와 동시에 입금처리가 되지 않기 때문에 해당 값이 F 로 전달되고, 차후 입금이 완료되는 시점에 T 로 전달 |
| easypay | 간편결제 여부 | char(1) | 권장 | ㆍF (or null) : 일반결제 (※기본값) ㆍT : 간편결제 ㆍM : 간편결제(일반) / 일반 결제로 요청했는데, END USER가 간편결제로 결제한 경우 |
|
| hash_data | 위∙변조 방지 암호화데이터 | text | 필수 | 형식) base64_encode(hash_hmac('sha256', 평문, service_key, true)) ㆍ평문 (파라미터명 오름차순으로 나열) ㆍamount : 총금액 ㆍcurrency : 결제화폐 ㆍorder_id : 가맹점 주문번호 ㆍpartner_id : 가맹점 ID ㆍtid : PG사 거래번호 ㆍservice_key : 앱 생성시 개발자센터에서 발급받은 Service_key ex) base64_encode(hash_hmac('sha256', 'amount+currency+order_id+partner_id+tid', service_key, true)) |
|
| extra_data | cafe24 릴레이 데이터 | text(json) | 필수 | 가공하지 않고 받은 그대로 전달하는 필드 | |
| 복합과세 | |||||
| tax_free_tf | 복합과세여부 | char(1) | 권장 | ㆍT : 사용 ㆍF : 사용안함(※기본값) |
|
| amount_tax_free | 면세 + 영세 | varchar(12) | |||
| amount_vat | 부가세 | varchar(12) | |||
| amount_tax | 과세 | varchar(12) | |||
| 신용카드 | |||||
| card_code | 카드사코드 | varchar(10) | 권장 | 신용카드 결제시 필수 ㆍ코드 |
|
| card_interest_tf | 무이자할부여부 | char(1) | ㆍT : 무이자할부 ㆍF : 고객부담 할부 |
||
| card_interest_quota | 할부개월수 | varchar(2) | 권장 | ㆍ0 : 일시불 ㆍ1,2,3,4,5... : M개월 할부 |
신용카드 결제시 필수 |
| approval_no | 카드 승인번호 | varchar(30) | |||
| 실시간 계좌이체 / 가상계좌 | |||||
| bank_code | 은행코드 | varchar(10) | 권장 | 계좌이체, 가상계좌시 필수 ㆍ코드 |
|
| bank_acct_num | 가상계좌번호 | varchar(20) | 권장 | ||
| bank_input_name | 입금자명 | varchar(20) | 권장 | ||
| 응답코드 | |||||
| result_code | 응답코드 | char(4) | 필수 | '0000'이 아니면 결제승인 실패 | |
| result_message | 응답메세지 | text | 필수 | 응답코드에 따른 응답메시지 전문 ㆍ메세지 조합 ㆍ성공시 : 성공 ㆍ실패시 : 앱 메세지 - (PG사리턴코드) PG사메세지 |
|
다음 문서
이 페이지가 얼마나 도움이 되었나요?
0자 입력 /최대 300자