⌨ī¸Request cash receipt (external) API

Requests a cash receipt for an external cash transaction.

Supported PGs
  • KG INICIS

  • NHN KCP

  • Settle Bank

  • NICE Payments

  • PAYJOA (Daou)

  • KICC

Requests a cash receipt for an external cash transaction.

POST https://api.iamport.kr/receipts/external/{merchant_uid}

A cash receipt can be issued for a non-i'mport transaction. However, the order number must be the same as the cash transaction order number so that it can be replaced later.

If the pg parameter is not specified, the request will be processed using the default PG.

Path Parameters

NameTypeDescription

merchant_uid*

String

i'mport transaction ID

Request Body

NameTypeDescription

name*

String

Order name

amount*

integer

Amount

identifier*

String

Cash receipt code

National Tax Service cash receipt card

Mobile phone number

Social security number

Business registration number

Mobile phone number

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

buyer_name

String

Customer name

buyer_email

String

Customer email

buyer_tel

String

Customer phone

tax_free

integer

Tax free amount

pg

String

PG 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(ExternalReceiptAnnotation, 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

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.

pg * string

PG code

This is required when there are multiple API method, non-authenticated PG settings in the Admin console.

If there are multiple MID settings for the same PG, specify as:

{PG}.{PG Merchant ID}

If this is unspecified or set to an invalid value, the default PG is used.

  • If there are 2 PG settings, NICE Payments and JTNet, specify as nice or jtnet.

  • If you have multiple MIDs from NICE Payments, specify as nice.MID1 or nice.MID2.

Response Model Schema
{
  "code": 0,
  "message": "string",
  "response": {
    "merchant_uid": "string",
    "receipt_tid": "string",
    "apply_num": "string",
    "type": "person",
    "amount": 0,
    "vat": 0,
    "receipt_url": "string",
    "applied_at": 0,
    "cancelled_at": 0
  }
}

Last updated