VibeFox KOMOJU for PrestaShop — 도움말

요구 사항

PrestaShop: 8.0 ~ 9.x.

PHP: 8.0 이상. 모듈은 이전 버전의 PHP에는 설치되지 않습니다.

KOMOJU 계정: 비밀 키(sk_live_..., 그리고 테스트 모드용 sk_test_...)와 KOMOJU 대시보드에서 만든 웹훅의 비밀 토큰이 필요합니다(설정 참조). 공개 키(publishable key)는 필요하지 않습니다. KOMOJU가 쇼핑몰의 웹훅 URL에 접근할 수 있어야 합니다.

장바구니 통화: JPY, USD, EUR, TWD, KRW, PLN, GBP, HKD, SGD, NZD, AUD, IDR, MYR, PHP, THB, CNY, BRL, CHF, CAD 또는 VND. 다른 통화의 장바구니에서는 결제 방식이 표시되지 않습니다.

VibeFox 라이선스 키: vibefox.net에서 구매합니다. 키 하나는 도메인 하나에서 작동합니다.

설치

1. 관리자 페이지에서 Modules > Module Manager로 이동하여 Upload a module을 클릭합니다. 모듈의 ZIP 파일을 선택합니다.

2. 업로드가 끝나면 Configure를 클릭하거나, 나중에 모듈 목록에서 VibeFox KOMOJU Payment를 찾아 Configure를 클릭합니다.

3. 설정 페이지 상단의 라이선스 블록에 있는 License key에 VibeFox 라이선스 키를 입력하고 Activate를 클릭합니다(라이선스 키 참조).

4. KOMOJU 대시보드에서 Webhook URL 섹션에 표시된 URL과 이벤트로 웹훅을 추가하고, 비밀 토큰을 복사합니다(설정 참조).

5. 운영용 비밀 키와 운영용 웹훅 비밀 토큰, 그리고 테스트 모드용 테스트 키를 입력합니다. Enable/Disable을 켜고 Save를 클릭합니다.

설치 시 모듈은 두 가지 주문 상태, Awaiting KOMOJU payment와 KOMOJU payment on hold를 만듭니다. PrestaShop은 새 결제 모듈을 그 시점에 활성화된 국가에만 연결합니다. 나중에 활성화한 국가는 Payment > Preferences에서 모듈에 체크해야 합니다. 그곳에서 통화와 고객 그룹도 제한할 수 있습니다.

설정

모든 설정은 모듈 페이지에 있습니다: Modules > Module Manager > VibeFox KOMOJU Payment > Configure. 각 섹션에는 개별 Save 버튼이 있으며, 이 버튼은 페이지 전체를 저장합니다. 필드 위에는 테스트 모드가 켜져 있는 동안 KOMOJU Sandbox Mode is enabled.가 표시됩니다. 현재 모드에 비밀 키가 없거나(이 경우 체크아웃에서 결제 방식이 숨겨짐) 웹훅 비밀 토큰이 없거나(이 경우 KOMOJU 알림이 거부되어 편의점 결제와 은행 송금이 확정되지 않음), KOMOJU가 쇼핑몰의 기본 통화를 지원하지 않으면(이 경우 해당 통화의 장바구니에서 결제 방식이 숨겨짐) 페이지가 경고를 표시합니다.

KOMOJU 결제

Enable/Disable: Enable KOMOJU Payment Gateway는 결제 방식을 켜거나 끕니다. 기본값: 끔.

Title: 체크아웃에서 고객에게 보이는 결제 방식 이름입니다. 주문에도 저장되는 결제 방식 이름입니다. 기본값: KOMOJU Payment.

Description: 체크아웃에서 결제 방식 아래에 표시되는 텍스트입니다. 기본값: Pay securely on the KOMOJU payment page: credit card, convenience store (konbini), PayPay, bank transfer and other local payment methods.

운영용 API 키

키는 KOMOJU 대시보드에서 찾을 수 있습니다: 비밀 키는 Settings > API keys, 웹훅 비밀 토큰은 Settings > Webhooks에 있습니다(먼저 그곳에 Webhook URL 섹션에 표시된 웹훅 URL을 추가하세요).

Live Secret Key: KOMOJU 운영용 비밀 키입니다. sk_live_로 시작합니다.

Live Webhook Secret Token: 운영용 웹훅의 비밀 토큰입니다. 모든 알림의 서명을 검증하는 데 사용됩니다.

테스트 모드

KOMOJU는 테스트 결제와 운영 결제에 같은 API 주소를 사용하며, 키가 모드를 결정합니다. 결제는 만들어진 모드를 유지하므로, 주문의 환불과 상태 확인은 항상 그 모드의 키를 사용합니다.

Sandbox Mode: Enable test mode (use the test keys below, no real payments). 기본값: 끔. 켜져 있는 동안 체크아웃은 설명 위에 Test mode를 표시합니다.

Sandbox Secret Key: KOMOJU 테스트용 비밀 키입니다. sk_test_로 시작합니다.

Sandbox Webhook Secret Token: 테스트 모드 웹훅의 비밀 토큰입니다.

저장된 키와 토큰은 다시 표시되지 않습니다. 필드는 비어 있으며 Saved — leave empty to keep it.를 표시합니다. 변경하려는 경우에만 새 값을 입력하세요.

저장된 비밀 정보 삭제: 키 또는 토큰을 체크하고 Save를 클릭하면 삭제됩니다. 빈 필드는 저장된 값을 유지합니다.

웹훅 URL

웹훅은 지연된 편의점 결제와 은행 송금을 포함해 쇼핑몰에 결제 관련 정보를 알려 줍니다. KOMOJU 대시보드의 Settings > Webhooks에서 이 섹션에 표시된 URL을 운영 모드와 테스트 모드 모두에 추가하세요. 친숙한 URL을 사용하면 다음과 같이 보입니다: https://your-shop/module/wcp_komoju_payment/webhook, 때로는 /en/ 같은 언어 코드가 붙습니다. URL은 설정에 표시된 그대로 정확히 복사하세요. 그런 다음 각 웹훅의 비밀 토큰을 Live Webhook Secret Token 또는 Sandbox Webhook Secret Token에 복사합니다.

다음 이벤트를 선택합니다(이 섹션에도 나열되어 있습니다):

payment.authorized: 납부 전표가 발급되었거나(편의점, 은행 송금) 결제가 승인되었습니다. 주문은 Awaiting KOMOJU payment 상태로 생성됩니다.

payment.captured: 결제가 완료되었습니다. 금액 및 통화 확인 후 주문이 결제 완료로 표시됩니다.

payment.expired: 납부 전표가 만료되었습니다. 주문이 취소됩니다.

payment.cancelled: 결제가 취소되었습니다. 주문이 취소됩니다.

payment.failed: 결제가 실패했습니다. 기존 주문은 Payment error로 바뀝니다. 주문이 없으면 아무것도 생성되지 않습니다.

payment.refund.created: 환불이 이루어졌습니다(예: KOMOJU 대시보드에서). 주문에 기록됩니다.

payment.refunded: 결제가 환불되었습니다. 환불이 주문에 기록됩니다.

만료, 취소, 실패 이벤트는 주문의 현재 결제에 대해서만 주문을 변경하므로, 이전 시도의 결제가 다른 방식으로 결제 중인 주문을 취소할 수 없습니다. 유효한 서명이 없는 웹훅은 거부됩니다. 두 비밀 토큰 중 하나로 서명된 웹훅은 허용되지만, 같은 모드의 결제에 대해서만입니다. 웹훅이 없으면 카드 결제는 고객이 쇼핑몰로 돌아올 때 여전히 확정되지만, 편의점 결제와 은행 송금은 절대 확정되지 않습니다.

고급

Invoice Prefix: KOMOJU로 보내는 주문 번호의 접두사이며, 뒤에 장바구니 번호가 붙습니다. 같은 KOMOJU 계정으로 여러 쇼핑몰을 사용한다면 각 쇼핑몰마다 고유하게 설정하세요. 기본값: PS-.

Enable Logging: KOMOJU 이벤트와 API 호출을 모듈 폴더의 logs/komoju_p_debug.log.php에 기록합니다. 이 파일은 웹에서 열 수 없습니다. 키와 고객 데이터는 기록되지 않습니다. 오류와 경고는 항상 기록됩니다. 기본값: 끔.

Log: 로그의 크기와 최근 항목을 표시합니다. Clear log를 클릭하면 비워집니다.

Delete data on uninstall: 켜져 있으면 모듈을 제거할 때 게이트웨이 설정과 로그가 삭제됩니다. 주문, KOMOJU 거래와 환불, 주문 상태는 항상 남으므로, 다시 설치한 후에도 이전 주문을 확정하고 환불할 수 있습니다. 기본값: 끔.

체크아웃

결제 단계에서 고객은 결제 방식(기본값 KOMOJU Payment)을 선택하고 확인합니다. 모듈은 장바구니 총액과 장바구니 통화로 KOMOJU 결제 세션을 만들고, 고객을 KOMOJU 결제 페이지로 보냅니다. 이메일, 이름, 청구지 및 배송지 주소와 주문 상품이 KOMOJU에 전달됩니다. 이 페이지는 장바구니의 언어에 따라 일본어, 영어 또는 한국어로 표시됩니다(그 밖의 언어는 영어). 그곳에서 고객은 결제 방식을 선택합니다. 제공되는 방식은 쇼핑몰의 KOMOJU 계정과 장바구니 통화에 따라 달라집니다. 이 시점에는 아직 주문이 없습니다.

결제 후 고객은 쇼핑몰로 돌아옵니다. 모듈은 결제 모드의 키로 KOMOJU API에서 결제 세션을 조회합니다. 주문은 KOMOJU가 확인한 후에만 결제 완료로 표시됩니다: 서명된 웹훅을 통해서, 또는 고객이 돌아올 때 세션을 조회하여서입니다. 그다음 주문이 생성되고, 고객은 Your payment with KOMOJU has been received.가 표시된 표준 주문 확인 페이지를 봅니다. 그 시점에 KOMOJU에 연결할 수 없으면 Payment confirmation 페이지에 We could not confirm the payment status with KOMOJU yet. If you completed the payment, your order will be updated automatically in a few minutes.가 표시되며 Check again 버튼이 나타납니다.

편의점 결제와 은행 송금의 경우 고객은 납부 전표를 받습니다. 주문은 Awaiting KOMOJU payment 상태로 생성되고, 확인 페이지는 고객에게 KOMOJU의 안내에 따라(예: 편의점 또는 은행 송금으로) 결제를 완료하라고 알려 줍니다. 고객이 결제하고 KOMOJU가 웹훅을 보내면 주문은 Payment accepted가 됩니다. 전표가 만료되거나 나중에 결제가 실패하면 확인 페이지에 Your KOMOJU payment was not completed. Please contact us about this order.가 표시됩니다.

결제가 완료되지 않으면 고객은 The payment was not completed. You can try again or choose another payment method.가 표시된 체크아웃으로 돌아갑니다. 장바구니는 유지됩니다. 총액이 바뀌지 않았다면 새 시도는 열린 KOMOJU 세션을 재사용합니다. 이전 총액의 세션은 KOMOJU에서 취소되며, 그사이 결제된 세션은 새 결제 대신 주문을 생성합니다.

KOMOJU가 결제를 시작할 수 없으면 고객은 체크아웃에 머무르며 짧은 메시지를 보게 됩니다. 예: KOMOJU could not accept this payment: 뒤에 사유가 붙은 메시지, KOMOJU payments are temporarily unavailable. Please choose another payment method or contact us., 또는 Payment error: Could not connect to KOMOJU. Please try again in a moment.. 기술적인 사유는 로그에 기록됩니다.

결제와 확인 사이에 장바구니의 쿠폰이 더 이상 유효하지 않게 되면 PrestaShop은 그 쿠폰을 주문에서 제거합니다. 고객이 할인된 가격으로 결제했으므로, 주문은 메모와 함께 KOMOJU payment on hold 상태가 됩니다.

웹훅은 쇼핑몰이 유지 보수 모드인 동안에도 작동하며, 쇼핑몰의 국가 제한에 의해 차단되지 않습니다.

이 모듈에는 사이트의 카드 양식, 저장된 카드 또는 구독이 없습니다. 결제 방식을 제한하지 않으며, 결제 방식은 KOMOJU 페이지에서 선택됩니다. 수동 캡처 기능도 없습니다. 수동 캡처용으로 승인된 결제는 KOMOJU 대시보드에서 캡처해야 하며, 그때까지 주문은 Awaiting KOMOJU payment 상태에 머뭅니다.

주문 및 환불

주문 상태

No order yet: 고객이 KOMOJU로 이동했지만 아직 결제하지 않았거나, KOMOJU가 아직 결제를 확인하지 않은 상태입니다. 장바구니만 존재합니다.

Payment accepted: KOMOJU가 결제를 확인했습니다. 결제는 KOMOJU 결제 ID를 거래 ID로 기록하며, 메모에는 결제 ID, 결제 방식, 확인 방법(웹훅 또는 복귀)이 표시됩니다.

Awaiting KOMOJU payment: 편의점 결제 또는 은행 송금 전표가 발급되어 결제를 기다리는 상태이거나, 결제가 KOMOJU 대시보드에서 캡처되기를 기다리는 상태입니다.

KOMOJU payment on hold: KOMOJU가 주문 총액과 다른 금액이나 통화를 보고했습니다(예: 결제 시작 후 장바구니가 변경됨). 쿠폰이 제거되었거나, 주문이 취소된 후 결제가 캡처되었습니다. 메모에 사유가 설명되어 있습니다. 주문을 확인하고 처리하거나 결제를 환불하세요.

Canceled: 납부 전표가 만료되었거나 결제가 취소되었습니다.

Payment error: 기존 주문의 결제가 실패했습니다.

Refunded: 주문 페이지나 KOMOJU 대시보드에서 결제 전액이 환불되었습니다.

이미 결제 완료된 주문에 대해 두 번째 결제가 캡처되면 주문은 변경되지 않습니다. 중복된 결제라면 메모에서 KOMOJU 대시보드를 통해 환불하라고 안내합니다. 환불된 주문은 다시 열리지 않습니다.

KOMOJU 결제 블록

주문 페이지에는 KOMOJU payment 블록이 표시되며, KOMOJU 결제 ID(KOMOJU 대시보드의 결제 링크 포함), 결제 방식, 세션, KOMOJU의 주문 번호, 상태, 결제 금액, 환불 금액, 테스트 결제용 Test mode 배지, 환불 내역, 주문의 KOMOJU notes가 나타납니다.

환불

KOMOJU payment 블록에 금액을 입력하고(아직 환불되지 않은 금액이 자동으로 채워집니다), 필요하면 사유를 입력한 후 Refund via KOMOJU를 클릭합니다. Refund this amount through KOMOJU? This cannot be undone. 질문을 확인하세요. 전액 및 부분 환불을 지원합니다. 주문을 편집할 권한이 필요합니다. 환불은 KOMOJU가 실제로 청구한 금액으로 제한되므로, 금액 불일치 후에는 주문 총액이 아니라 고객이 결제한 금액까지만 환불할 수 있습니다. 환불은 결제가 이루어진 모드의 키로 전송되므로, 해당 모드의 비밀 키가 설정되어 있어야 합니다. 모듈은 먼저 KOMOJU에서 결제를 확인하고, 아직 환불 가능한 금액을 초과하는 환불은 거부합니다. KOMOJU가 결제를 자동으로 환불할 수 없는 경우(편의점 결제 등 일부 방식은 고객의 은행 정보가 필요합니다), KOMOJU의 오류 메시지가 표시되며 아무것도 기록되지 않습니다. 이런 환불은 KOMOJU 대시보드에서 처리하세요. 환불은 KOMOJU가 확인해야만 완료된 것으로 간주됩니다. 성공한 환불은 환불 내역과 메모에 추가됩니다. 전액 환불은 주문을 Refunded로 설정합니다. 부분 환불은 상태를 바꾸지 않습니다. 환불은 KOMOJU가 결제를 캡처한 후에 가능합니다.

KOMOJU가 다른 통화로 변환한 결제(예: EUR 장바구니에 대한 JPY 편의점 결제)의 경우, PrestaShop에서는 전액 환불만 가능합니다. 부분 환불은 KOMOJU 대시보드에서 하세요.

이 모듈은 신용 전표를 만들지 않습니다. 주문 페이지의 표준 PrestaShop 환불 버튼은 KOMOJU를 통해 돈을 돌려주지 않습니다.

KOMOJU 대시보드에서 실행한 환불은 웹훅으로 도착하며, 메모와 함께 환불 내역에 추가됩니다. 결제 전체가 환불되면 주문은 Refunded로 설정됩니다. 다른 통화로 변환된 결제에 대해 대시보드에서 한 부분 환불은 주문에 메모만 남습니다. 해당 금액을 PrestaShop에서 수동으로 기록하세요(신용 전표).

라이선스 키

이 모듈은 vibefox.net에서 받은 VibeFox 라이선스 키로 작동합니다. 라이선스 블록 License — VibeFox KOMOJU Payment는 Modules > Module Manager > VibeFox KOMOJU Payment > Configure 페이지에서 설정 위에 있는 첫 번째 블록입니다. License key에 키를 입력하고 Activate를 클릭합니다. 그 후 블록에는 마스킹된 키, 상태(예: 라이선스가 유효한 날짜와 도메인), 그리고 Check now(상태 다시 확인), Change key(다른 키 입력), Remove key(이 쇼핑몰에서 키 제거) 버튼이 표시됩니다. 그 아래에는 Product: presta-payment-komoju 줄과 Manage licenses and domains in your account 링크가 있으며, 이 링크는 vibefox.net 계정을 엽니다. 모듈의 Configure 권한이 있는 직원만 키를 변경할 수 있습니다. 블록의 텍스트는 관리자 페이지 언어를 따릅니다(영어와 러시아어 포함).

키가 허용되지 않으면 블록에 그 이유가 표시됩니다. 예: Key not found, This key belongs to another product, Domain limit reached 또는 날짜가 포함된 License expired on. 쇼핑몰 주소를 변경한 후 또는 계정에서 도메인 슬롯을 해제한 후에는 Check now를 클릭하세요. 라이선스 서버에 연결할 수 없으면 모듈은 마지막으로 확인된 상태를 기준으로 계속 작동합니다.

키 하나는 도메인 하나에서 작동합니다. 기본 쇼핑몰의 도메인이며, 다중 스토어 구성에서도 마찬가지입니다. 쇼핑몰에서 키를 제거해도 도메인 슬롯은 해제되지 않습니다. vibefox.net 계정에서 슬롯을 해제하세요.

활성 키가 없으면 체크아웃에서 고객에게 KOMOJU가 표시되지 않습니다. 그래도 결제가 시작되면 고객에게 This payment method is not available. Please choose another one.가 표시됩니다. PrestaShop 스토어프런트는 관리자 페이지에 로그인되어 있다는 사실을 알지 못하므로, 관리자 본인에게도 결제 방식이 숨겨집니다. 키를 구매하기 전에 모듈을 설정할 수는 있지만, 체크아웃에서 테스트할 수는 없습니다. Modules > Module Manager의 Alerts 탭에 알림이 표시됩니다. 기존 주문은 영향을 받지 않습니다. 이미 시작된 결제는 여전히 확인되며, 환불도 작동합니다.

라이선스가 만료되어도 모듈은 계속 작동하지만, 업데이트와 지원을 받으려면 갱신이 필요합니다. 관리자 페이지에서 작업하는 동안 상태가 자동으로 다시 확인됩니다: 키를 입력한 후 처음 14일 동안은 하루에 한 번, 그 후에는 일주일에 한 번입니다. 크론 작업은 필요하지 않습니다. 모듈을 제거하거나 재설정하면 라이선스 키와 라이선스 상태가 항상 삭제됩니다.

문제 해결

체크아웃에 KOMOJU가 나타나지 않음: 라이선스가 활성 상태인지, Enable/Disable이 켜져 있는지, 현재 모드에 비밀 키가 있는지 확인하세요. 테스트 모드에서는 Sandbox Secret Key, 운영 모드에서는 Live Secret Key가 필요합니다. 장바구니 통화는 KOMOJU가 지원해야 합니다. 설정 페이지는 무언가 빠졌을 때 경고를 표시합니다. Payment > Preferences에서 장바구니 통화, 고객의 국가, 고객 그룹에 대해 모듈이 허용되어 있는지 확인하세요.

결제는 되었지만 주문이 생성되지 않음: 웹훅이 작동하지 않습니다. KOMOJU 대시보드에서 사용 중인 모드의 웹훅이 있는지, URL이 Webhook URL 섹션에 표시된 것과 정확히 같은지, 이벤트가 선택되어 있는지 확인하세요. 비밀 토큰이 해당 필드(Live Webhook Secret Token 또는 Sandbox Webhook Secret Token)에 들어 있는지 확인하고, 모듈 페이지의 Log 필드를 살펴보세요. 카드 결제는 고객이 쇼핑몰로 돌아올 때도 확정되지만, 편의점 결제와 은행 송금은 웹훅으로만 확정됩니다.

웹훅 응답 Failed to verify KOMOJU webhook signature.: 비밀 토큰이 없거나 다른 웹훅의 토큰입니다. KOMOJU가 알림을 재시도합니다.

웹훅 응답 Mode mismatch, ignored.: 웹훅이 결제가 이루어진 모드와 다른 모드의 비밀 토큰으로 서명되었습니다. 운영 모드와 테스트 모드용으로 웹훅과 토큰을 따로 사용하고, 서로 바뀌지 않았는지 확인하세요.

웹훅 응답 Order is busy, retry later. 또는 Temporary error, retry later.: 주문이 다른 요청에 의해 업데이트 중이었거나, 그 시점에 주문을 만들 수 없었거나(예: 모듈이 비활성화됨), 결제를 확인할 수 없었습니다. KOMOJU가 알림을 재시도합니다. 사유는 로그에 있습니다.

브라우저에서 웹훅 URL에 오류가 표시됨: 정상입니다. 이 URL은 KOMOJU가 보낸 서명된 요청만 받습니다.

주문이 KOMOJU payment on hold 또는 Awaiting KOMOJU payment 상태임: 주문 블록의 KOMOJU notes를 읽어 보세요. 전표가 결제를 기다리고 있거나, 결제가 KOMOJU 대시보드에서 캡처되기를 기다리고 있거나, 금액 또는 통화가 일치하지 않았거나, 쿠폰이 제거되었거나, 주문이 취소된 후에 결제가 들어온 경우입니다.

환불 실패: 메시지를 읽어 보세요. 결제가 이루어진 모드의 비밀 키가 없을 수 있고, 결제가 자동으로 환불될 수 없을 수 있으며(KOMOJU 대시보드에서 환불), 설정된 키로는 KOMOJU가 결제를 인식하지 못할 수 있고, 변환된 결제에는 전액 환불만 가능할 수 있습니다.

개발자는 actionKomojuPSupportedCurrencies 훅으로 통화 목록을, actionKomojuPSessionParams 훅으로 결제 세션(예: 결제 방식)을 변경할 수 있습니다.

제거

Modules > Module Manager로 이동하여 VibeFox KOMOJU Payment 옆의 메뉴를 열고 Uninstall을 선택합니다. 이 모듈의 라이선스 키와 라이선스 상태는 항상 삭제됩니다. Delete data on uninstall이 켜져 있으면 게이트웨이 설정과 로그가 삭제됩니다. 꺼져 있으면 나중에 다시 설치할 수 있도록 모든 설정이 유지됩니다. KOMOJU 거래와 환불, 그리고 주문 상태 Awaiting KOMOJU payment와 KOMOJU payment on hold는 항상 유지되므로, 다시 설치한 후에도 이전 주문을 확정하고 환불할 수 있습니다. 기존 주문은 결제 메모와 거래 ID를 유지합니다.

KOMOJU는 해당 소유자의 상표입니다. 이 모듈은 KOMOJU와 제휴되어 있지 않으며 KOMOJU의 승인을 받지 않았습니다.