⌨️Cancel virtual account API
Cancels a virtual account before payment is deposited.
Cancels a virtual account before payment is deposited.
DELETE
https://api.iamport.kr/vbanks/{imp_uid}
You can cancel a virtual account before deposit to prevent the buyer from depositing by mistake. imp_uid must be specified. (Since there can be multiple virtual accounts pending payment deposit for a single merchant_uid, you can only cancel a virtual account based on the imp_uid)
Path Parameters
Query Parameters
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
(PaymentAnnotation, optional)
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.
imp_uid
* string
i'mport payment transaction UID
merchant_uid
* string
Order ID
pay_method
* string
Payment method code
channel
* string
Payment environment code
pc: (authenticated) PC
mobile: (authenticated) mobile
api: recurring or non-authenticated
pg_provider
* string
PG code
emb_pg_provider
* string
Hub-type PG code
pg_tid
* string
PG transaction ID
pg_id
* string
PG MID
escrow
boolean
Indicates an escrow payment
apply_num
string
Credit card approval number
bank_code
string
Bank code
bank_name
string
Bank name
card_code
string
Credit card code (KFTC Credit Card Codes: link )
card_name
string
Credit card name
card_quota
integer
Number of installments (0 means one-off)
card_number
string
Masked credit card number
card_type
string
Credit card type code
0: credit
1: check
vbank_code
string
Virtual account bank code (refer to image below)
vbank_name
string
Refund virtual account
vbank_holder
string
Refund virtual account holder
vbank_date
string
Refund virtual account expiration (UNIX timestamp)
vbank_issued_at
string
Refund virtual account created at (UNIX timestamp)
name
string
Product name
amount
* integer
Order (payment) amount
cancel_amount
integer
Cancelled amount
currency
string
Currency
USD
KRW
EUR
buyer_name
string
Customer name
buyer_email
string
Customer email
buyer_tel
string
Customer phone
buyer_addr
string
Customer address
buyer_postcode
string
Customer zip code
custom_data
string
echo data as JSON string
user_agent
string
UserAgent of the device where payment is initiated
status
* string
Payment status code
ready
paid
cancelled
failed
started_at
* string
Payment started at (UNIX timestamp)
paid_at
* string
Payment completed at (UNIX timestamp)
failed_at
* string
Payment failed at (UNIX timestamp)
cancelled_at
* string
Payment cancelled at (UNIX timestamp)
fail_reason
string
Reason for failure
cancel_reason
string
Reason for cancellation
receipt_url
string
Credit card receipt URL
cash_receipt_issued
boolean
Option to automatically issue cash receipt
customer_uid
string
customer_uid related to the payment transaction
customer_uid_usage
string
customer_uid use code
payment.scheduled: scheduled payment
payment: payment
issue: billing key issuance
cancel_history
(Array[PaymentCancelAnnotation], optional):
Cancellation/partial cancellation history
cancel_history array []
pg_tid
* string
PG cancellation transaction ID
amount
* integer
Cancelled amount
cancelled_at
* string
Cancelled at (UNIX timestamp)
reason
* string(256)
Reason for cancellation
receipt_url
* string(300)
Cancellation receipt URL. Availability varies by PG.
Key request parameter description
pg_api_key
String
API Key
This is the API Key from the KG INICIS Merchant console and is used for virtual account issuance and cancellation. A hashData mismatch error occurs if you specify a missing or invalid key.
(Required for KG INICIS only)
Swagger Test Link
Last updated