PG payment
PG payment can be used on PC and mobile.
PG Payment Policy¶
Category | Description |
Language |
|
Function |
|
National Support |
|
Payment Method |
|
PG Payment Currency |
|
Price Tier |
|
Product Management |
|
Refund User Repayment |
|
PG Payment Process¶
① Select a product to purchase in the in-game store
② Expose the payment method selection screen in the web view outside the game screen
- Language: Game language
- Currency: hive_country to which the SDK delivers. If there is none, the country is checked by IP and exposed as the currency of the country
- The product name for payment is displayed in Console > Billing > IAP v4 > Market PID Management. If there is no product name in the language to be exposed, the content entered in the English product name will be displayed.
- The payment method settings can be made in Console > Billing > PG Payment Settings > PG Company Settings
③ Call the PG company's payment page for the country and expose it in the web browser
- Error page is displayed when it's not the payment target country
④ Go to the completion page when payment is completed. The completion page is displayed in the language of the browser.
Implementing PG payment in a web store¶
Please proceed as follows when building a website to sell products.
① Issue two AppIDs by going to Console > App Center.
- AppID for web login
- Select Web login AppID
- Select Usage as Website
- If you have an existing AppID issued for Website usage, you can also use the existing one.
- AppID for payment
- Select game AppID
- Select OS – Windows, Market – Direct distribution
② Set the details of the web login AppID.
- Enter all IdP key values in the login information
- Set login IdP usage
- Enter the site address to return to after login in the redirect URI in the web login action settings
③ Register PG company information by going to Console > Billing > Payment Environment Settings > PG Company Settings.
④ Register the market PID in the payment AppID created in step 1 by going to Console > Billing > In-app Payment > Register Market PID.
⑤ Develop the site with the web login API and web PG payment API.
Pre-work¶
1. PG Payment Platform Settings¶
- When using PortOne
- Register IAP server callback URL and set PG company in PortOne admin console
- Register common URL for sending webhook in PortOne admin console > system settings > webhook setting
- Webhook URL
- Commercial: https://store.withhive.com/payment/result_processing/import
- Sandbox: https://sandbox-store.withhive.com/payment/result_processing/import
- Please Note
- Since PortOne does not provide sandbox payment testing, we suggest the following method for testing.
- Create two PortOne accounts for commercial service and test. The admin account for the PortOne console can create an account regardless of the actual contract.
- Register the commercial URL on the PortOne commercial account, and register actual PG company information, etc. to the live console.
- Register the sandbox URL on the PortOne test account, and register test PG company information, etc. to the sandbox console.
- If only one actual PortOne account is being used for the purpose of commercial service, connect with sandbox upon initial application and change to commercial URL for the official service.
- Do not change to a sandbox address after changing to a commercial URL. Please be noted that actual user payment will be processed as test payment.
- If PortOne console sets the PG company to test, the transaction history is automatically canceled on the following day. Games in commercial service must not be set to test.
- Register IAP server callback URL and set PG company in PortOne admin console
- When using Xsolla
- Request to create a sub-project to the platform business office and issue a Project id and Secret Key
- When using MyCard through a direct contract
- Select MyCard as the service country by going to Console > PG Company Settings and generate a hash key.
- Enter the hash key issued by the console and the IP, URL, and customer company registration information for payment in the Registration Form provided by MyCard and submit it to MyCard. Download the IP and URL information from the attached file below.Download IP & URL Information
- After that, receive the FaServiceID from MyCard and enter it in the PG Company Settings of the Console.
- Please Note
2. Console Settings¶
- Price Tier Settings
- Menu Location: Console > Billing > Store Price Management > Price Tier
- Price Tier Settings Guide Shortcuts
- Register Market PID
- Menu Location: Console > Billing > In-App Purchase > Market PID Registration
- Market PID Registration Guide Shortcuts
- PG Payment Settings
- Menu Location: Console > Billing > Payment Environment Settings > PG Company Settings
- PG Company Settings Guide Shortcuts
PG Company Settings Guide¶
Set up the PG company to be used in the game. Once set up, the PG company cannot be deleted, and can only be deactivated.
① Select Game: Search a game to check the selected PG company. Check the game permissions if you don't see the game list.
② Add Game: Move to the PG company settings page.
③ View Payment Method by Country: Check the payment method by country of the PG company you have set in the pop-up.
④ Modify: Modify the registered PG company details.
Register PG Company By Game
Click the Add Game button to move to the registration page.
① URL to Receive Payment Results: Enter the server URL if you wish to receive payment completion notification.
② Payment Completion Notification Type: Select the notification type when setting payment completion notification. The default option is to "Send payment success information only". If you select "Send all," the server receiving the notification must have branching logic configured for payment success and cancellation types.
③ Service Country: Select the country of use for each PG platform. The bottom entry changes depending on the option selected.
1. Set Up PortOne
- PortOne Information: Enter the same information registered on I'mport console system settings. You must enter the Tier Code if there is a sub-shop. When linking with Naver Pay through direct contract, you must enter the Chain id value.
- PortOne - PG Company Payment Method: The list of PG companies set in the PortOne administrator console is automatically loaded. When selecting a payment method to use, check the PG ID and activate it the same as in the PortOne admin console in case of KCP. If the payment method activated by each PG ID is different from the PortOne manager console, it will not be displayed properly. If you move the horizontal scroll bar to the far right, you will see a button to preview the payment method you have set. If you need a payment test page for a PG contract, copy the URL of the preview page and provide it to the PG company.
2. Set Up Xsolla
- Xsolla Information: Copy and enter the project ID and webhook secret key in Xsolla Console > Project Settings > General Settings.
- Xsolla - PG Company Payment Method: Select a payment method for each supported country. When you click the Preview, all Xsolla's activated payment methods are exposed regardless of the country.
3. Set Up MyCard
- MyCard Information: Enter the FaServiceID provided by MyCard. Authentication number (Hash) Key is automatically generated. Copy the generated HASH KEY, fill out the MyCard registration request form, and submit it to MyCard.
- MyCard - PG Company Payment Method: Only MyCard is provided as a payment method.
PC Payment Inquiry and Cancellation¶
Check all payment details of PortOne or Xsolla on one page and cancel directly if necessary. Terminal 3 of the Paymentwall sends a payment cancellation request instead of an immediate payment cancellation, and whether the cancellation has been completed must be confirmed in the terminal 3 console.
- PG Company and Payment Method
- A list of all PGs provided by the company is provided as an optional selection, regardless of whether the payment method is activated in the PG company settings or not.
- Status
- PG
- Payment Complete - Payment has been successfully completed
- Payment Failed - Payment failed due to errors during payment, etc.
- Payment Pending - Payment is not made immediately due to account transfer, etc.
- Cancellation Request – Request to cancel payment
- Cancellation Complete – Payment is canceled properly. Terminal 3 payment cannot be confirmed whether cancellation has been completed or not
- Cancellation Failed – Cancellation request failed
- Incomplete – Payment is not completed because a user closed the payment window or clicked Cancel Payment before payment
- Steam
- Receive Order
- Accept Payment (User)
- Cancel Payment
- Refund Payment
- Partial Refund Payment
- Illegal Payment
- Order Fraud
- Chargeback Fraud
- Payment Cancellation Failed
- PG
- Total Payment Amount: Total Payment Amount: Sum of all search conditions excluding non-progress
- Number of Purchases Completed: Purchase Completed Counts: Number of completed payments excluding cancellations
- Total Cancellation Amount/Cancellations: Total Cancellation Amount/Cancellation Counts: Total amount and number of canceled cases
- Product price: Product price in the display currency set in Price Tier
- Game_Payload_info: The value received from the game server to be used as an additional indicator in Analytics through the item payment result transmission API
- IAP_Payload: Purchase metadata self-defined by the app developer
- Cautions
- The payment history on the console with the setting value from before the change cannot be canceled if you modify the option value in the PG company configuration.
- Example 1: The existing Xsolla payment data cannot be canceled in Console if you switch from using Xsolla to PortOnein the PG company settings.
- Example 2: Payment history from the time a tier code was used cannot be canceled in the Console if the tier code was used and then erased in the PG company settings.
- If you directly cancel the payment details in the I'mport console, depending on the PG company, the cancellation details may not be delivered to the console so please try to cancel through the panel instead.
- The payment history on the console with the setting value from before the change cannot be canceled if you modify the option value in the PG company configuration.
PC Payment Item Re-processing¶
In this menu, you can check the details of the PG payments that are not completed normally. Click Resend to complete the payment process and pay the purchased product. If the retransmission is successful, it will disappear from the search results.
- Menu Location: Console > Billing > IAP v4 > PG payment completion unprocessed history