CookiePay API 매뉴얼

결제취소 API

결제취소 시 주의사항

결제취소는 신용카드 결제, 계좌이체에 한해서만 취소 가능합니다.
가상계좌(토스제외), 휴대폰결제는 해당 API를 이용하실 수 없습니다.

결제취소 요청전문

결제 취소 요청은 먼저 TOKEN 발행 API를 통해 TOKEN을 발급 받은 후 발행된 TOKEN을 가지고 결제취소 API와 통신하게 되어 있습니다.

TOKEN 발행 URL
https://www.cookiepayments.com/payAuth/token [POST]
TOKEN 요청 전문 파라미터
항목명 길이 내용 구분 비고
pay2_id 30 cookiepayments에서 발급받은 ID 필수 cookiepayments사에서 부여
pay2_key 50 cookiepayments에서 발급받은 연동키 필수 cookiepayments사에서 부여
URL
https://www.cookiepayments.com/api/cancel [POST]
CURL
/* 토큰 발급 API */
curl -H "Content-Type: application/json" \
     -d '{
            "pay2_id": "cookiepayments에서 발급받은 ID",
            "pay2_key": "cookiepayments에서 발급받은 연동키"
         }' \
     -X POST "https://www.cookiepayments.com/payAuth/token"

/* 발급 받은 TOKEN으로 결제 취소 API 통신 */
curl -H "Content-Type: application/json" \
     -H "TOKEN: TOKEN API통해 발행된 TOKEN 값" \
     -H "ApiKey: cookiepayments에서 발급받은 연동키" \
     -d '{
            "tid": "결제 후 응답받은 PG사 거래 고유번호",
            "reason": "취소사유"
         }' \
     -X POST "https://www.cookiepayments.com/api/cancel"
PHP
/* 토큰 발행 API */
$tokenheaders = array(); 
array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "https://www.cookiepayments.com/payAuth/token";

$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, "TOKEN: TOKEN API통해 발행된 TOKEN 값");
    array_push($headers, "ApiKey: cookiepayments에서 발급받은 연동키");

    $cookiepayments_url = "https://www.cookiepayments.com/api/cancel";

    $request_data_array = array(
        'tid' => '결제 후 응답받은 PG사 거래 고유번호',
        'reason'=> '취소사유',
    );

    $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);

    $result_array = json_decode($response,TRUE);
    print_r($result_array);
}
요청 전문 파라미터
항목명 길이 내용 구분 비고
TOKEN 제한없음 TOKEN API통해 발행된 TOKEN 값 필수(헤더) cookiepayments사에서 부여
ApiKey 제한없음 cookiepayments에서 발급받은 연동키 필수(헤더) cookiepayments사에서 부여
tid 50 PG사 거래 고유번호 필수 PG사에서 부여
amount 11 취소금액 전체 취소 : 선택
부분 취소 : 필수
부분 취소 시 전체 금액 보다 작은 값 입력
※ 부분 취소는 신용카드 : 인증/수기(키인)
결제 수단만 가능합니다.
reason 50 취소사유 필수
bank 30 환불계좌 은행코드 (여기참조) 선택 가상계좌시 필수
account_no 30 환불계좌 계좌번호 선택 가상계좌시 필수
account_name 30 환불계좌 예금주이름 선택 가상계좌시 필수

결제취소 응답전문

응답 전문 파라미터
항목명 길이 내용 구분 비고
cancel_tid 50 PG사 취소 고유 거래번호 필수
cancel_code 4 취소 응답코드 필수 정상 : 0000, 그외 에러
cancel_msg 100 취소 응답메시지 필수
cancel_date 50 취소날자 필수
cancel_amt 10 취소 된 금액 필수