PAYCO

PAYCO simple payment integration guide

1. Configure PAYCO simple payment PG settings

Refer to the PAYCO 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: "payco",
    merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
    name: "Order name: Test payment",
    amount: 14000,
    buyer_email: "iamport@siot.do",
    buyer_name: "Customer name",
    buyer_tel: "010-1234-5678",
    buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
    buyer_postcode: "123-456",
  },
  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 payco.

pay_method string

Payment method code

Payment method codes

card (credit card)
trans(instant account transfer)
vbank(virtual account)

merchant_uid * string

Order ID

Must be unique for each request.

buyer_tel*string

Customer phone number

Required

amount * integer

Payment amount

Must be an integer (not string)

PAYCO payment window example

To open subscription payment window, specify the customer_uid parameter.

amount

For display purpose only. No payment approval.

Javascript SDK
IMP.request_pay(
  {
    pg: "payco",
    merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
    name: "Order name: Billing key request test",
    amount: 0, // For display purpose only
    customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
    buyer_email: "johndoe@gmail.com",
    buyer_name: "John Doe",
    buyer_tel: "02-1234-1234",
  },
  function (rsp) {
    if (rsp.success) {
      alert("Success");
    } else {
      alert("Failed");
    }
  },
);

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 payco.

customer_uid * string

Credit card billing key

Billing key to be mapped 1:1 with the user-entered credit card information.

amount * Integer

Payment amount

For display purpose only. No payment approval.

Request payment with billing key (customer_uid)

After successfully getting the billing key, 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 non-authenticated payment request REST API with the customer_uid as follows:

sever-side
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