결제URL 발송 API

결제URL 발송 사용 시 주의사항

결제요청한 URL는 결제완료 이후에는 재사용 할 수 없습니다(1회만 사용)
발송수단 : SMS,이메일,카카오 (1개만 선택)

결제URL 발송 요청전문

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

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

URL

{요청도메인}/urlpay/request [POST]

CURL

샘플 예제

curl -H "Content-Type: application/json" \
     -H "ApiKey": "COOKIEPAY에서 발급받은 연동키" \
     -d '{ "API_ID": "COOKIEPAY에서 발급받은 가맹점연동 ID", \
           "PRODUCTNAME": "상품명", \
           "AMOUNT": "결제금액", \
           "BUYERNAME": "고객명", \
           "BUYERHP": "고객 휴대폰번호", \
           "BUYEREMAIL":"고객 E-MAIL", \
           "REQ_TYPE":"발송타입", \
           "PAYMENT_TYPE_USE":"사용할 결제타입", \  // 요청 전문 파라미터 참조

        }' \
    -X POST "{요청도메인}/urlpay/request"

PHP

샘플 예제

$headers = array(); 

array_push($headers, "content-type: application/json; charset=utf-8");
array_push($headers, "ApiKey: COOKIEPAY에서 발급받은 연동키 ");

$cookiepayments_url = "{요청도메인}/urlpay/request";

$request_data_array = array(
    'API_ID' => 'COOKIEPAY에서 발급받은 가맹점연동 ID',
    'PRODUCTNAME'=> '상품명',
    'AMOUNT'=> '결제금액',
    'BUYERNAME'=> '고객명',
    'BUYERHP'=> '고객 휴대폰번호',
    'BUYEREMAIL'=> '고객 E-MAIL',
    'REQ_TYPE'=>  '발송타입',
    'PAYMENT_TYPE_USE'=>  '사용할 결제타입', // 요청 전문 파라미터 참조
);

$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 발송 응답전문

응답 전문 파라미터

[선택시 개발] RETURNURL 응답전문(암호화 리턴) - RETURNURL 이용시 개발필요

RETURNURL 응답전문 파라미터(암호화 리턴)

결과값은 Form Data로 전송됩니다.

[선택시 개발]RETURNURL 응답전문 > 복호화 - RETURNURL 이용시 개발필요

RETURNURL 응답전문 파라미터 > 복호화 (암호화 전문 복호화하기 참조)

결과값은 Form Data로 전송됩니다.

복호화 응답데이터 예

{
  "RESULTCODE": "0000",         // 복호화 응답 코드
  "RESULTMSG": "성공",            // 복호화 응답 메시지
  "decryptData": {
      "PAYMETHOD": "CARD", // CARD, NAVERPAY, KAKAOPAY
      "RESULTCODE": "0000", // PG사 응답 코드 (성공시 "0000", 그외 에러)
      "RESULTMSG": "성공", //     PG사 응답 메시지 ("성공" 또는 오류 메세지)
      "ORDERNO": "주문번호",
      "AMOUNT": "1004",
      "TID": "PG 거래 고유번호",
      "ACCEPTDATE": "승인일시",
      "ACCEPTNO": "승인번호",
      "CASH_BILL_NO": "현금영수증일련번호",
      "CARDNAME": "결제카드사 이름",
      "ACCOUNTNO": "계좌번호",
      "RECEIVERNAME": "입금할 예금주",
      "DEPOSITENDDATE": "입금마감일",
      "CARDCODE": "입금할 은행코드 OR 결제카드코드",
      "QUOTA": "할부기간",
      "ETC1": "사용자 추가 필드1",
      "ETC2": "사용자 추가 필드2",
  }
}

PHP (RETURNURL 응답값으로) > 복호화후 응답필드 값으로 디비처리하기

// 결제정보 수신 후 데이터베이스에 입력되는 필드값은 고객님의 홈페이지 결제 테이블에 맞게 입력하셔야 합니다. 
// 결제요청시 결제시도 데이터는 디비에 우선 저장하신후 [인증 결제 응답 전문] 신호를 받으신후 결제완료 정보를 업데이트합니다.
// 계좌이체, 가상계좌의 경우 ACCEPT_NO 승인번호의 리턴 값이 없으므로 예외 처리하여 주시기 바랍니다.
// 결제 테이블 설계의 경우 비즈니스 로직에 때라 상이하므로 아래 예제 코드는 참조만 하여 주시기 바랍니다.
// 응답전문의 경우 기본 암호화 되어 리턴되므로 > 암호화 전문 복호화하기 api(전문)을 사용하시어 복호화후 디비처리하여 주십시요.

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

$cookiepay_api_url = "{요청도메인}/EdiAuth/cookiepay_edi_decrypt";

$edi_date = date('YmdHis');
$request_data_array = array(
    'API_ID' => 'cookiepayments에서 발급받은 ID', // 쿠키페이 결제 연동 id
    'ENC_DATA' => '암호화된 응답값',
);

$cookiepay_api_json = json_encode($request_data_array, TRUE);

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

curl_setopt($ch,CURLOPT_URL, $cookiepay_api_url);
curl_setopt($ch,CURLOPT_POST, false);
curl_setopt($ch,CURLOPT_POSTFIELDS, $cookiepay_api_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); // 응답값을 $response 변수 넣는다.
curl_close($ch);

$result_array = json_decode($response, true);
$params_decode = $result_array['decryptData'];

if( !empty($params_decode['ACCEPT_NO']) && !empty($params_decode['TID']) && !empty($params_decode['ORDERNO']) ) {

    /*
    [API_ID] => xxxxxxx
    [ORDERNO] => 20230206020000000
    [AMOUNT] => 100
    [TID] => CEH11111111111111111
    [USERID] => guest
    [BUYERNAME] => test
    [BUYEREMAIL] => 
    [PRODUCTCODE] => test
    [PRODUCTNAME] => test
    [ACCEPT_DATE] => 20230206110242
    [ACCEPT_NO] => 11111111
    [CARDCODE] => CCBC
    [CARDNAME] => 케이뱅크체크
    [CARDNO] => **********002163
    [QUOTA] => 00
    [ETC1] => 사용자 추가 필드1
    [ETC2] => 사용자 추가 필드2
    [PAY_METHOD] => CARD
    */

    /* 전달받은 결제정보로 결제완료 처리 예제코드 */
    $SQL = "UPDATE '결제테이블' set ";
    $SQL .= "ACCEPT_DATE    = '".$params_decode['ACCEPT_DATE']."', ";
    $SQL .= "ACCEPT_NO      = '".$params_decode['ACCEPT_NO']."', ";
    $SQL .= "TID            = '".$params_decode['TID']."',";
    $SQL .= "CARDCODE       = '".$params_decode['CARDNO']."',";
    $SQL .= "CARDNAME       = '".$params_decode['CARDNAME']."',";
    $SQL .= "QUOTA          = '".$params_decode['QUOTA']."',";
    $SQL .= "PAY_STATUS     = '결제성공' ";

    $SQL .= "WHERE ORDERNO  = '".$params_decode['ORDERNO']."' ";
    $SQL .= "AND AMOUNT     = '".$params_decode['AMOUNT']."' ";
    $SQL .= "AND PAY_STATUS = '결제대기' ";
    $SQL .= "LIMIT 1 ";

    $result = mysql_query($SQL, 'Connect_Info');

}

결제URL 통지 전문

통지 전문 파라미터

통지 전문(Noti)은 JSON POST 형식으로 전송됩니다.

결제URL 통지 전문(Noti)은 결제승인 파라미터에 대하여 쿠키페이먼트에서 고객사로 Server To Server로 전송됩니다.
개발한 통지 URL 입력방법 : 쿠키페이먼츠 접속 후 > API 연동 메뉴 > PG사 조회 및 연동 설정 > PG 연동 버튼 클릭 > 통지 URL 입력란에 입력 후 설정 저장하시면 됩니다.

결제승인 전문 파라미터

결제URL 발송 결제정보 확인

결제URL 발송 결제정보 확인

URL 결제 생성 후 고객이 결제를 하였는지 확인 하는 API 입니다. 고객님이 결제를 정상적으로 하였다면 결제 데이터를 리턴해주며, 결제가 실행 안된 경우에는 결제가 이루어지지 않았다는 데이터를 리턴해줍니다.

TOKEN 발행 URL

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

TOKEN 요청 전문 파라미터

결제URL 발송 결제정보 확인 URL

{요청도메인}/api/urlcert [POST]

결제URL 발송 결제정보 확인 요청 전문 파라미터

CURL

/* 토큰 발급 API */
curl -H "Content-Type: application/json" \
     -d '{"pay2_id": "cookiepayments에서 발급받은 ID", \
          "pay2_key": "cookiepayments에서 발급받은 연동키" \
         }' \
     -X POST "{요청도메인}/payAuth/token"

/* 발급 받은 TOKEN으로 결제 취소 API 통신 */
curl -H "Content-Type: application/json" \
     -H "TOKEN: TOKEN API통해 발행된 TOKEN 값" \
     -d '{"URLKEY": "생성된 결제창 URL KEY"}' \
     -X POST "{요청도메인}/api/urlcert"

PHP

/* 토큰 발행 API */
$tokenheaders = array();

array_push($tokenheaders, "content-type: application/json; charset=utf-8");

$token_url = "{요청도메인}/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 값");

    $cookiepayments_url = "{요청도메인}/api/urlcert";

    $request_data_array = array(
        'URLKEY' => '생성된 결제창 URL KEY',

    );

    $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 발송 결제정보 응답 전문 파라미터