Bank Transfer

How to use BankTransfer to submit a payin in South Korea.

This page describes how to submit a BankTransfer payin in Korea using Pagsmile Checkout Web SDK.

The integration flow contains four steps:

Create a payin order and get the prepay_id.
Include Pagsmile script.
Initialize Pagsmile SDK with the prepay_id.
Trigger the payment.

Korea BankTransfer payins support partial refund.

Korea BankTransfer payins only support integer amounts. Decimal amounts are not supported. The minimum amount is 100 KRW. The maximum amount is not specified because it may be configured based on the user or product.

BankTransfer

For BankTransfer payments, use the following parameter values:

Parameter

Type

Description

method*

string

Fixed value: BankTransfer

order_currency*

string

Fixed value: KRW

Step 1: Get prepay_id

POST https://gateway-test.pagsmile.com/trade/create

Use this endpoint to create a payin order and get the prepay_id.

Request Body

Parameter

Type

Required

Constraints

Description

app_id

string

Yes

Max length: 32 characters

The merchant application ID assigned by Pagsmile.

out_trade_no

string

Yes

Max length: 64 characters; must be unique

The merchant-side order ID.

method

string

Yes

Fixed value: BankTransfer

Payment method.

order_amount

string

Yes

Integer only; minimum: 100 KRW

Payment amount.

order_currency

string

Yes

Fixed value: KRW

Payment currency.

subject

string

Yes

Max length: 128 characters

Order title or product name.

content

string

Optional

Max length: 255 characters

Order description.

notify_url

string

Yes

Valid URL

The URL used to receive asynchronous payment notifications.

return_url

string

Optional

Valid URL

The URL to redirect the customer after payment.

buyer_id

string

Yes

Merchant-defined unique ID

The unique customer ID in the merchant system.

timestamp

string

Yes

Format: yyyy-MM-dd HH:mm:ss; max length: 19 characters

Request timestamp.

customer.email

string

Yes

Valid email

Customer's email address.

Request Sample

{
  "app_id": "162************38",
  "out_trade_no": "2026070306061807238",
  "method": "BankTransfer",
  "order_amount": "1000",
  "order_currency": "KRW",
  "subject": "trade pay test",
  "content": "trade pay test content",
  "notify_url": "http://merchant/callback/success",
  "return_url": "https://www.merchant.com",
  "buyer_id": "buyer_0101_0001",
  "timestamp": "2026-07-03 06:06:18",
  "trade_type": "web"
}

Response

{
  "code": "10000",
  "msg": "Success",
  "prepay_id": "prepay_id_example",
  "trade_no": "trade_no_example",
  "out_trade_no": "2026070306061807238",
  "web_url": "",
  "trade_status": "PROCESSING"
}

Step 2: Include Pagsmile Script

Add the Pagsmile Checkout Web SDK script to the <head> section of your checkout page.

<head>
  <!-- Other head content -->
  <script src="https://res.pagsmile.com/lib/js/pagsmile.min.js"></script>
</head>

Step 3: Initialize Pagsmile SDK

Use Pagsmile.setPublishableKey to initialize the SDK.

Request Parameters

Parameter

Type

Required

Constraints

Description

app_id

string

Yes

Max length: 32 characters

The merchant application ID assigned by Pagsmile.

public_key

string

Yes

Starts with Pagsmile_pk_

The publishable public key assigned by Pagsmile.

env

string

Yes

One of: sandbox, prod

The SDK environment. Use sandbox for testing and prod for production.

region_code

string

Yes

Fixed value: KOR

The region code used to initialize the SDK for Korea Wallet payins.

prepay_id

string

Yes

Returned from Step 1

The Pagsmile prepay ID returned from the Create Payin request.

Sample

<script>
  document.addEventListener('DOMContentLoaded', function() {
    Pagsmile.setPublishableKey({
      app_id: "1649*********8673",
      public_key: "Pagsmile_pk_86fc***************************************************",
      env: "sandbox",
      region_code: "KOR",
      prepay_id: "prepay_id_example"
    }).then((clientInstance) => {
      // Successfully initialized.
      document.getElementById("submit-pay").addEventListener("click", function(e) {
        clientInstance
          .createOrder()
          .then((res) => {
            console.log("res: ", res);
            // {
            //   status: "success",
            //   query: true
            // }
          })
          .catch((err) => {
            console.log("Error: ", err);
          });
      });
    }).catch((err) => {
      console.log("Initializing Pagsmile Error: ", err);
    });
  });
</script>

Step 4: Trigger Payment

After the SDK is initialized successfully, call clientInstance.createOrder() when the customer clicks the payment button.

clientInstance
  .createOrder()
  .then((res) => {
    console.log("res: ", res);
  })
  .catch((err) => {
    console.log("Error: ", err);
  });

Use your own app_id, public_key, and prepay_id when testing or going live. Do not expose any secret key on the frontend.

PreviousWallet Next❌Virtual Account

Last updated 9 days ago