kakao developers

주문 조회

이 문서는 카카오페이 주문 조회 API 사용 방법을 안내합니다.

주문 상세 정보 조회하기

기본 정보

GET/POST /v1/payment/order HTTP/1.1
Host: kapi.kakao.com
Authorization: KakaoAK ${APP_ADMIN_KEY}
Content-type: application/x-www-form-urlencoded;charset=utf-8

주문 조회 API를 사용해 개별 주문의 상세 정보를 조회합니다. 앱 어드민 키를 헤더에 담아 POST로 요청합니다. 아래 두 가지 예제 중 어느 방법을 사용해도 결과는 같습니다. 요청이 성공하면 응답은 바디에 JSON 객체로 주문 상세 정보를 포함합니다.

Request

Parameter

Name	Type	Description	Required
cid	String	가맹점 코드, 10자	O
cid_secret	String	가맹점 코드 인증키, 24자, 숫자+영문 소문자 조합	X
tid	String	결제 고유번호, 20자	O

Response

Name	Type	Description
tid	String	결제 고유 번호, 20자
cid	String	가맹점 코드
status	String	결제 상태
partner_order_id	String	가맹점 주문번호
partner_user_id	String	가맹점 회원 id
payment_method_type	String	결제 수단, CARD 또는 MONEY 중 하나
amount	Amount	결제 금액
canceled_amount	CanceledAmount	취소된 금액
cancel_available_amount	CanceledAvailableAmount	취소 가능 금액
item_name	String	상품 이름, 최대 100자
item_code	String	상품 코드, 최대 100자
quantity	Integer	상품 수량
created_at	Datetime	결제 준비 요청 시각
approved_at	Datetime	결제 승인 시각
canceled_at	Datetime	결제 취소 시각
selected_card_info	SelectedCardInfo	결제 카드 정보
payment_action_details	PaymentActionDetails[]	결제/취소 상세

status(JSON)

Name	Description
READY	결제 요청
SEND_TMS	결제 요청 메시지(TMS) 발송 완료
OPEN_PAYMENT	사용자가 카카오페이 결제 화면 진입
SELECT_METHOD	결제 수단 선택, 인증 완료
ARS_WAITING	ARS 인증 진행 중
AUTH_PASSWORD	비밀번호 인증 완료
ISSUED_SID	SID 발급 완료 정기 결제 시 SID만 발급 한 경우
SUCCESS_PAYMENT	결제 완료
PART_CANCEL_PAYMENT	부분 취소
CANCEL_PAYMENT	결제된 금액 모두 취소 부분 취소 여러 번으로 모두 취소된 경우 포함
FAIL_AUTH_PASSWORD	사용자 비밀번호 인증 실패
QUIT_PAYMENT	사용자가 결제 중단
FAIL_PAYMENT	결제 승인 실패

amount(JSON)

Name	Type	Description
total	Integer	전체 결제 금액
tax_free	Integer	비과세 금액
vat	Integer	부가세 금액
point	Integer	포인트 금액
discount	Integer	할인 금액
green_deposit	Integer	컵 보증금

canceled_amount(JSON)

Name	Type	Description
total	Integer	전체 취소 금액
tax_free	Integer	취소된 비과세 금액
vat	Integer	취소된 부가세 금액
point	Integer	취소된 포인트 금액
discount	Integer	취소된 할인 금액
green_deposit	Integer	컵 보증금

cancel_available_amount(JSON)

Name	Type	Description
total	Integer	전체 취소 가능 금액
tax_free	Integer	취소 가능한 비과세 금액
vat	Integer	취소 가능한 부가세 금액
point	Integer	취소 가능한 포인트 금액
discount	Integer	취소 가능한 할인 금액
green_deposit	Integer	컵 보증금

selected_card_info(JSON)

Name	Type	Description
card_bin	String	카드 BIN
install_month	Integer	할부 개월 수
card_corp_name	String	카드사 정보
interest_free_install	String	무이자할부 여부(Y/N)

payment_action_details(JSON)

Name	Type	Description
aid	String	Request 고유 번호
approved_at	String	거래시간
amount	Integer	결제/취소 총액
point_amount	Integer	결제/취소 포인트 금액
discount_amount	Integer	할인 금액
green_deposit	Integer	컵 보증금
payment_action_type	String	결제 타입 PAYMENT(결제), CANCEL(결제취소), ISSUED_SID(SID 발급) 중 하나
payload	String	Request로 전달한 값

Sample

Request

curl -v -X POST "https://kapi.kakao.com/v1/payment/order" \
-H "Authorization: KakaoAK ${APP_ADMIN_KEY}" \
-d "cid=TC0ONETIME" \
-d "tid=T1234567890123456789"

Request: URL에 파라미터 포함

curl -v -X GET "https://kapi.kakao.com/v1/payment/order?cid=TC0ONETIME&tid=T1234567890123456789" \
-H "Authorization: KakaoAK ${APP_ADMIN_KEY}"

Response

HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
{
    "tid": "T1234567890123456789",
    "cid": "TC0ONETIME",
    "status": "SUCCESS_PAYMENT",
    "partner_order_id": "partner_order_id",
    "partner_user_id": "partner_user_id",
    "payment_method_type": "MONEY",
    "item_name": "초코파이",
    "quantity": 1,
    "amount": {
        "total": 2200,
        "tax_free": 0,
        "vat": 200,
        "point": 0,
        "discount": 0,
        "green_deposit": 0
    },
    "canceled_amount": {
        "total": 0,
        "tax_free": 0,
        "vat": 0,
        "point": 0,
        "discount": 0,
        "green_deposit": 0
    },
    "cancel_available_amount": {
        "total": 2200,
        "tax_free": 0,
        "vat": 200,
        "point": 0,
        "discount": 0,
        "green_deposit": 0
    },
    "created_at": "2016-11-15T21:18:22",
    "approved_at": "2016-11-15T21:20:48",
    "payment_action_details": [
        {
            "aid": "A5678901234567890123",
            "payment_action_type": "PAYMENT",
            "payment_method_type": "MONEY",
            "amount": 2200,
            "point_amount": 0,
            "discount_amount": 0,
            "approved_at": "2016-11-15T21:20:48",
            "green_deposit": 0
        }
    ]
}

더 보기

REST API 레퍼런스