title	description
Update virtual account 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";

Updates the deposit expiration or amount for a virtual account that is pending deposit.

Supported PGs

KG INCIS
NHN KCP
TOSS Payments
Nice Payments
KICC
Settle Bank
Smartro

**imp\_uid**

must be specified. (Since there can be multiple virtual accounts pending payment deposit for a single merchant\_uid, you can only update a virtual account based on the imp\_uid)

Parameters

Path

**i'mport transaction ID**

Body

**Amount** **Account expiration**

`UNIX TIMESTAMP`

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;">**(PaymentAnnotation, optional)**</mark>
  </Tab>
</Tabs>

<Tabs>
  <Tab title="PaymentAnnotation">
    **`code`** <mark style="color:red;">**\***</mark> <mark style="color:purple;">**integer**</mark>

    **`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.

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

    **i'mport payment transaction UID**

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

    **Order ID**

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

    **Payment method code**

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

    **Payment environment code**

    - pc: (authenticated) PC
    - mobile: (authenticated) mobile
    - api: recurring or non-authenticated

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

    **PG code**

    ---

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

    **Hub-type PG code**

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

    **PG transaction ID**

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

    **PG MID**

    **`escrow`**   <mark style="color:orange;">**boolean**</mark>

    **Indicates an escrow payment**

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

    **Credit card approval number**

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

    **Bank code**

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

    **Bank name**

    ---

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

    **Credit card code (KFTC Credit Card Codes:** [<mark style="color:red;">**link**</mark>](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) )

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

    **Credit card name**

    **`card_quota`**  <mark style="color:purple;">**integer**</mark>

    **Number of installments (0 means one-off)**

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

    **Masked credit card number**

    ---

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

    **Credit card type code**

    - 0: credit
    - 1: check

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

    **Virtual account bank code (refer to image below)**

    ---

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

    **Refund virtual account**

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

    **Refund virtual account holder**

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

    **Refund virtual account expiration (UNIX timestamp)**

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

    **Refund virtual account created at (UNIX timestamp)**

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

    **Product name**

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

    **Order (payment) amount**

    **`cancel_amount`**  <mark style="color:purple;">**integer**</mark>

    **Cancelled amount**

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

    **Currency**

    - USD
    - KRW
    - EUR

    ---

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

    **Customer name**

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

    **Customer  email**

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

    **Customer phone**

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

    **Customer address**

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

    **Customer zip code**

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

    **echo data as JSON string**

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

    **UserAgent of the device where payment is initiated**

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

    **Payment status code**

    - ready
    - paid
    - cancelled
    - failed

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

    **Payment started at (UNIX timestamp)**

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

    **Payment completed at (UNIX timestamp)**

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

    **Payment failed at (UNIX timestamp)**

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

    **Payment cancelled at (UNIX timestamp)**

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

    **Reason for failure**

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

    **Reason for cancellation**

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

    **Credit card receipt URL**

    **`cash_receipt_issued`** <mark style="color:orange;">**boolean**</mark>

    **Option to automatically issue cash receipt**

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

    **customer\_uid related to the payment transaction**

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

    **customer\_uid use code**

    - payment.scheduled: scheduled payment
    - payment: payment
    - issue: billing key issuance

    **`cancel_history`**  <mark style="color:red;">**(Array\[PaymentCancelAnnotation], optional):**</mark>

    **`Cancellation/partial cancellation history`**
  </Tab>
</Tabs>

<Tabs>
  <Tab title="PaymentCancelAnnotation">
    **cancel\_history array \[]**

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

    **PG cancellation transaction ID**

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

    **Cancelled amount**

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

    **Cancelled at (UNIX timestamp)**

    **`reason`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string(256)**</mark>

    **Reason for cancellation**

    **`receipt_url`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string(300)**</mark>

    **Cancellation receipt URL. Availability varies by PG.**
  </Tab>
</Tabs>

```ts { // Response } ``` ```ts { // Response } ``` ```ts { // Response } ```

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

https://api.iamport.kr/#!/vbanks/modifyVbank

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update-virtual-account-api.mdx

update-virtual-account-api.mdx

Updates the deposit expiration or amount for a virtual account that is pending deposit.

Parameters

Path

Body

Responses

Files

update-virtual-account-api.mdx

Latest commit

History

update-virtual-account-api.mdx

File metadata and controls

Updates the deposit expiration or amount for a virtual account that is pending deposit.

Parameters

Path

Body

Responses