Settlebank

Settlebank payment window integration guide

1. Configure Settlebank PG settings

Refer to the Settlebank settings page to configure the PG settings.

2. Request payment

To open the payment window, call JavaScript SDK IMP.request_pay(param, callback).

In PC browsers, callback is invoked after calling IMP.request_pay(param, callback). In mobile browsers, the page is redirected to m_redirect_url.

Javascript SDK
IMP.request_pay(
  {
    pg: "settle",
    pay_method: "card",
    merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
    name: "Order name: Test payment request",
    amount: 14000,
    buyer_email: "iamport@siot.do",
    buyer_name: "John Doe",
    buyer_tel: "010-1234-5678", // Required
    buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
    company: "iamport", // Recommended for virtual account payment
    buyer_postcode: "123-456",
    m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
  },
  function (rsp) {
    // callback logic
    //* ...Omitted... *//
  },
);

Key parameter description

pg * string

PG code

If not specified and this is the only PG setting that exists, default PG is automatically set.
If there are multiple PG settings, set to settle.

pay_method * string

Payment method code

Payment method codes

card (credit card)
trans(instant account transfer)
vbank(virtual account)
phone(mobile micropayment)

merchant_uid * string

Order ID

Must be unique for each request.

amount * integer

Payment amount

Must be an integer (not string)

buyer_tel*string

Customer phone number

Required

company`` string

Company name

Required for virtual account payment

Settlebank credit card payment example

You can use i’mport REST API to request payment and schedule payment.

Request one-time payment

To request a one-time payment, use the key-in REST API POST /subscribe/payments/onetime. The card information is not saved during this process.

curl -H "Content-Type: application/json" \
     -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
     https://api.iamport.kr/subscribe/payments/onetime

Request billing key + initial payment

To request a billing key and initial payment, use the key-in REST API POST /subscribe/payments/onetime.

customer_uid : required for saving the billing key.

curl -H "Content-Type: application/json" \
     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
     https://api.iamport.kr/subscribe/payments/onetime

Request payment with billing key

After successfully getting the billing key and making the initial payment, the billing key is stored on the i’mport server mapped 1:1 with the specified customer_uid. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API (POST /subscribe/payments/again) with the customer_uid as follows:

curl -H "Content-Type: application/json" \
     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
     https://api.iamport.kr/subscribe/payments/again

Settlebank does not support Request billing key API.

For detailed information, refer to: