Comment on page
⌨
결제취소 API
모든 결제내역을 취소할 수 있는 API 를 안내합니다.
post
https://api.iamport.kr
/payments/cancel
승인된 결제를 취소합니다.
imp_uid&merchant_uid취소 요청시 두 파라미터중 하나는 필수로 유입되어야 합니다.
checksuminteger승인 잔액API요청자가 기록하고 있는 취소가능 잔액과 포트원에서 기록하고 있는 취소가능 잔액이 일치하는지 사전에 검증하고 검증에 실패하면 트랜잭션을 수행하지 않습니다. null인 경우에는 검증 프로세스를 생략합니다.
amountinteger취소금액누락시 전액취소 됩니다.
extraobject추가 파라미터.네이버페이 사용시extra.requester를 설정해야 합니다.
customer: 구매자에 의한 요청admin: (기본값) 관리자에 의한 요청예시){ "extra": { "requester": "customer" } }
{
"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
Last modified 6mo ago