Developers
V1
V2
API & SDK

Request non-authenticated payment (one-time) API

Requests payment with credit card information.

POST https://api.iamport.kr/subscribe/payments/onetime

Requests payment with credit card information without customer authentication.

If you pass

customer_uid

, the billing key used for a successful payment will be saved for future payments. If customer_uid is not specified, it will not be saved. You cannot reuse the same

merchant_uid

for another request.

Parameters

Body

merchant_uid*
String

Order ID

currency
currency

Currency code

KRW, USD, VND โ€ฆ

amount*
double

Payment amount

tax_free
double

Tax-free amount

card_number*
String
Credit card number

(dddd-dddd-dddd-dddd)

expiry*
String
Credit card expiration

(YYYY-MM)

birth*
String

6-digit DOB (yymmdd)

(For corporate cards, specify 10-digit business registration number)

pwd_2digit
String

First 2-digits of credit card password

cvc
String

CVC code

(last 3 digits (4 digits for AMEX) of the code at the back of the card). Applicable to Paymentwall only

customer_uid
String

Specify this value to save the card information as billing key and use it for future payments.

pg*
String

PG code

name
String

Product name

buyer_name
String

Customer name

buyer_email
String

Customer email

buyer_tel
String

Customer phone

buyer_addr
String

Customer address

buyer_postcode
String

Customer zip code

card_quota
integer

Number of installment months

interest_free_by_merchant
boolen

Whether or not there are interest-free installments paid by merchants

custom_data
String

Custom data

notice_url
String

Webhook URL for success notification

browser_ip
String

Customerโ€™s browser (PC) IP

secure_3d_charge_id
String

(For overseas PG only) Payment ID issued by PG for another payment after 3D secure authentication

secure_3d_token
String

(For overseas PG only) Token issued by PG for another payment after 3D secure authentication

Responses

200: OK
Success

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like โ€˜Invalid payment infoโ€™.

response (PaymentAnnotation, optional)

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like โ€˜Invalid payment info.

imp_uid * string

iโ€™mport payment transaction UID

merchant_uid * string

Order ID

pay_method * string

Payment method code

channel * string

Payment environment code

  • pc: (authenticated) PC
  • mobile: (authenticated) mobile
  • api: recurring or non-authenticated

pg_provider * string

PG code

emb_pg_provider * string

Hub-type PG code

pg_tid * string

PG transaction ID

pg_id * string

PG MID

escrow boolean

Indicates an escrow payment

apply_num string

Credit card approval number

bank_code string

Bank code

bank_name string

Bank name

card_code string

Credit card code (KFTC Credit Card Codes: link )

card_name string

Credit card name

card_quota integer

Number of installments (0 means one-off)

card_number string

Masked credit card number

card_type string

Credit card type code

  • 0: credit
  • 1: check

vbank_code string

Virtual account bank code (refer to image below)

vbank_name string

Refund virtual account

vbank_holder string

Refund virtual account holder

vbank_date string

Refund virtual account expiration (UNIX timestamp)

vbank_issued_at string

Refund virtual account created at (UNIX timestamp)

name string

Product name

amount * integer

Order (payment) amount

cancel_amount integer

Cancelled amount

currency string

Currency

  • USD
  • KRW
  • EUR

buyer_name string

Customer name

buyer_email string

Customer email

buyer_tel string

Customer phone

buyer_addr string

Customer address

buyer_postcode string

Customer zip code

custom_data string

echo data as JSON string

user_agent string

UserAgent of the device where payment is initiated

status * string

Payment status code

  • ready
  • paid
  • cancelled
  • failed

started_at * string

Payment started at (UNIX timestamp)

paid_at * string

Payment completed at (UNIX timestamp)\

failed_at * string

Payment failed at (UNIX timestamp)

cancelled_at * string

Payment cancelled at (UNIX timestamp)

fail_reason string

Reason for failure

cancel_reason string

Reason for cancellation

receipt_url string

Credit card receipt URL

cash_receipt_issued boolean

Option to automatically issue cash receipt

customer_uid string

customer_uid related to the payment transaction

customer_uid_usage string

customer_uid use code

  • payment.scheduled: scheduled payment
  • payment: payment
  • issue: billing key issuance

cancel_history (Array[PaymentCancelAnnotation], optional):

Cancellation/partial cancellation history

cancel_history array []

pg_tid * string

PG cancellation transaction ID

amount * integer

Cancelled amount

cancelled_at * string

Cancelled at (UNIX timestamp)

reason * string(256)

Reason for cancellation

receipt_url * string(300)

Cancellation receipt URL. Availability varies by PG.
401: Unauthorized
Missing or invalid access token
 
{
  // Response
}

Key request parameter description

merchant_uid * string

Order ID

Must specify a unique value for each payment request

card_numb * string

Credit card number

Use the correct format (DDDD-DDDD-DDDD-DDDD)

expiry * string

Credit card expiration

Use the correct format (YYYY-MM)

birth * string

DOB

Use the correct format (YYMMDD). For corporate cards, specify the 10-digit business registration number

(For foreign cards that donโ€™t require DOB, you can set this to 000000)

pg * string

PG code

This is required when there are multiple API method non-authenticated PG settings in the Admin console. If two MIDs are set for the same PG, specify as follows:

{PG}.{PG Merchant ID}

If you pass an unspecified or invalid value, the payment will be made using the default PG value.

  • If there are two PG settings, Nice Payments and JTNet, set pg parameter to nice or jtnet.

  • If you have multiple Merchant IDs from Nice Payments, set pg parameter to nice.MID1 or nice.MID2.

buyer_name * string

Customer name

When using Paymentwall as PG, you must enter a space between the first name and last name.

Example: Michael Jackson

customer_uid * string

Billing key

If this is specified, the billing key is mapped to this value, and you can only process payments with this customer_uid value in the future.

Response Model Schema

 
{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "merchant_uid": "string",
    "pay_method": "string",
    "channel": "pc",
    "pg_provider": "string",
    "emb_pg_provider": "string",
    "pg_tid": "string",
    "pg_id": "string",
    "escrow": true,
    "apply_num": "string",
    "bank_code": "string",
    "bank_name": "string",
    "card_code": "string",
    "card_name": "string",
    "card_quota": 0,
    "card_number": "string",
    "card_type": "null",
    "vbank_code": "string",
    "vbank_name": "string",
    "vbank_num": "string",
    "vbank_holder": "string",
    "vbank_date": 0,
    "vbank_issued_at": 0,
    "name": "string",
    "amount": 0,
    "cancel_amount": 0,
    "currency": "string",
    "buyer_name": "string",
    "buyer_email": "string",
    "buyer_tel": "string",
    "buyer_addr": "string",
    "buyer_postcode": "string",
    "custom_data": "string",
    "user_agent": "string",
    "status": "ready",
    "started_at": 0,
    "paid_at": 0,
    "failed_at": 0,
    "cancelled_at": 0,
    "fail_reason": "string",
    "cancel_reason": "string",
    "receipt_url": "string",
    "cancel_history": [
      {
        "pg_tid": "string",
        "amount": 0,
        "cancelled_at": 0,
        "reason": "string",
        "receipt_url": "string"
      }
    ],
    "cancel_receipt_urls": [
      "string"
    ],
    "cash_receipt_issued": true,
    "customer_uid": "string",
    "customer_uid_usage": "issue"
  }
}