LogoLogo
  • 🧩i'mport Payment Integration Docs
    • 🚗GET STARTED
  • 🛫Setup
    • 🖥️1. Create an account
    • 🧷2. Set up PG
      • 🏢Payment gateway settings
        • ⌨️NHN KCP
        • ⌨️KG INICIS
        • ⌨️NICE Payments
        • ⌨️Toss Payments
        • ⌨️KICC
        • ⌨️Paymentwall
        • ⌨️Daou
        • ⌨️다날 설정
        • ⌨️JTNET 설정
        • ⌨️세틀뱅크 설정
        • ⌨️KG모빌리언스 설정
        • ⌨️스마트로 설정
        • ⌨️페이팔 설정
        • ⌨️엑심베이 설정
        • ⌨️블루월넛 설정
      • ⛺간편 결제사
        • ⌨️카카오페이 설정
        • ⌨️토스간편결제 설정
        • ⌨️네이버페이(결제형) 설정
        • ⌨️페이코 설정
        • ⌨️차이 설정
        • ⌨️알리페이 설정
    • ✔️3. Check required info
  • Payment window
    • 🖥️Authenticated payment
      • 📒Definition
      • 🌠1. Add i'mport library
      • 💡2. Initialize IMP object
      • 🪧3. Request payment
      • 🎁4. Process payment result
        • 🪟Iframe method
        • 🖼️Redirect method
      • 🔦5. Verify payment information
      • 🛬6. Complete payment
    • ⏰Non-authenticated payment
      • 🏍️Request billing key payment
        • 🖱️REST API
        • 🛡️PG window
      • 💳Key-in payment using card info
      • 🪧Subscription payment using billing key
    • 💸Payment cancellation (refund)
      • 💷Virtual account refund
  • Payment result
    • ⚒️Set up a webhook
  • Other Services
    • 📱Mobile identity verification
      • 📔1. Prepare for verification
      • 🥏2. Request verification
      • 🚚3. Send verification result
      • 🤹4. Get verification info
    • 🚚Integrated identity verification
      • 📒Prepare for verification
      • 🥏Request verification
      • 🚚Send verification result
      • 🤹Get verification info
    • 💳Credit card identity verification
      • 📒1. Prepare for verification
      • 🥏2. Request verification
      • 🚚3. Send verification result
      • 🤹4. Get verification info
    • 💻Generate payment URL
    • 🛩️Integrate budget handler
    • 📟Native mobile SDKs
  • TIPS
    • 🌽Tax exemption on payments
    • ✅Service launch checklist
    • 🔏Confirm Process
    • 🎼i'mport payment flow
    • 🎈Agency & Tier
    • 📦Billing key issuance by PG
    • 🏦Bank codes by PG
    • 🧾PG codes
    • 🚚Courier codes
    • 🪧What is redirection?
    • 📰PG error codes
  • Admin console
    • 🎡Admin console guide
      • Apply for online payment
      • My ID & API keys
      • Manage admin & sub-merchant accounts
      • Integrate payment
      • Payment activity
    • 💻Integrating Multiple PGs
  • API
    • 📋i'mport API overview
    • 🖇️REST API Access Token
    • 💳Payment API
      • ⌨️Cancel payment API
      • ⌨️Get payment API
      • ⌨️Get payments API
      • ⌨️Get payments by status API
      • ⌨️Get payments by order ID, status (All)
      • ⌨️Get payments by order ID, status (Top 1)
      • ⌨️Get balance API (for split payment transaction)
      • ⌨️Get payments by billing key API
      • ⌨️Save payment amount API
      • ⌨️Update payment amount API
      • ⌨️Get payment amount API
    • 📝Billing key API
      • ⌨️Request billing key API
      • ⌨️Delete billing key API
      • ⌨️Get billing key API
      • ⌨️Get billing keys API
      • ⌨️Get scheduled payments API
    • 🧭Subscription payment API
      • ⌨️Schedule payment API
      • ⌨️Cancel scheduled payment API
      • ⌨️Get scheduled payments API
      • ⌨️Get scheduled payment API
      • ⌨️Get scheduled payments by billing key API
    • 🪂Non-authenticated payment API
      • ⌨️Request non-authenticated payment (billing key) API
      • ⌨️Request non-authenticated payment (one-time) API
    • 🇺🇲🇺🇲 Overseas PG API
      • ⌨️Paymentwall delivery API
    • 👮‍♂️👮♂ Identity verification API
      • ⌨️Get identity verification result API
      • ⌨️Delete identity verification API
      • ⌨️Request identity verification API
      • ⌨️Confirm identity verification API
    • 🎫Simple payment service API
      • 🧽Kakao Pay
        • ⌨️Get order API
      • 🛩️KCP Quick Pay
        • ⌨️Delete user API
      • 🧰PAYCO
        • ⌨️Update order status API
      • 📗Naver Pay
        • ⌨️Confirm escrow order API
        • ⌨️Accrue points API
        • ⌨️Get cash receipt amount API
    • 🏦Escrow API
      • ⌨️Get delivery info API
      • ⌨️Add delivery info API
      • ⌨️Update delivery info API
    • 💵Cash receipt API
      • ⌨️Cancel cash receipt transaction API
      • ⌨️Get cash receipt API
      • ⌨️Request cash receipt API
      • ⌨️Cancel cash receipt (external) API
      • ⌨️Get cash receipt (external) API
      • ⌨️Request cash receipt (external) API
    • 🏛️Virtual account API
      • ⌨️Request virtual account API
      • ⌨️Cancel virtual account API
      • ⌨️Update virtual account API
      • ⌨️Get account holder API
    • 🍶Miscellaneous API
      • 🎽Benepia point
        • ⌨️Get points API
        • ⌨️Request point payment API
      • 🏪Convenience store payment
        • ⌨️Request barcode API
        • ⌨️Cancel barcode API
      • 🗃️Financial institution codes
        • ⌨️Get credit card codes (All) API
        • ⌨️Get credit card name API
        • ⌨️Get bank codes (All) API
        • ⌨️Get bank name API
      • 🛖PG information
        • ⌨️Get PG MIDs API
  • SDK
    • 📚Javascript SDK
      • 💿Payment request parameters
      • 📀Payment response parameters
      • 💿Identity verification request parameters
      • 📀Identity verification response parameters
      • ✏️SDK Release Notes
  • FAQ
    • ⁉️FAQ
  • 🔑Payment integration by PG
    • 🏢Payment gateways
      • ⌨️NHH KCP
      • ⌨️KG INICIS
      • ⌨️Toss Payments
      • ⌨️NICE Payments
      • ⌨️KICC
      • ⌨️Daou (PAYJOA)
        • 📍Precautions for using PAYJOA
      • ⌨️KG Mobilians
      • ⌨️Paymentwall
      • ⌨️Danal
      • ⌨️Settlebank
      • ⌨️JTNET
      • ⌨️Smartro
      • ⌨️PayPal
      • ⌨️Eximbay
      • ⌨️Blue Walnut
    • ⛺Simple payments
      • ⌨️Naver Pay (Standard)
      • ⌨️Kakao Pay
      • ⌨️PAYCO
      • ⌨️Alipay
      • ⌨️Toss
  • Korean Integration Docs
Powered by GitBook
On this page
  • Gets details of payments by order ID, status. This returns top 1 transaction based on the sort order.
  • Gets details of payments by order ID, status. This returns top 1 transaction based on the sort order.
  • Key request parameter description
  1. API
  2. Payment API

Get payments by order ID, status (Top 1)

Gets details of payments by order ID, status. This returns top 1 transaction based on the sort order.

Gets details of payments by order ID, status. This returns top 1 transaction based on the sort order.

GET https://api.iamport.kr /payments/find/{merchant_uid}/{payment_status}

If you specify the payment_status, this returns the latest data for the status.

Path Parameters

Name
Type
Description

merchant_uid*

String

Order ID

payment_status

String

Status code

ready

paid

failed

cancelled

Query Parameters

Name
Type
Description

sorting

String

Sort by code

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 (PagedPaymentAnnotation, optional)

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

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.

{
    // Response
}
{
    // Response
}

Key request parameter description

sorting String

Sort by code

A minus (-) indicates a descending sort order.

  • -started : Sort in descending order (DESC) based on payment start time (payment window open time)

  • started : Sort in ascending order (ASC) based on payment start time (payment window open time)

  • -paid : Sort in descending order (DESC) based on payment completion time

  • paid: Sort in ascending order (ASC) based on payment completion time

  • -updated : Sort in descending order (DESC) based on the last modification time (the modification time is changed whenever payment status changes)

  • updated : Sort in ascending order (ASC) based on the last modification time (the modification time is changed whenever payment status changes

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"
  }
}

Swagger Test Link

PreviousGet payments by order ID, status (All)NextGet balance API (for split payment transaction)

Last updated 2 years ago

Credit card code (KFTC Credit Card Codes: )

💳
⌨️
link
https://api.iamport.kr/#!/payments/getPaymentByMerchantUid