⌨️Cancel payment API
Cancels a payment in full or partially regardless of the payment method and PG.
Cancels an approved payment.
POST
https://api.iamport.kr/payments/cancel
Credit card/instant account transfer/mobile micropayment: cancellation is processed immediately.
Virtual account: if you provide the refund account information, the refund information will be registered with PG and processed on the next business day. (Requires virtual account special service contract)
Request Body
Name | Type | Description |
---|---|---|
imp_uid* | String(32) | ChaiPort transaction ID |
reason | String(256) | Reason for cancellation |
checksum | Double | Refundable amount |
amount | Double | Amount to refund (Full refund if null) |
merchant_uid | String(40) | Order ID (Required if imp_uid is null) |
tax_free | Double | Tax free amount out of |
refund_bank | String(4) | Refund account bank code (Refer to bank codes list below, required for virtual account cancellation) |
refund_holder | String(16) | Refund account holder (Required for virtual account cancellation) |
refund_account | String(16) | Refund account number (Required for virtual account cancellation) |
refund_tel | String(16) | Refund account holder's phone number (Required for virtual account cancellation and Smartro PG) |
Key parameters
imp_uid
&merchant_uid
At least one of these parameters must be specified.
checksum
integerRefundable amount
The
checksum
is used to check whether the refundable amount is the same between the API requester and the i'mport server. If they do not match, the refund request will fail. If thechecksum
is null, the verification is not performed.
amount
* integerAmount to cancel
If not specified, a full refund is requested.
Swagger Test Link
Last updated