⌨
가상계좌 발급 API
가상계좌번호를 발급하여 고객이 입금할수 있도록 합니다.
해당 API 는 아래 PG사를 이용하는 경우에만 사용 가능합니다.
- 핵토파이낸셜(구 세틀뱅크)
- 나이스페이먼츠
- KG이니시스
- 토스페이먼츠 - 신모듈
- KSPAY
post
https://api.iamport.kr
/vbanks
가상계좌 번호를 발급합니다.
pg* stringpg 구분코드관리자콘솔 API 방식 비인증 PG설정이 2개 이상인 경우 필수적으로 기재해야 하는 항목입니다.동일 PG사에 두개의 MID 를 설정한 경우 아래 양식으로 기재 합니다.{PG사}.{PG상점 아이디}
notice_urlstring**입금통보 URL **가상계좌 입금시 입금통지받을 URL 선언되지 않으면 포트원 관리자 페이지에 정의된 Notification URL값을 사용
custom_datajson에코항목결제정보와 함께 저장할 custom_data. 객체로 전달되는 경우 JSON 문자열로 저장
pg_api_keystringAPI Key이니시스의 가맹점 콘솔에서 확인하셔야 하는 API Key 값으로 가상계좌 발급 및 말소 신청에 사용됩니다. 누락하거나 잘못된 키 입력 시 hashData 불일치 오류가 발생합니다.(이니시스 전용이며, 이니시스의 경우 필수값 Query parameter임)
vbank_keystring고정식 가상계좌를 발급받기 위한 고객과 매칭시킨 계좌 고유 키(토스페이먼츠 - 신모듈의 경우 필수값임) (사용을 위해 PG사와 협의 필요)
{
"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 4mo ago