Developers
V1
V2

Request cash receipt API

Requests cash receipt for a cash transaction.

A cash receipt is issued for the iโ€™mport transaction number (imp_uid) of the cash transaction (virtual account, account transfer) processed through iโ€™mport. The cash receipt amount is automatically applied as cash transaction amount. For a partially cancelled transaction, cash receipt is issued for the remaining balance.

Supported PGs

  • KG INICIS
  • NHN KCP
  • Settle Bank
  • NICE Payments
  • PAYJOA (Daou)
  • KICC
POST https://api.ianport.kr/receipts/{imp_uid}

Requests cash receipt for a cash transaction.

Parameters

Path

imp_uid*
String

iโ€™mport transaction ID

Body

identifier*
String

Cash receipt code

identifier_type
String

Cash receipt code type

person: social security number

business: business registration number

phone: mobile phone number

taxcard: National Tax Service cash receipt card

type
String

Cash receipt type

For income deduction (personal) : person

For proof of expenses (business) : company

Default: person

company_tel
String

Merchantโ€™s customer service phone

(Required for PayJoa only)

company_name
String

Merchantโ€™s business name

(Required for PayJoa only)

corp_reg_no
String

Merchantโ€™s business registration number

(Required for PayJoa only)

buyer_name
String

Customer name

buyer_email
String

Customer email

buyer_tel
String

Customer phone

tax_free
integer

Tax free amount

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

imp_uid`` *string

i'mport transaction ID

receipt_tid`` string

Cash receipt ID issued by PG

apply_num*string

Cash receipt ID issued by National Tax Service

type`` *string

Recipient type

  • Personal use: person
  • Business use: company

amount*integer

Cash receipt Amount

vat*integer

VAT

receipt_url`` string

Cash receipt URL

applied_at*integer

Issued at UNIX TIMESTAMP

cancelled_at`` integer

Cancelled at UNIX TIMESTAMP

400: Bad Request
Missing parameter, requested for incomplete transaction (<> paid), or already issued transaction
{
  // Response
}
401: Unauthorized
Missing or invalid access token
{
  // Response
}
500: Internal Server Error
Request failed
{
  // Response
}

Key request parameter description

identifier*String

Cash receipt code

Enter the National Tax Service cash receipt card, mobile phone number, social security number, or business registration number.

identifier_type*String

Cash receipt code type

Required for KICC and Settlebank only

Request for KG INICIS/NHN KCP/Nice Payments/PayJoa is automatically processed with only the identifier.

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "receipt_tid": "string",
    "apply_num": "string",
    "type": "person",
    "amount": 0,
    "vat": 0,
    "receipt_url": "string",
    "applied_at": 0,
    "cancelled_at": 0
  }
}