현금영수증 API

주의사항

1. 현금영수증 API는 먼저 TOKEN 발행 API를 통해 TOKEN을 발급 받은 후, 발행된 TOKEN을 가지고 API와 통신하게 되어 있습니다.
   
   • TOKEN 요청 전문 파라미터에 사용하는 pay2_id, pay2_key 값은 인증결제의 '연동ID', '연동 시크릿키' 값을 사용하시기 바랍니다.
2. 쿠키페이는 현금영수증을 발급을 위한 "사업자번호 연동키값"(현금영수증 연동키값)을 채번합니다.(최초 1회에 한함)
   
   • 1개의 사업자번호을 사용하실 경우에는 1개의 사업자번호 키값(현금영수증 발급 연동키값)을 채번합니다.
   • 단 만약 여러사업자를 사용하실 경우에는 각각의 사업자번호별로 연동키값을 채번해야 합니다.(사업자별 각각 최초 1회에 한함)

필독

• 쿠키페이의 현금영수증 발급 연동 제휴사는 (주)링크허브/팝빌입니다.
  
• 쿠키페이는 팝빌과의 현금영수증 발급연동을 위해, 현금영수증 이용 사업자의 기본정보를 팝빌에 제공합니다.(사업자별 최초 1회에 한함)
  
• 그러므로 현금영수증 연동고객사는 팝빌,쿠키페이에 사업자번호 및 기본정보를 제공한다는 고객 약관동의 절차를 밝아주시기 바랍니다.
  

현금영수증 발행

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/regist_issue [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/regist_issue";

$cashbill_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'MGTKEY' => '문서번호',
    'CONFIRMNUM' => '국세청 승인번호',
    'ORGCONFIRMNUM' => '원본 현금영수증 국세청 승인번호',
    'ORGTRADEDATE' => '원본 현금영수증 거래일자',
    'TRADEDATE' => '거래일자',
    'TRADEDT' => '거래일시',
    'TRADETYPE' => '문서형태',
    'TRADEUSAGE' => '거래구분',
    'TRADEOPT' => '거래유형',
    'TAXATIONTYPE' => '과세여부',
    'TOTALAMOUNT' => '거래금액',
    'SUPPLYCOST' => '공급가액',
    'TAX' => '부가세',
    'SERVICEFEE' => '봉사료',
    'FRANCHISECORPNUM' => '가맹점 사업자번호',
    'FRANCHISETAXREGID' => '가맹점 종사업장 식별번호',
    'FRANCHISECORPNAME' => '가맹점 상호',
    'FRANCHISECEONAME' => '가맹점 대표자 성명',
    'FRANCHISEADDR' => '가맹점 주소',
    'FRANCHISETEL' => '가맹점 전화번호',
    'IDENTITYNUM' => '식별번호',
    'CUSTOMERNAME' => '구매자(고객) 성명',
    'ITEMNAME' => '주문 상품명',
    'ORDERNUMBER' => '주문번호',
    'EMAIL' => '구매자(고객) 이메일',
    'HP' => '구매자(고객) 휴대폰',
    'SMSSENDYN' => 'SMS 전송여부',
    'FAXSENDYN' => 'FAX 전송여부',
    'CANCELTYPE' => '취소사유',
);
$request_data_array = array(
    'CORPNUM' => '사업자번호',
    'CASHBILL' => $cashbill_data_array,
    'MEMO' => '현금영수증 상태 이력을 관리하기 위한 메모',
    'EMAILSUBJECT' => '현금영수증 발행 안내메일 제목',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

현금영수증 객체정보

응답 전문 파라미터

현금영수증 전체 취소

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/revoke_regist_issue [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/revoke_regist_issue";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'CORPNUM' => '사업자번호',
    'MGTKEY' => '파트너가 할당한 문서번호',
    'ORGCONFIRMNUM' => '원본 현금영수증의 국세청 승인번호',
    'ORGTRADEDATE' => '원본 현금영수증의 거래일자',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

응답 전문 파라미터

현금영수증 부분 취소

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/revoke_regist_issue_part [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/revoke_regist_issue_part";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'CORPNUM' => '사업자번호',
    'MGTKEY' => '파트너가 할당한 문서번호',
    'ORGCONFIRMNUM' => '원본 현금영수증의 국세청 승인번호',
    'ORGTRADEDATE' => '원본 현금영수증의 거래일자',
    'SMSSENDYN' => '알림문자 전송여부',
    'MEMO' => '메모',
    'ISPARTCANCEL' => '현금영수증 취소유형',
    'CANCELTYPE' => '현금영수증 취소사유',
    'SUPPLYCOST' => '공급가액',
    'TAX' => '부가세',
    'SERVICEFEE' => '봉사료',
    'TOTALAMOUNT' => '거래금액',
    'EMAILSUBJECT' => '현금영수증 발행 안내메일 제목',
    'TRADEDT' => '거래일시',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

응답 전문 파라미터

현금영수증 정보확인

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/get_info [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/get_info";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'CORPNUM' => '사업자번호 (하이픈 '-' 제외 10자리)',
    'MGTKEY' => '파트너가 할당한 문서번호',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

응답 전문 파라미터

목록 조회

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/search [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/search";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'CORPNUM' => '사업자번호',
    'DTYPE' => '조회 기준일자 유형',
    'SDATE' => '조회 기간의 시작일자',
    'EDATE' => '조회 기간의 종료일자',
    'STATE' => '현금영수증 상태코드',
    'TRADETYPE' => '현금영수증 문서형태',
    'TRADEUSAGE' => '거래구분',
    'TRADEOPT' => '거래유형',
    'TAXATIONTYPE' => '과세형태',
    'PAGE' => '목록 페이지번호',
    'PERPAGE' => '페이지당 표시할 목록 개수',
    'ORDER' => '목록 정렬 방향',
    'QSTRING' => '현금영수증 식별번호 조회',
    'FRANCHISETAXREGID' => '가맹점 종사업장번호',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

응답 전문 파라미터

현금영수증 상세 정보 팝업 URL

기본도메인(요청도메인)

라이브 : https://www.cookiepayments.com [POST] 
테스트 : https://sandbox.cookiepayments.com [POST] 

URL

{요청도메인}/Cashbill/get_popup_url [POST] 

TOKEN 발행 URL

{요청도메인}/payAuth/token [POST] 

TOKEN 요청 전문 파라미터

샘플예제

PHP

/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{TOKEN 발행 URL}";

$token_request_data = array(
    'pay2_id' => 'cookiepayments에서 발급받은 ID',
    'pay2_key'=> 'cookiepayments에서 발급받은 연동키',
);

$req_json = json_encode($token_request_data, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $token_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $req_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $tokenheaders);
$RES_STR = curl_exec($ch);
curl_close($ch);
$RES_STR = json_decode($RES_STR,TRUE);
/* 여기 까지 */
if($RES_STR['RTN_CD'] == '0000'){

$headers = array(); 
array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키");
array_push($headers, "TOKEN: TOKEN API통해 발행된 TOKEN 값");

$cookiepayments_url = "{요청도메인}/Cashbill/get_popup_url";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'CORPNUM' => '사업자번호',
    'MGTKEY' => '파트너가 할당한 문서번호',
    'ETC1'=> '추가필드 1',
    'ETC2'=> '추가필드 2',
    'ETC3'=> '추가필드 3',
    'ETC4'=> '추가필드 4',
    'ETC5'=> '추가필드 5',
);

$cookiepayments_json = json_encode($request_data_array, TRUE);

$ch = curl_init(); // curl 초기화

curl_setopt($ch,CURLOPT_URL, $cookiepayments_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepayments_json);
curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3);
curl_setopt($ch,CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

요청 전문 파라미터

응답 전문 파라미터