VibeFox Worldline for PrestaShop — 도움말

요구 사항

PrestaShop: 8.0 ~ 9.x.

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

Worldline 계정: Worldline Direct(구 Ingenico Direct) 가맹점 계정. 테스트 계정과 실결제 계정은 별도이며 자격 증명이 서로 다릅니다. 계정마다 가맹점 ID(PSPID), API Key ID와 해당 Secret API Key, 웹훅 키와 해당 secret이 필요합니다. 이 항목들은 모두 Worldline Merchant Portal에서 생성합니다(설정 참조).

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

설치

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

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

3. VibeFox 라이선스 키를 Configure 페이지 상단 라이선스 블록의 License key에 붙여 넣고 Activate를 클릭합니다(라이선스 키 참조).

4. 테스트 자격 증명을 입력하고 Save를 클릭한 다음 Test credentials를 클릭합니다.

5. 테스트 계정의 Merchant Portal에서 웹훅 URL을 추가하고 웹훅 키와 secret을 입력합니다(설정 참조).

6. Enable/Disable을 켜고 테스트 결제를 진행합니다. 그다음 실결제 자격 증명을 입력하고, 실결제 계정에서도 웹훅 설정을 반복한 후 Live credentials를 클릭하고 Test Mode를 끕니다.

설치할 때 모듈은 주문 상태 두 개, Awaiting Worldline capture와 Worldline payment on hold를 생성합니다. PrestaShop은 그 시점에 활성화된 국가에 대해 새 결제 모듈을 켭니다. Payment > Preferences에서 통화, 국가, 고객 그룹을 확인하고, 나중에 추가하는 국가는 그곳에서 체크하십시오.

설정

모든 설정은 모듈 페이지에 있습니다: Modules > Module Manager > VibeFox Worldline Gateway > Configure. 각 섹션에는 전체 페이지를 저장하는 자체 Save 버튼이 있습니다. 필드 위에서 현재 모드의 자격 증명(Merchant ID, API Key ID, Secret API Key)이 불완전하면 페이지가 경고합니다. 이 경우 체크아웃에서 결제 수단이 숨겨지기 때문입니다. 테스트 모드가 켜져 있는 동안 페이지에는 Test mode is on (pre-production environment): no real money is charged.가 표시됩니다.

Worldline (Ingenico)

Enable/Disable: Enable Worldline Gateway는 결제 수단을 켜거나 끕니다. 기본값: 끔.

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

Description: 체크아웃에서 결제 수단 아래에 표시되는 텍스트입니다. 기본값: Pay securely via Worldline.

Worldline Direct API

자격 증명은 테스트 계정과 실결제 계정의 Worldline Merchant Portal에서 얻습니다. PSPID가 Merchant ID입니다. Developer > Payment API에서 API Key ID와 Secret API Key를 만들고, Developer > Webhooks에서 웹훅 키와 secret을 만듭니다. 이 섹션에는 두 포털과 Worldline 문서로 연결되는 링크가 있습니다.

Test Mode: API 엔드포인트와 자격 증명을 함께 전환합니다. 테스트 모드는 사전 프로덕션 환경과 테스트 자격 증명을, 실결제 모드는 프로덕션 환경과 실결제 자격 증명을 사용합니다. 기본값: 켬. 실제 결제를 받으려면 끄십시오. 테스트 모드가 켜져 있는 동안 고객은 결제 수단 아래에서 Test mode — no real money is charged.를 봅니다.

테스트 계정(사전 프로덕션)

Test Merchant ID (PSPID): 테스트 계정의 PSPID입니다.

Test API Key ID: 테스트 계정의 Developer > Payment API에서 만든 API Key ID입니다.

Test Secret API Key: 해당 API Key ID에 속한 Secret API Key입니다.

Test Webhook Key ID: 선택 사항입니다. 설정하면 이 키로 보낸 웹훅만 허용됩니다.

Test Webhook Secret: 테스트 계정의 웹훅 secret입니다. 모든 웹훅의 서명을 확인하는 데 사용됩니다.

실결제 계정(프로덕션)

Live Merchant ID (PSPID): 실결제 계정의 PSPID입니다.

Live API Key ID: 실결제 계정의 Developer > Payment API에서 만든 API Key ID입니다.

Live Secret API Key: 해당 API Key ID에 속한 Secret API Key입니다.

Live Webhook Key ID: 선택 사항입니다. 설정하면 이 키로 보낸 웹훅만 허용됩니다.

Live Webhook Secret: 실결제 계정의 웹훅 secret입니다.

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

Clear saved secrets: secret을 체크하고 Save를 클릭하면 삭제됩니다. 필드가 비어 있으면 저장된 값이 유지됩니다.

Check credentials: Test credentials 및 Live credentials 버튼은 Worldline에 테스트 호출을 보내 각 계정의 저장된 자격 증명을 확인합니다. 먼저 변경 사항을 저장하십시오. 결과는 페이지 상단에 나타나며, 예를 들어 Test credentials: connection successful., API credentials are not configured., 또는 Worldline이 반환한 오류가 표시됩니다.

웹훅

웹훅은 고객이 쇼핑몰로 돌아오지 않더라도, 예를 들어 브라우저를 닫았거나 결제가 나중에 확인된 경우에도 결제 정보를 쇼핑몰에 알려 줍니다. Merchant Portal에서 테스트 계정의 Developer > Webhooks를 열고, 이 섹션의 Endpoint URL에 표시된 URL을 추가합니다. 친숙한 URL을 사용하는 경우 https://your-shop/module/wcp_worldline_gateway/webhook처럼 보이며, /en/ 같은 언어 코드가 붙을 수도 있습니다. URL은 설정에 표시된 그대로 정확히 복사하십시오. 리디렉션 없이 응답해야 합니다. 그다음 웹훅 키 ID와 secret을 Test Webhook Key ID 및 Test Webhook Secret에 입력합니다. 실결제 계정에서도 실결제 항목으로 같은 작업을 하십시오.

모듈은 Worldline의 엔드포인트 검증 요청에 자동으로 응답합니다. 결제 이벤트(결제 상태 변경)와 환불 이벤트(환불 상태 변경)를 처리합니다. 다른 이벤트는 수락되지만 무시됩니다. 유효한 서명이 없는 웹훅은 거부됩니다. 이벤트는 결제가 이루어진 계정의 secret으로 서명되어야 하므로, 테스트 웹훅이 실결제를 확정하는 일은 없습니다. 웹훅이 자신을 서명한 계정의 Merchant ID와 다른 Merchant ID에서 왔다면 역시 무시됩니다. 웹훅이 없으면 고객이 결제 후 쇼핑몰로 돌아왔을 때만 주문이 생성됩니다.

결제 페이지 및 주문

Payment page template: Merchant Portal에 업로드된 호스티드 결제 페이지 템플릿(변형)의 이름입니다(선택 사항). 예: SimplifiedCustomPaymentPage. 기본 Worldline 페이지를 사용하려면 비워 두십시오.

Order Status After Payment: Worldline이 캡처된 결제를 확인한 후의 주문 상태입니다. 결제는 항상 직접 판매(승인 및 캡처)로 요청됩니다.

승인된 결제는 Awaiting Worldline capture 상태에서 대기합니다. 금액 또는 통화가 일치하지 않으면 항상 Worldline payment on hold로 이동합니다.

고급

Logging: 모든 API 요청과 웹훅을 모듈 폴더의 logs/wlg_debug.log.php에 기록합니다. 이 파일은 웹에서 열 수 없습니다. 오류와 경고는 이 옵션이 꺼져 있어도 항상 기록됩니다. 키, 카드 정보, 개인정보는 마스킹됩니다. 기본값: 끔.

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

Delete Data: 켜면 모듈을 제거할 때 모듈 설정과 로그가 삭제됩니다. Worldline 거래와 환불, 그리고 모듈의 주문 상태는 항상 유지됩니다. 기존 주문이 환불을 위해 이들을 필요로 하기 때문입니다. 기본값: 끔.

체크아웃

결제 단계에서 고객은 결제 수단(기본값은 Worldline)을 선택하고 확인합니다. 모듈은 장바구니 통화로 장바구니 금액에 대한 Worldline 호스티드 결제 페이지를 만들고 고객을 Worldline 결제 페이지로 보냅니다. 거기서 고객은 카드, 전자지갑 또는 Worldline 계정에서 활성화된 다른 결제 수단으로 결제합니다. 청구자 이름, 주소, 이메일, 전화번호는 Worldline에 전달되며, Worldline이 지원하는 경우 결제 페이지는 고객의 언어로 열립니다. 각 결제 시도에는 장바구니 ID와 임의의 부분으로 이루어진 고유한 참조가 부여됩니다. 이 시점에는 아직 주문이 없습니다.

결제 후 고객은 쇼핑몰로 돌아옵니다. 모듈은 저장된 시도와 대조하여 복귀를 확인하고, 서버에서 Worldline으로부터 결제 상태를 읽습니다. 주문은 Worldline이 확인한 후에만 결제 완료로 표시됩니다. 이는 이 상태 확인 또는 서명된 웹훅을 통해서입니다. 그다음 주문이 생성되고, 고객은 Your payment with Worldline has been received.가 포함된 표준 주문 확인 페이지를 봅니다. 결제가 승인되었지만 아직 캡처되지 않은 경우 페이지에는 Your payment is authorized. The order is confirmed as soon as Worldline confirms the capture.가 표시됩니다. 이런 주문의 결제가 나중에 실패하면 페이지에는 Your Worldline payment was not completed. Please contact us about this order.가 표시됩니다.

결제가 완료되지 않은 경우 주문은 생성되지 않고, 장바구니는 유지되며, 고객은 다음 메시지와 함께 체크아웃으로 돌아갑니다:

상태를 아직 확인할 수 없는 경우 Payment confirmation 페이지에 We could not confirm your payment yet. If you completed the payment, please do not pay again — you will receive a confirmation as soon as Worldline confirms it.가 표시되며, Check again 및 Back to checkout 버튼이 함께 나옵니다. 웹훅이 도착하는 즉시 주문이 생성됩니다.

고객이 같은 장바구니로 다시 결제하는 경우, 모듈은 먼저 이전 시도를 확인합니다. 그 사이에 결제가 완료되었다면 고객은 바로 주문 확인 페이지로 이동하며 이중으로 청구되지 않습니다. 이전 결제 페이지가 같은 금액과 모드로 아직 열려 있고 30분 이내에 만들어졌다면 고객은 그 페이지로 돌아갑니다.

Worldline이 결제를 시작할 수 없으면 고객은 Payment error: Could not create checkout session. Please try again.와 함께 체크아웃에 머무릅니다. 이유는 로그에 기록됩니다. 현재 모드의 자격 증명이 없으면 고객에게는 This payment method is not available at the moment. Please choose another payment method.가 표시됩니다.

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

모듈은 Worldline 페이지에서 일회성 결제를 직접 판매로 처리합니다. 저장된 카드나 토큰화, 구독, 임베디드 카드 양식, PrestaShop에서 승인 후 캡처 또는 취소하는 승인 전용 모드, 추가 수수료, 웹훅 자동 등록은 지원하지 않습니다.

주문 및 환불

주문 상태

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

Payment accepted or Delivered: 결제가 캡처되었습니다. 상태는 Order Status After Payment를 따릅니다. 결제는 Worldline 결제 ID를 거래 ID로 하여 기록되며, 메모에는 금액, 결제 ID, 확인 방식(서명된 웹훅 또는 상태 확인)이 표시됩니다.

Awaiting Worldline capture: Worldline이 결제를 승인됨 또는 캡처 요청됨으로 보고했지만 아직 캡처되지 않았습니다. 아직 결제가 기록되지 않았습니다. 웹훅이 캡처를 확인하면 주문은 결제 완료 상태로 넘어갑니다. 메모에 결제가 캡처되지 않았다고 나오면 Worldline Merchant Portal에서 캡처하십시오.

Worldline payment on hold: 결제가 장바구니와 일치하지 않습니다. 예를 들어 금액이나 통화가 다르거나(결제가 시작된 후 장바구니가 변경됨), 결제가 다른 시도에 속하는 경우입니다. 메모에는 결제된 금액, 주문 합계, 참조가 표시됩니다. 주문을 확인하여 처리하거나 결제를 환불하십시오.

Payment error: 캡처를 기다리던 주문의 결제를 Worldline이 거절하거나 취소했습니다.

Refunded: 결제가 모듈을 통해 전액 환불되었습니다.

취소되었거나 환불된 주문에 대해 결제가 들어오면 주문은 다시 열리지 않습니다. 메모는 Worldline Merchant Portal에서 결제를 환불 또는 취소하거나 주문을 수동으로 복원하라고 안내합니다. 돌아온 고객에게는 Your payment was received after this order had been cancelled. Please contact us — we will restore the order or refund the payment.가 표시됩니다. 이미 결제 완료된 주문에 대해 두 번째 결제가 들어오면 주문은 변경되지 않습니다. 메모는 Worldline Merchant Portal에서 두 번째 결제를 환불하라고 안내합니다.

Worldline 결제 블록

주문 페이지에는 Worldline payment 블록이 표시되며, 결제 ID, 가맹점 참조, 호스티드 결제 페이지, 시도 상태, 청구된 금액과 환불된 금액, 테스트 결제용 Test environment 배지, 환불 내역, 주문의 Payment notes가 포함됩니다.

환불

Worldline payment 블록에 금액을 입력하고(아직 환불되지 않은 금액이 자동으로 채워집니다), 필요하면 사유를 입력한 뒤 Refund via Worldline을 클릭합니다. Refund this amount through Worldline? This cannot be undone. 질문을 확인하십시오. 전액 환불과 부분 환불을 지원합니다. 결제는 캡처되어 있어야 합니다. 주문을 편집할 권한이 필요하며, 모듈 페이지에 접근할 권한은 필요하지 않습니다. 환불은 Worldline이 청구한 금액과 통화로 이루어지므로, 금액 또는 통화가 일치하지 않은 후에는 주문 합계가 아니라 고객이 실제로 결제한 금액까지만 환불할 수 있습니다. 환불은 항상 원래 결제의 환경(테스트 또는 실결제)으로, 해당 계정의 자격 증명을 사용해 전송되므로 자격 증명이 설정되어 있어야 합니다. 시간 초과 후 재시도된 환불은 두 번 실행되지 않으며, 한 주문에 대해서는 한 번에 하나의 환불만 실행됩니다. Worldline이 환불을 거부하면 블록에 오류가 표시되고 환불은 기록되지 않습니다. 승인된 환불은 Worldline 환불 ID와 상태와 함께 환불 내역과 메모에 추가됩니다. 전액 환불은 주문을 Refunded로 설정합니다. 부분 환불은 상태를 바꾸지 않습니다.

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

Worldline의 환불 상태 변경은 웹훅으로 도착하여 환불 내역을 업데이트하고 메모에 추가됩니다. Merchant Portal에서 이루어진 환불은 주문 상태를 바꾸거나 크레딧 슬립을 만들지 않습니다. 필요하면 수동으로 업데이트하십시오.

라이선스 키

모듈은 vibefox.net에서 발급받은 VibeFox 라이선스 키로 작동합니다. License — VibeFox Worldline Gateway 라이선스 블록은 Modules > Module Manager > VibeFox Worldline Gateway > Configure 페이지에서 설정 위에 있는 첫 번째 블록입니다. 키를 License key에 붙여 넣고 Activate를 클릭하십시오. 그러면 블록에 마스킹된 키, 상태(예: 라이선스 만료일과 도메인), 그리고 Check now(상태 다시 확인), Change key(다른 키 입력), Remove key(이 쇼핑몰에서 키 제거) 버튼이 표시됩니다. 그 아래에는 Product: presta-payment-worldline 줄과 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 계정에서 슬롯을 해제하십시오.

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

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

문제 해결

체크아웃에 Worldline이 나타나지 않습니다: 라이선스가 활성 상태인지, Enable/Disable이 켜져 있는지, 현재 모드에 Merchant ID, API Key ID, Secret API Key가 있는지 확인하십시오. 테스트 모드에서는 테스트 필드, 실결제 모드에서는 실결제 필드입니다. 없으면 설정 페이지에 경고가 표시됩니다. Payment > Preferences에서 장바구니 통화, 고객의 국가, 고객 그룹에 대해 모듈이 허용되어 있는지 확인하십시오.

결제는 완료되었지만 주문이 생성되지 않았습니다: 웹훅이 작동하지 않고 있습니다. 사용 중인 계정(테스트 또는 실결제)의 Merchant Portal에서 엔드포인트가 있는지, 그리고 URL이 Endpoint URL에 표시된 것과 정확히 같고 리디렉션이 없는지 확인하십시오. 해당 계정의 웹훅 secret이 맞는 필드(Test Webhook Secret 또는 Live Webhook Secret)에 있는지, 그리고 웹훅 키 ID 필드가 비어 있거나 키와 일치하는지 확인하십시오. 고객이 결제 후 쇼핑몰로 돌아와도 주문은 생성됩니다.

웹훅이 Webhook secret not configured로 응답합니다: 웹훅 secret이 설정되어 있지 않습니다. 설정에 웹훅 secret을 입력하십시오. Worldline은 웹훅을 다시 시도합니다.

웹훅이 Invalid signature로 응답합니다: 웹훅 secret이 다른 계정이나 다른 키의 것이거나, 웹훅 키 ID가 웹훅을 보낸 키와 일치하지 않습니다. 테스트와 실결제 secret이 뒤바뀌지 않았는지 확인하십시오.

웹훅이 Missing signature, Empty body 또는 Invalid JSON으로 응답합니다: 요청이 예상된 형식으로 Worldline에서 오지 않았거나, 프록시 또는 리디렉션이 요청을 바꾸었습니다. URL이 리디렉션 없이 응답하는지 확인하십시오.

웹훅이 Ignored로 응답합니다: 해당 웹훅은 그 모드 설정의 Merchant ID와 다른 Merchant ID에서 왔습니다. Test Merchant ID (PSPID) 또는 Live Merchant ID (PSPID)를 확인하십시오.

웹훅이 Retry later로 응답합니다: 같은 순간 다른 요청이 주문을 확인하고 있었거나, 주문을 생성할 수 없었습니다(예: 모듈이 비활성화됨). Worldline은 웹훅을 다시 시도합니다. 이유는 Log 필드를 확인하십시오.

브라우저에서 웹훅 URL이 Method not allowed를 표시합니다: 정상입니다. 이 URL은 Worldline의 요청만 허용합니다.

Test credentials 또는 Live credentials에 오류가 표시됩니다: 먼저 설정을 저장한 다음, 가맹점 ID, API Key ID, Secret API Key가 같은 계정에서 온 것인지, 테스트 값은 테스트 필드에, 실결제 값은 실결제 필드에 있는지 확인하십시오.

고객이 Worldline을 선택할 때 오류가 표시됩니다: 모듈 페이지의 Log 필드를 확인하십시오. Logging이 꺼져 있어도 오류는 기록됩니다. 요청의 전체 세부 정보를 보려면 Logging을 켜고 다시 시도하십시오.

테스트 결제가 실결제를 확인하지 않습니다: 테스트와 실결제는 분리되어 있습니다. 원하는 모드로 Test Mode를 전환하고 해당 계정의 자격 증명과 웹훅을 사용하십시오.

결제 후 주문이 Worldline payment on hold 또는 Awaiting Worldline capture 상태입니다: Worldline payment 블록의 메모를 읽어 보십시오(주문 상태 참조). Worldline이 아직 캡처를 확인하지 않았거나(웹훅이 주문을 완료합니다), 결제된 금액 또는 통화가 장바구니와 달랐습니다.

환불이 환경 관련 메시지와 함께 실패합니다: 결제가 테스트 또는 실결제 환경에서 이루어졌는데, 그 환경의 자격 증명이 설정되지 않았습니다. 자격 증명을 입력하고 다시 시도하십시오.

개발자: 훅 actionWlgHostedCheckoutData는 호스티드 결제 요청을 전송하기 전에 변경합니다. 예를 들어 표시되는 결제 수단을 제한하는 데 사용할 수 있습니다.

제거

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

Worldline은 각 소유자의 상표입니다. 이 모듈은 Worldline과 관련이 없으며 Worldline의 승인을 받지 않았습니다.