Cancel cash receipt (external) API

Cancels a cash receipt issued for an external transaction.

Supported PGs

KG INICIS
NHN KCP
Settle Bank
NICE Payments
PAYJOA (Daou)
KICC

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

Cancels a cash receipt issued for an external transaction.

This cancels the issuance of a cash receipt for a payment processed externally through an i’mport supported PG. Pass the

merchant_uid

, the unique order number for the cash transaction, that was used to request the issuance of cash receipt.

Parameters

Path

merchant_uid*

String

i’mport transaction ID

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(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

400: Bad Request

Missing merchant_uid

{
  // Response
}

401: Unauthorized

Missing or invalid access token

{
  // Response
}

404: Not Found

Result not found

{
  // Response
}

500: Internal Server Error

Request failed

{
  // Response
}

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

Swagger Test Link

https://api.iamport.kr/#!/receipts/revokeExternalReceipt