이 문서는 카카오모먼트 쉬운 메시지광고의 결제 관리 API 사용 방법을 안내합니다.
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/cash/list
쉬운 메시지광고에 사용할 수 있는 캐시 충전 내역을 조회합니다.
쉬운 메세지 미발송분
type: CHARGEchargeMethod: SYSTEM_FREECASH
일반 메세지 미발송분
type: CHARGEchargeMethod: ADMIN_FREECASH
충전 내역 중 무상캐시는 무상캐시 사용 API 를 호출해 상태(status)를 사용 중(USING)으로 변경하면 사용 가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 광고계정의 캐시 충전 내역을 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 page Integer페이지 번호 X limit Integer페이지 사이즈(기본값: 20) X from String지표 조회 기간 시작일yyyy-MM-dd 형식 X to String지표 조회 기간 종료일yyyy-MM-dd 형식 X
이름 타입 설명 dt String거래일시 type StringCHARGE(충전), REFUND(환급), WITHDRAW(환불), REPAYMENT(채권상환) chargeMethod Enum거래 유형
CREDIT_CARD: 신용카드 결제KAKAOPAY_CARD_AUTO: 카카오페이에 설정된 신용카드로 결제-체크 카드 포함VIRTUAL_ACCOUNT: 무통장 입금ADMIN_CASH: 관리자 유상캐시 지급ADV_RET_CASH: 광고주 환원 유상캐시 지급CREDIT_CARD_REGULAR: 자동결제카드KAKAOPAY_CARD: 카카오페이 결제ADMIN_FREECASH: 관리자 무상캐시 지급SYSTEM_FREECASH: 시스템 무상캐시 지급EVENT_FREE_CASH: 프로모션 무상캐시 지급ADV_RET_FREE_CASH: 광고주 환원 무상캐시 지급ADMIN_ADJUST_FREECASH: 무상캐시 금액조정으로 인한 지급CPMS: CPMS계약조정으로 인한 지급CPT: CPT계약조정으로 인한 지급WITHDRAW: 환불EXPIRE_FREECASH: 무상캐시 만료 amount Double유, 무상캐시 금액 memberType Enum충전 거래자 유형
DSP_ACCOUNT: 광고계정ID를 사용해 DSP 또는 API로 충전하는 광고주INHOUSE_ACCOUNT: 어드민 기능으로 충전하는 카카오 내부 관리자AGENCY_ACCOUNT: 에이전시 플랫폼에서 충전하는 마케터 혹은 대행사SYSTEM: 카카오 시스템 memberEmail String거래자 이메일 memberName String거래자 이름 methodDetail String거래수단 withdrawMethod String환불 유형(CREDIT_CARD, VIRTUAL_ACCOUNT, ADMIN_CASH)
// Content-Type: application/json;charset=UTF-8
" dt ": " 2023-10-13T00:01:49 ",
" chargeMethod ": " SYSTEM_FREECASH ",
" dt ": " 2023-10-05T16:49:10 ",
" chargeMethod ": " ADMIN_FREECASH ",
" memberType ": " DSP_ACCOUNT ",
" memberEmail ": " test1***@gmail.com ",
" dt ": " 2023-10-05T16:48:43 ",
" chargeMethod ": " ADMIN_FREECASH ",
" memberType ": " DSP_ACCOUNT ",
" memberEmail ": " test***@gmail.com ",
" dt ": " 2023-09-13T20:00:43 ",
" dt ": " 2023-09-12T19:46:46 ",
" chargeMethod ": " CREDIT_CARD ",
" memberType ": " DSP_ACCOUNT ",
" memberEmail ": " tes****@gmail.com ",
" methodDetail ": " 신한 553146********** ",
" dt ": " 2023-10-06T00:06:35 ",
" chargeMethod ": " EXPIRE_FREECASH ",
메서드 URL 인증 방식 POSThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/cash/charge-order
쉬운 메시지광고에 사용할 광고캐시 충전 결제를 요청합니다.
이 API로 쉬운 메시지광고 전용 선불 광고주에게 필요한 충전 결제 기능을 제공할 수 있습니다. 결제 요청 시 카카오 고객센터 연락처(1577-3754)를 제공해 결제 중 발생하는 문제를 문의할 수 있도록 안내해야 합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청합니다. 요청 시 제휴사가 제공하는 결제 완료 후 랜딩 페이지의 URL을 redirectUrl로 전달해야 합니다. 요청 성공 시 응답은 PG사의 팝업 결제 페이지 URL인 paymentUrl를 포함합니다.
요청 파라미터의 redirectUrl과 응답 필드의 paymentUrl 값으로 아래와 같이 결제 요청을 처리할 수 있습니다.
충전 결제 요청 API를 호출합니다. 충전 결제 요청 API 성공 응답으로 받은 paymentUrl을 새 창으로 열어 사용자가 결제를 수행하도록 합니다. 결제 완료 후, 결제 페이지에서 직접 이동(location.href = '#redirect_url#')으로 부모창을 제어해 redirectUrl로 돌아갑니다.
실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 amount Long결제 금액 O redirectUrl String제휴사가 제공하는 결제 완료 후 랜딩 페이지의 URL O userIp String결제 요청자 IP, 제휴사 또는 선불 광고주의 IP X
이름 타입 설명 kakaoBillingTxId String트랜잭션(Transaction) ID paymentUrl StringPG사의 팝업 결제 페이지 URL
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/free-cash
쉬운 메시지광고에 사용할 수 있는 무상캐시 사용 현황을 조회합니다.
광고계정 생성 시 지급받은 쉬운 메시지광고 전용 무상캐시는 status이 USING, description이 메세지 발송 프로모션 무상캐시 지급입니다.
무상캐시의 만료기간은 아래와 같습니다.
최초 지급된 무상캐시: 생성일 기준 30일까지 메세지 미발송분으로 지급된 무상캐시: 지급일 기준 3개월까지
무상캐시의 상태에 따라 제공하는 기간정보는 아래와 같습니다.
USING, USED: beginDt, usedDt, endDt, createDt READY, EXPIRED: endDt, createDt
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 무상캐시 사용 현황을 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 id Long무상캐시 지급 ID amount String무상캐시 지급 액수 status String무상캐시 상태
READY: 대기USING: 사용중USED: 사용완료EXPIRED: 기간만료CANCEL: 취소 description String무상캐시 지급 (메세지 발송 프로모션 무상캐시 지급) issueMemberKakaoEmail String무상캐시 사용자 이메일 createDt String무상캐시 생성일 beginDt String무상캐시 사용 시작일 endDt String무상캐시 만료일 usedDt String무상캐시 사용일
메서드 URL 인증 방식 POSThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/free-cash/${FREE_CASH_ID}/use
무상캐시를 사용하도록 설정합니다.
무상캐시 사용 현황 조회 API 시 status가 READY이고 만료일이 경과하지 않은 무상캐시 대상으로만 요청할 수 있습니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청합니다. 요청 성공 시 응답은 무상캐시 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 FREE_CASH_ID String무상캐시 지급 ID O
이름 타입 설명 id Long무상캐시 지급 ID amount Double무상캐시 지급 액수 status String무상캐시 상태
READY: 대기USING: 사용중USED: 사용완료EXPIRED: 기간만료CANCEL: 취소 description String무상캐시 지급 이유(메세지 미발송분) issueMemberKakaoEmail String무상캐시 사용자 이메일 createDt String무상캐시 생성일 beginDt String무상캐시 사용 시작일 endDt String무상캐시 만료일 usedDt String무상캐시 사용일
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/balance
쉬운 메시지광고 전용 광고캐시 잔액을 조회합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 광고캐시 잔액 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 cash Double유상캐시(환불 가능 금액) freeCash Double무상캐시 freeCashReady Double무상캐시(대기) creditLimit Long후불 한도 remainedCreditLimit Double가용 후불 한도 holdAutopayCard Boolean자동결제 신용카드 등록 여부 deferredPayment Boolean후불 여부 active Boolean삭제 여부
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/spend
쉬운 메시지광고에 사용된 광고캐시를 조회합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 광고캐시 잔액과 소진금액 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 cash Double유상캐시(환불 가능 금액) freeCash Double무상캐시 creditLimit Long후불 한도 deferredPayment Boolean후불 여부 balance Double잔액(유상캐시와 무상캐시의 합) todaySpend Double오늘 소진 공급가액 todaySpendVat Double오늘 소진 부가세액 yesterdaySpend Double어제 소진 공급가액 yesterdaySpendVat Double어제 소진 부가세액 thisMonthSpendCash Double당월 유상캐시 소진 공급가액 thisMonthSpendCashVat Double당월 유상캐시 소진 부가세액 monthSpend Double당월 소진 공급가액
메서드 URL 인증 방식 POSThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw
쉬운 메시지광고 전용 광고캐시를 환불 요청합니다.
전액 환불 요청은 광고계정 상태가 OFF일 때만 가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청합니다. 요청 성공 시 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 allWithdraw Boolean전액 환불 여부 O amount Long환불 금액 O reason String환불 이유 O
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw
쉬운 메시지광고 전용 광고캐시의 환불 내역을 조회합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 환불 내역을 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 page Integer페이지 번호 X limit Integer페이지 사이즈(기본값: 20) X from String지표 조회 기간 시작일(yyyy-MM-dd 형식) X to String지표 조회 기간 종료일(yyyy-MM-dd 형식) X
이름 타입 설명 content WithdrawTo[]환불 내역 totalElements Long전체 응답 가능한 결과 수 totalPages Long총 페이지 수 first Boolean첫 페이지 여부
true: 첫 페이지false: 첫 페이지가 아님 last Boolean마지막 페이지 여부
true: 마지막 페이지false: 마지막 페이지가 아님 size Integer페이지 사이즈 number Integer페이지 번호 numberOfElements Integer현재 페이지에 응답된 결과 수
이름 타입 설명 id Long환불 요청 ID requestDt String요청 날짜 requestReason String요청 이유 requestAmount Long환불 요청 금액 status String환불 상태(RESERVED, STANDBY, APPROVED, REJECTED, ASK_ADMIN) memberId String환불 요청자 ID memberEmail String환불 요청자 이메일 memberStatus String환불 요청자 상태 requestType String환불 요청 타입(MANUAL_REQUEST, AUTO_REQUEST) details DetailTo[]환불 상세 내역
이름 타입 설명 id Long환불 상세 내역 ID dt String날짜 amount Long환불 금액 requestAmount Long환불 요청 금액 requestWithdrawMethod String환불 요청 방법 status String환불 상세 상태(SETTLED, PRE, SUCCESS, FAIL, ASK_ADMIN, CANCELED_SETTLE) statusDesc String환불 상태 설명 kakaoBillingTxId String거래번호 chargeMethod String충전 방법 chargeCardName String충전 카드명 chargeCardNumber String충전 카드번호 chargeKakaoEmail String충전 거래자 이메일 chargeMemberStatus String충전 거래자 상태 chargeMemberType Enum충전 거래자 유형
DSP_ACCOUNT: 광고계정ID를 사용해 DSP 또는 API로 충전하는 광고주INHOUSE_ACCOUNT: 어드민 기능으로 충전하는 카카오 내부 관리자AGENCY_ACCOUNT: 에이전시 플랫폼에서 충전하는 마케터 혹은 대행사SYSTEM: 카카오 시스템 chargeAmount Long충전 금액 chargeRemainAmount Long충전 잔여금액 withdrawMethod String환불 방법 failReason String환불 실패 원인
// Content-Type: application/json;charset=UTF-8
" requestDt ": " 2023-11-08T11:17:59 ",
" requestReason ": " auto withdraw because of charging on deferred payment wallet ",
" requestType ": " AUTO_REQUEST ",
" requestWithdrawMethod ": " 계좌 환불 ",
" kakaoBillingTxId ": null,
" chargeMethod ": " 무통장 입금 ",
" chargeCardNumber ": null,
" chargeKakaoEmail ": null,
" chargeMemberStatus ": null,
" chargeMemberType ": " SYSTEM ",
메서드 URL 인증 방식 POSThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw/account
환불계좌를 등록합니다.
은행 정기점검 시간에는 환불계좌 등록이 불가능합니다. 사업자 유형에 따라 아래 조건을 만족하는 환불계좌만 등록할 수 있습니다.
개인사업자
등록 가능한 환불계좌: 사업자 명의의 사업용 계좌 또는 사업자 본인의 개인 명의 계좌 예금주명: 대표자명, 상호명
법인사업자
등록 가능한 환불계좌: 법인 명의 계좌 예금주명: 법인명
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청하고, 요청 성공 시 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw/account
환불계좌 정보를 조회합니다.
은행 정기점검 시간에는 환불계좌 조회가 불가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 환불계좌 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 accountNumber String환불 계좌번호 bankCode String은행 코드 ownerName String예금주명
메서드 URL 인증 방식 PUThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw/account
환불계좌 정보를 수정합니다.
은행 정기점검 시간에는 환불계좌 수정이 불가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 PUT으로 요청합니다. 요청 성공 시 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
메서드 URL 인증 방식 DELETEhttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw/account
환불계좌 정보를 수정합니다.
은행 정기점검 시간에는 환불계좌 삭제가 불가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 DELETE로 요청합니다. 요청 성공 시 응답은 본문 없이 HTTP 200 상태 코드만 반환합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/withdraw/account/bank-code
환불계좌 등록 시 사용할 은행 코드를 조회합니다.
조회 결과에 포함된 은행 코드만 환불계좌 등록 및 수정 시 사용할 수 있습니다. 은행 코드는 추후 추가될 수 있습니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 은행 코드 목록을 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 code String은행 코드 type String은행 종류 name String은행 이름
// Content-Type: application/json;charset=UTF-8
{ " code ": " 02 ", " type ": " SANUP ", " name ": " 산업 " },
{ " code ": " 03 ", " type ": " KIUP ", " name ": " 기업 " },
{ " code ": " 04 ", " type ": " KOOKMIN ", " name ": " 국민 " },
{ " code ": " 07 ", " type ": " SUHYUP ", " name ": " 수협 " },
{ " code ": " 11 ", " type ": " NONGHYUP_CENTER ", " name ": " 농협중앙 " },
{ " code ": " 12 ", " type ": " NONGHYUP_LOCAL ", " name ": " 농협(단위조합) " },
{ " code ": " 20 ", " type ": " WOORI ", " name ": " 우리 " },
{ " code ": " 23 ", " type ": " SC ", " name ": " SC제일 " },
{ " code ": " 27 ", " type ": " CITY ", " name ": " 씨티 " },
{ " code ": " 31 ", " type ": " DAEGU ", " name ": " 대구 " },
{ " code ": " 32 ", " type ": " BUSAN ", " name ": " 부산 " },
{ " code ": " 34 ", " type ": " GWANGJU ", " name ": " 광주 " },
{ " code ": " 35 ", " type ": " JEJU ", " name ": " 제주 " },
{ " code ": " 37 ", " type ": " JEONBOOK ", " name ": " 전북 " },
{ " code ": " 39 ", " type ": " KYEONGNAM ", " name ": " 경남 " },
{ " code ": " 45 ", " type ": " SAEMAEUL ", " name ": " 새마을 " },
{ " code ": " 48 ", " type ": " SINHYUP ", " name ": " 신협 " },
{ " code ": " 54 ", " type ": " HSBC ", " name ": " HSBC " },
{ " code ": " 71 ", " type ": " POSTOFFICE ", " name ": " 우체국 " },
{ " code ": " 81 ", " type ": " HANA ", " name ": " KEB하나 " },
{ " code ": " 88 ", " type ": " SINHAN ", " name ": " 신한 " },
{ " code ": " 89 ", " type ": " K_BANK ", " name ": " 케이뱅크 " },
{ " code ": " 90 ", " type ": " KAKAO_BANK ", " name ": " 카카오뱅크 " },
{ " code ": " 209 ", " type ": " YUANTA_SECURITIES ", " name ": " 유안타증권 " },
{ " code ": " 240 ", " type ": " SAMSUNG_SECURITIES ", " name ": " 삼성증권 " }
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/virtual-accounts
쉬운 메시지광고 전용으로 발급된 가상계좌를 조회합니다.
선불 광고주는 충전 결제 요청 API , 후불 광고주는 후불 결제 요청 API 로 결제 시 무통장 입금을 선택해 가상계좌를 발급받을 수 있습니다. 가상계좌는 30일간 유효합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 가상계좌 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 accountNumber String가상계좌 번호 accountOwnerName String가상계좌 예금주명 amount Long입금금액 bankCode String은행코드 bankName String은행명 expireDttm String가상계좌 만료일시
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/bond
쉬운 메시지광고 전용 후불 결제 현황을 조회합니다.
repaymentAmount는 결제 가능 내역 조회 API 의 전체 미결제 금액에서 가상계좌 입금대기 금액을 뺀 금액입니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 후불 결제 현황 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 page Integer페이지 번호 X limit Integer페이지 사이즈(기본값: 20) X
이름 타입 설명 content BondTo[]후불 결제 현황 totalElements Long전체 응답 가능한 결과 수 totalPages Long총 페이지 수 first Boolean첫 페이지 여부
true: 첫 페이지false: 첫 페이지가 아님 last Boolean마지막 페이지 여부
true: 마지막 페이지false: 마지막 페이지가 아님 size Integer페이지 사이즈 number Integer페이지 번호 numberOfElements Integer현재 페이지에 응답된 결과 수
이름 타입 설명 bondAmount Long채권 금액 bondType String채권 유형(GENERAL, PENALTY) businessRegistrationNumber String사업자 등록 번호 companyName String사업자 이름 dueDt String상환 기간 lastestRepaymentDt String최근 상환일 overdue Boolean연체 여부 remainedBondAmount Long채권 잔액 repayable Boolean미결제액 존재여부 repaymentAmount Long상환 누적금액 repaymentCompleted Boolean상환여부 repaymentPeriod String결제기준일(DAYS_30, DAYS_60, DAYS_90, DAYS_120) repaymentStatus String채권 상태(READY, PARTIAL, DONE, OVERDUE) settleDt String정산월 repayments RepaymentTo[]상환 상세
이름 타입 설명 chargeAmount Long충전 금액 chargeMethod String충전 방법 chargeMethodDetail String충전 방법 상세 dt String날짜 journalTransactionId String저널식별자 memberEmail String거래자 카카오 이메일 memberId String거래자 ID memberName String거래자 이름 memberStatus String거래자 상태 memberType Enum충전 거래자 유형
DSP_ACCOUNT: 광고계정ID를 사용해 DSP 또는 API로 충전하는 광고주INHOUSE_ACCOUNT: 어드민 기능으로 충전하는 카카오 내부 관리자AGENCY_ACCOUNT: 에이전시 플랫폼에서 충전하는 마케터 혹은 대행사SYSTEM: 카카오 시스템 repaymentAmount Long상환 금액
// Content-Type: application/json;charset=UTF-8
" businessRegistrationNumber ": " string ",
" lastestRepaymentDt ": " string ",
" repaymentAmount ": 10000 ,
" repaymentCompleted ": false,
" repaymentPeriod ": " DAYS_90 ",
" repaymentStatus ": " READY ",
" chargeMethod ": " string ",
" chargeMethodDetail ": " string ",
" dt ": " yyyy-MM-dd'T'HH:mm:ss ",
" journalTransactionId ": " string ",
" memberStatus ": " string ",
" memberType ": " DSP_ACCOUNT ",
메서드 URL 인증 방식 GEThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/bond/repay
쉬운 메시지광고 전용 후불 광고주 대상으로 결제 가능 내역을 조회합니다.
결제 가능한 금액은 미결제 금액으로, 전체 미결제 금액 중 가상계좌 입금대기 금액을 제외한 금액입니다. 미결제 금액에 대해 후불 결제 요청 API 로 결제 가능합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 결제 가능 내역을 포함합니다. 실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 nextDueDt String다음 결제기한일 repays RepayTo[]정산 결제 정보
이름 타입 설명 dueDtRemainedBondAmount Long기한일 기준 미결제 금액 planRepayAmount Long가상계좌 입금대기 금액 remainedBondAmount Long전체 미결제 금액
메서드 URL 인증 방식 POSThttps://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts/wallet/bond/repay
쉬운 메시지광고 전용 후불 광고주 대상으로 후불 결제를 요청합니다.
결제 가능 내역 조회 API 로 확인한 미결제 금액에 대해 결제 요청해야 합니다. 결제 요청 시 카카오 고객센터 연락처(1577-3754)를 제공해 결제 중 발생하는 문제를 문의할 수 있도록 안내해야 합니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청합니다. 요청 시 제휴사가 제공하는 결제 완료 후 랜딩 페이지의 URL을 redirectUrl로 전달해야 합니다. 요청 성공 시 응답은 PG사의 팝업 결제 페이지 URL인 paymentUrl를 포함합니다.
요청 파라미터의 redirectUrl과 응답 필드의 paymentUrl 값으로 아래와 같이 결제 요청을 처리할 수 있습니다.
후불 결제 요청 API를 호출합니다. 후불 결제 요청 API 성공 응답으로 받은 paymentUrl을 새 창으로 열어 사용자가 결제를 수행하도록 합니다. 결제 완료 후, 결제 페이지에서 직접 이동(location.href = '#redirect_url#')으로 부모창을 제어해 redirectUrl로 돌아갑니다.
실패 시 에러 코드 및 상세 에러 코드 로 원인을 확인합니다.
이름 설명 필수 Authorization 인증 방식, 비즈니스 토큰 으로 인증 요청Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} O channel-profile-id 카카오톡 채널 프로필 ID channel-profile-id: ${CHANNEL_PROFILE_ID}O Content-Type 요청 데이터 타입Content-Type: application/json O
이름 타입 설명 필수 amount Long결제 금액 O redirectUrl String제휴사가 제공하는 결제 완료 후 랜딩 페이지의 URL O userIp String결제 요청자 IP O
이름 타입 설명 kakaoBillingTxId String트랜잭션(Transaction) ID paymentUrl StringPG사의 팝업 결제 페이지 URL
