VibeFox Midtrans for PrestaShop — 도움말

요구 사항

PrestaShop: 8.0 ~ 9.x.

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

통화: 인도네시아 루피아(IDR). Midtrans는 IDR로만 결제를 받으므로, 장바구니 통화가 IDR일 때만 이 결제 수단이 제공됩니다. 통화 환산은 없습니다. 쇼핑몰에 IDR 통화가 없다면 International > Localization에서 추가하십시오.

Midtrans 계정: Midtrans Dashboard > Settings > Access Keys의 Server Key가 필요합니다. 샌드박스 대시보드와 운영 대시보드 모두에서 확인하십시오. 사용되는 것은 Server Key뿐입니다. Snap Redirect에는 Client Key가 필요하지 않습니다. 결제 수단 자체(GoPay, QRIS, 가상계좌 등)는 Midtrans 계정에서 활성화합니다.

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

설치

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

2. 업로드가 끝나면 Configure를 클릭하십시오. 나중에 모듈 목록에서 VibeFox Midtrans Payment Gateway를 찾아 Configure를 클릭해도 됩니다.

3. Configure 페이지 상단의 라이선스 블록에 있는 License key 입력란에 VibeFox 라이선스 키를 입력하고 Activate를 클릭하십시오(라이선스 키 참조).

4. Server Key를 입력하고, 결제 알림 URL을 Midtrans 대시보드에 복사하십시오(구성 항목 참조).

5. Enable/Disable을 켜고 Save를 클릭하십시오. Sandbox에서 테스트한 후 Environment를 Production으로 전환하십시오.

설치 시 모듈은 두 가지 주문 상태를 만듭니다: Awaiting Midtrans payment와 Midtrans payment on hold. PrestaShop은 모든 통화, 국가, 고객 그룹에 대해 새 결제 모듈을 제공합니다. 이는 Payment > Preferences에서 제한할 수 있습니다. 모듈은 IDR 통화에 대해 허용된 상태로 남아 있어야 합니다.

구성

모든 설정은 모듈 페이지에 있습니다: Modules > Module Manager > VibeFox Midtrans Payment Gateway > Configure. 각 섹션에는 전체 페이지를 저장하는 자체 Save 버튼이 있습니다. 필드 위에서 페이지는 선택한 환경의 Server Key가 없는 경우(이때 결제 수단은 체크아웃에서 숨겨짐)와 쇼핑몰 기본 통화가 IDR이 아닌 경우를 경고하며, Sandbox를 선택한 동안에는 Sandbox mode: payments are simulated, no real money is charged.를 표시합니다.

Midtrans

Enable/Disable: Enable Midtrans payments는 결제 수단을 켜거나 끕니다. 기본값: 꺼짐.

Title: 체크아웃에서 고객에게 표시되는 결제 수단 제목입니다. 주문에 저장되는 결제 수단 이름이기도 합니다. 기본값: Midtrans. 필수.

Description: 체크아웃에서 결제 수단 아래에 표시되는 문구입니다. 기본값: Pay securely via Midtrans — GoPay, QRIS, ShopeePay, cards, bank transfer and more. Sandbox에서는 SANDBOX MODE: no real money is charged. 줄이 추가됩니다.

API 인증 정보

Midtrans Dashboard > Settings > Access Keys에서 Server Key를 복사하십시오. 이 섹션에는 운영 대시보드와 샌드박스 대시보드로 가는 링크가 있습니다.

Environment: 새 결제에 사용할 Midtrans 환경입니다. 전환하면 선택한 환경의 키와 API가 사용됩니다. 결제는 환불과 알림을 위해 자신이 이루어진 환경을 유지합니다. 기본값: Sandbox.

Production Server Key: Mid-server-로 시작합니다. 비밀로 유지하십시오.

Sandbox Server Key: SB-Mid-server-로 시작합니다.

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

Clear saved keys: 키를 체크하고 Save를 클릭하면 삭제됩니다. 빈 필드는 저장된 값을 유지합니다.

결제 알림 URL

알림은 결제가 이루어졌음을 쇼핑몰에 알려 줍니다. Notification URL 필드에는 사용해야 할 URL이 표시됩니다. 친숙한 URL을 사용하면 https://your-shop/module/wcp_midtrans_payment_gateway/webhook과 비슷한 형태가 되며, /en/ 같은 언어 코드가 붙을 수도 있습니다. 설정에 표시된 URL을 정확히 복사하여 사용하는 샌드박스 대시보드와 운영 대시보드의 Midtrans Dashboard > Settings > Payment > Notification URL에 붙여넣으십시오. 브라우저에서 URL을 열면 짧은 설명이 표시되므로, 접근 가능한지 확인할 수 있습니다. Midtrans 대시보드의 Test notification URL 버튼에도 응답합니다.

각 알림에는 Server Key 중 하나로 만든 유효한 서명이 있어야 하며, 키의 환경은 결제의 환경과 일치해야 합니다. 유효한 서명이 없는 알림은 거부됩니다. 이 경우 상태는 Midtrans 상태 API에서 다시 조회됩니다. 모듈은 다음 Midtrans 거래 상태를 처리합니다:

결제 알림 URL이 없으면 주문은 고객이 결제 후 쇼핑몰로 돌아왔을 때에만 생성되며, 나중에 이루어진 지연 결제는 고객이 돌아올 때까지 인식되지 않습니다.

결제 설정

Midtrans는 IDR로만 결제를 받으며, 금액은 정수 루피아로 전송됩니다. 주문 항목의 합계가 반올림된 총액과 맞지 않으면 Rounding adjustment 줄이 Midtrans로 전송됩니다.

Status after payment: 결제 확인 후의 주문 상태입니다.

Payment page expiry (minutes): 고객이 결제할 수 있는 기간입니다(Snap 페이지, 가상계좌 등). 비워 두거나 0을 입력하면 Midtrans 기본값이 사용됩니다. 분 단위 정수가 아닌 값은 저장할 때 오류와 함께 거부됩니다.

Order ID prefix: Midtrans로 전송되는 번호 앞에 붙습니다. 여러 쇼핑몰이 하나의 Midtrans 계정을 공유할 수 있게 해 줍니다. 번호는 장바구니 ID에 타임스탬프를 붙인 것으로, 예를 들어 WC-123-1700000000과 같습니다. 영문자, 숫자, 그리고 - _ . ~만 사용할 수 있으며 최대 20자입니다. 그 밖의 문자는 저장할 때 제거됩니다. 다른 쇼핑몰의 알림은 무시됩니다. 기본값: WC-.

고급

Debug log: API 호출과 알림을 모듈 폴더의 logs/midtrans_p_debug.log.php에 기록합니다. 이 파일은 웹에서 열 수 없습니다. 오류는 항상 기록됩니다. 키와 고객 데이터는 절대 기록되지 않습니다. 기본값: 꺼짐.

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

Delete data on uninstall: 켜져 있으면 모듈을 제거할 때 모듈 설정과 로그가 삭제됩니다. 주문, 주문의 Midtrans 결제 참조와 환불, 그리고 모듈의 주문 상태는 항상 유지되므로, 재설치 후에도 이전 주문을 환불할 수 있습니다. 기본값: 꺼짐.

체크아웃

결제 단계에서 고객은 결제 수단(기본값 Midtrans)을 선택하고 확인합니다. 모듈은 장바구니 금액을 정수 루피아로 하여 Midtrans Snap 거래를 만들며, 이때 주문 항목, 배송비, 할인, 선물 포장, 세금, 고객의 청구지 및 배송지 정보를 포함하고, 고객을 Midtrans 결제 페이지로 보냅니다. 그곳에서 고객은 Midtrans 계정에서 활성화된 결제 수단 중 원하는 것을 선택합니다. 이 시점에는 아직 주문이 존재하지 않습니다.

결제 후 고객은 쇼핑몰로 돌아옵니다. 복귀 링크만으로는 주문이 결제 완료로 표시되지 않습니다. 주문은 Midtrans가 서명된 알림으로 확인했거나, 고객이 돌아올 때 Midtrans 상태 API에 요청하여 확인한 후에만 결제 완료로 표시됩니다. 그 다음 주문이 생성되고, 고객은 사용된 결제 수단과 함께 표준 주문 확인 페이지를 보게 됩니다. 지연 결제의 경우 페이지에 We are waiting for Midtrans to confirm your payment. If you chose a bank transfer, virtual account or convenience store, please complete the payment using the instructions from Midtrans. You will receive an e-mail once the payment is confirmed.가 표시됩니다. 결제 없이 닫힌 주문의 경우 Your Midtrans payment was not completed. Please contact us about this order.가 표시됩니다. 고객이 돌아왔을 때 Midtrans에 연결할 수 없으면, Payment confirmation 페이지에 We are confirming your payment with Midtrans. The order will be updated automatically — please do not pay again.가 표시되고 Check again 버튼이 함께 나타납니다.

고객이 결제하지 않고 Snap 페이지를 떠났다면, 체크아웃으로 돌아가 The Midtrans payment was not completed. You can try again below.를 보게 됩니다. 결제가 거부되었거나 만료되었다면 메시지는 Your Midtrans payment was declined or has expired. Please try again or choose another payment method.입니다. 장바구니는 유지됩니다. 고객이 다시 결제하면 같은 금액의 미사용 또는 대기 중인 Snap이 재사용됩니다. 금액이 바뀌었다면, 먼저 Midtrans에서 대기 중인 거래가 만료 처리됩니다. 그 사이에 이전 Snap이 결제되었다면 주문이 생성되고 새 거래는 만들어지지 않습니다. 주문이 이미 존재하고 결제 없이 닫혔다면 메시지는 Your Midtrans payment was declined or has expired. Please place a new order or contact us.입니다.

Midtrans가 결제를 시작할 수 없으면 고객은 짧은 메시지와 함께 체크아웃에 머무릅니다: Could not connect to Midtrans. Please try again in a moment., Midtrans payments are temporarily unavailable. Please choose another payment method or contact us.(예: 잘못된 Server Key인 경우) 또는 Midtrans가 알려 준 사유입니다. 기술적 사유는 로그에 기록됩니다. IDR이 아닌 장바구니에는 Midtrans only supports payments in IDR (Indonesian Rupiah). Please choose another payment method.가 표시됩니다.

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

모듈은 Snap Redirect만 사용합니다. Snap 팝업, 쇼핑몰 사이트의 카드 입력 양식, 저장된 카드나 원클릭 결제, 할부 또는 프로모션 설정(결제 수단은 Midtrans 대시보드에서 구성합니다), 구독은 없습니다. 카드 결제는 즉시 청구되며, 승인과 캡처가 나뉘어 있지 않습니다.

주문 및 환불

주문 상태

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

Awaiting Midtrans payment: 고객이 지연 결제 수단(가상계좌, 편의점)을 선택했거나, 완료되지 않은 카드 결제를 시작했습니다. Midtrans가 결제를 알리면 주문이 결제 완료가 됩니다.

Payment accepted, Delivered 또는 Midtrans payment on hold: 결제가 확인되었습니다. 상태는 Status after payment 설정을 따릅니다. 결제는 Midtrans 거래 ID와 함께 기록되며, 메모에는 결제 수단과 Midtrans 주문 ID가 표시됩니다.

Midtrans payment on hold: 카드 결제가 사기 검토 중일 때(challenge, 아직 결제가 기록되지 않음), 결제된 금액이나 통화가 주문과 일치하지 않을 때(주문은 결제 완료로 표시되지 않음), 또는 취소된 주문에 결제가 들어왔을 때(주문은 자동으로 다시 열리지 않음)에도 설정됩니다. 메모에 이유가 설명되어 있습니다. 주문을 확인한 다음 처리하거나 결제를 환불하십시오.

Canceled: 미결제 거래가 만료되었거나 취소되었습니다. 미결제 Midtrans 주문을 직접 취소하면, 발급된 가상계좌 같은 대기 중인 Midtrans 거래도 만료되어 더 이상 결제할 수 없게 됩니다.

Payment error: 결제가 실패했거나, 검토 중이던 카드 결제가 거부되었습니다.

Refunded: 결제가 전액 환불되었습니다.

이미 결제 완료된 주문에 두 번째 결제가 들어오면 주문은 변경되지 않습니다. 메모에서 Midtrans 대시보드를 통해 두 번째 결제를 환불하라고 안내합니다. 환불된 주문에 대한 결제는 메모만 추가합니다.

Midtrans 결제 블록

주문 페이지에는 Midtrans payment 블록이 표시되며, Midtrans 주문 ID, 거래 ID(결제가 이루어진 환경의 Midtrans 대시보드 거래로 연결됨), 결제 수단, 상태, 결제 금액과 환불 금액, 샌드박스 결제를 위한 Sandbox 배지, 환불 내역, 주문의 Midtrans notes가 포함됩니다.

환불

Midtrans payment 블록에서 금액을 입력하십시오(아직 환불되지 않은 금액이 자동으로 채워집니다). 필요하면 사유를 입력하고 Refund via Midtrans를 클릭하십시오. Refund this amount through Midtrans? This cannot be undone. 확인 창에서 확인하십시오. 전액 및 부분 환불은 정수 루피아 단위로 지원되며, 소수점이 있는 금액은 거부됩니다. 주문을 편집할 권한이 있어야 합니다. 주문이 나중에 편집되었더라도, Midtrans가 실제로 청구한 금액까지 환불할 수 있습니다. 환불은 결제가 이루어진 환경으로 전송되므로, 해당 환경의 Server Key가 설정되어 있어야 합니다. Midtrans는 일부 결제 수단과 거래 상태에 대해서만 API 환불을 허용합니다(예: 정산된 카드 결제, GoPay, QRIS 또는 ShopeePay 결제). Midtrans가 환불을 허용하지 않으면 블록에 오류가 표시되고 환불은 기록되지 않습니다. 이 경우 Midtrans 대시보드에서 환불하십시오. 환불이 성공하면 환불 내역과 메모에 추가됩니다. 전액 환불은 주문을 Refunded로 설정합니다. 부분 환불은 상태를 바꾸지 않습니다. 환불은 Midtrans가 결제가 정산되었다고 알린 후에 사용할 수 있습니다.

모듈은 크레딧 전표를 만들지 않습니다. 주문 페이지의 표준 PrestaShop 환불 버튼은 Midtrans를 통해 돈을 돌려보내지 않습니다.

Midtrans 대시보드에서 처리한 환불은 알림을 통해 도착하며, Refunded in the Midtrans dashboard라는 사유와 함께 환불 내역에 자동으로 추가됩니다. 결제 전액이 그곳에서 환불되면 주문은 Refunded가 됩니다.

라이선스 키

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

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

키 하나는 도메인 하나에서 작동합니다. 멀티스토어 설정에서도 기본 쇼핑몰의 도메인에 해당합니다. 쇼핑몰에서 키를 제거해도 도메인 슬롯은 해제되지 않습니다. vibefox.net 계정에서 슬롯을 해제하십시오.

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

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

문제 해결

Midtrans does not appear at checkout: 라이선스가 활성 상태인지, Enable/Disable이 켜져 있는지, 선택한 Environment에 Server Key가 있는지 확인하십시오. 장바구니 통화가 IDR인지 확인하십시오. Payment > Preferences에서 모듈이 IDR, 고객의 국가, 고객의 그룹에 대해 허용되어 있는지 확인하십시오. 키가 없거나 쇼핑몰 통화가 IDR이 아니면 설정 페이지에 경고가 표시됩니다.

The payment went through, but no order was created: 알림이 작동하지 않고 있습니다. 사용 중인 환경(샌드박스 또는 운영)의 Midtrans 대시보드에 결제 알림 URL이 설정되어 있는지, Notification URL에 표시된 URL과 정확히 일치하는지, 그리고 접근 가능한지 확인하십시오. 브라우저에서 열면 짧은 설명이 표시됩니다. 알림을 보려면 Debug log를 켜십시오. 고객이 결제 후 쇼핑몰로 돌아와도 주문이 생성됩니다.

Notification answers Invalid signature: 알림이 설정된 Sandbox 또는 Production Server Key로 서명되지 않았습니다. 설정의 키가 알림을 보내는 대시보드와 같은 Midtrans 계정에 속하는지 확인하십시오.

Notification answers Server key not configured: Server Key가 설정되지 않았습니다. 설정에 입력하십시오. Midtrans가 알림을 다시 보냅니다.

Notification answers Order not found — ignored: 이 Midtrans 주문 ID는 이 쇼핑몰이 발급한 것이 아닙니다. 예를 들어 같은 Midtrans 계정을 사용하는 다른 쇼핑몰이 발급한 경우입니다. 쇼핑몰마다 서로 다른 Order ID prefix를 지정하십시오.

Notification answers Environment mismatch — ignored: 알림이 결제가 이루어진 환경과 다른 환경의 키로 서명되었습니다.

Notification answers Verification failed, please retry: Midtrans 상태 API에 연결할 수 없었습니다. Midtrans가 알림을 다시 보냅니다.

Notification answers Busy, please retry: 같은 순간에 다른 요청이 장바구니를 업데이트하고 있었거나, 주문을 생성할 수 없었습니다(예: 모듈이 비활성화됨). Midtrans가 알림을 다시 보냅니다. 사유는 로그를 확인하십시오.

The order is Midtrans payment on hold: 블록의 Midtrans notes를 읽어 보십시오. 카드 결제가 사기 검토 중이거나, 결제된 금액 또는 통화가 주문과 일치하지 않거나, 주문이 취소된 후에 결제가 들어온 경우입니다.

The customer sees an error when choosing Midtrans: 모듈 페이지의 Log 필드를 확인하십시오. 오류는 항상 기록됩니다. 잘못된 Server Key는 Midtrans 결제를 일시적으로 사용할 수 없다는 메시지를 표시합니다.

Refund fails: 결제 수단 또는 거래 상태가 API 환불을 허용하지 않습니다. Midtrans 대시보드에서 환불하십시오. 환불은 자동으로 주문에 기록됩니다. 메시지가 주문이 결제된 환경에 Server Key가 설정되어 있지 않다고 말하면, 해당 키를 입력하고 다시 시도하십시오.

개발자는 actionWcpMidtransSnapPayload 훅으로 Midtrans에 전송되는 데이터를 변경할 수 있습니다. 주문 ID와 금액은 변경할 수 없습니다.

제거

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

Midtrans는 각 소유자의 상표입니다. 이 모듈은 Midtrans와 제휴하거나 Midtrans의 승인을 받지 않았습니다.