Skip to content

Latest commit

 

History

History
171 lines (126 loc) · 4.66 KB

cancel-cash-receipt-external-api.mdx

File metadata and controls

171 lines (126 loc) · 4.66 KB
title description
Cancel cash receipt (external) API

import Details from "/components/gitbook/Details.astro"; import Swagger from "/components/gitbook/swagger/Swagger.astro"; import SwaggerDescription from "/components/gitbook/swagger/SwaggerDescription.astro"; import SwaggerParameter from "/components/gitbook/swagger/SwaggerParameter.astro"; import SwaggerResponse from "/components/gitbook/swagger/SwaggerResponse.astro"; import Tab from "/components/gitbook/tabs/Tab.astro"; import Tabs from "/components/gitbook/tabs/Tabs.astro"; import Hint from "/components/Hint.astro";

Cancels a cash receipt issued for an external transaction.

Supported PGs

  • KG INICIS
  • NHN KCP
  • Settle Bank
  • NICE Payments
  • PAYJOA (Daou)
  • KICC
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

**i'mport transaction ID**

Responses

**`code`** **\*** **integer**
    **Response code**

    0: success, Not 0: check the message

    **`message`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

    **Response message**

    A non-zero code includes a message like 'Invalid payment info'.

    **`response`**<mark style="color:red;">**`(ExternalReceiptAnnotation, optional)`**</mark>
  </Tab>
</Tabs>

<Tabs>
  <Tab title="ExternalReceiptAnnotation">
    **`imp_uid`` `**<mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

    **`i'mport transaction ID`**

    **`receipt_tid`` `**<mark style="color:green;">**`string`**</mark>

    **`Cash receipt ID issued by PG`**

    **`apply_num`**<mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

    **`Cash receipt ID issued by National Tax Service`**

    **`type`` `**<mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

    **`Recipient type`**

    - Personal use: `person`
    - Business use: `company`

    **`amount`**<mark style="color:red;">**`*`**</mark><mark style="color:orange;">**`integer`**</mark>

    **`Cash receipt Amount`**

    **`vat`**<mark style="color:red;">**`*`**</mark><mark style="color:orange;">**`integer`**</mark>

    **`VAT`**

    **`receipt_url`` `**<mark style="color:green;">**`string`**</mark>

    **`Cash receipt URL`**

    **`applied_at`**<mark style="color:red;">**`*`**</mark><mark style="color:orange;">**`integer`**</mark>

    **Issued at** `UNIX TIMESTAMP`

    **`cancelled_at`` `**<mark style="color:orange;">**`integer`**</mark>

    **`Cancelled at`** `UNIX TIMESTAMP`
  </Tab>
</Tabs>
```ts { // Response } ``` ```ts { // Response } ``` ```ts { // Response } ``` ```ts { // 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