Search
K
Comment on page

가상계좌 발급취소 API

발급된 가상계좌 번호를 취소합니다.
Deprecated
이 문서는 더 이상 관리되지 않습니다.
PortOne 개발자센터를 이용해주세요.

발급된 가상계좌(입금이 되기 전)를 말소합니다

지원되는 PG사 확인하기
  • KG이니시스
  • NHN KCP
  • TOSS Payments
  • Nice Payments
  • KICC
  • Settle Bank
  • Smartro
delete
https://api.iamport.kr
/vbanks/{imp_uid}
발급된 가상계좌 번호를 취소

주요 요청 파라미터 상세 설명

pg_api_key string
API Key
이니시스의 가맹점 콘솔에서 확인하셔야 하는 API Key 값으로 가상계좌 발급 및 말소 신청에 사용됩니다. 누락하거나 잘못된 키 입력 시 hashData 불일치 오류가 발생합니다.
(이니시스 전용이며, 이니시스의 경우 필수값 Query parameter임)
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"
}
}