PortOne REST API

가상계좌 관련 API

가상계좌 결제와 관련된 기능을 제공합니다.

가상계좌 발급 API

가상계좌번호를 발급하여 고객이 입금할 수 있도록 합니다.
희망하시는 은행, 예금주명으로 입금이 가능한 가상계좌를 생성할 수 있습니다.(별도로 PG계약 필요)
은행구분코드는 페이지 가장 하단에 있는 은행코드표를 참조하시기 바랍니다.

지원되는 PG사

헥토파이낸셜(구 세틀뱅크)
나이스페이먼츠
KG이니시스
토스페이먼츠 - 신모듈
KSNET
스마트로 - 신모듈
(신) 나이스페이
웰컴페이먼츠

가상계좌 발급정보 수정 API

put/vbanks/{imp_uid}

API요청으로 발급된 가상계좌(입금이 되기 전)의 정보를 수정합니다
아직 입금이 되지 않은 가상계좌의 입금기한 또는 입금금액을 수정할 수 있습니다. (헥토파이낸셜(구 세틀뱅크)만 사용 가능)
imp_uid가 지정되어야 합니다.(포트원 기획 의도상 동일한 merchant_uid의 입금대기 중인 가상계좌가 N개 존재할 수 있으므로 imp_uid로만 가상계좌 수정이 가능합니다)

가상계좌 발급취소 API

delete/vbanks/{imp_uid}

발급된 가상계좌(입금이 되기 전)를 말소합니다.
아직 입금이 되지 않은 가상계좌를 말소시킴으로써 구매자가 실수로 입금하는 경우를 방지하도록 합니다.
imp_uid가 지정되어야 합니다.(포트원 기획 의도상 동일한 merchant_uid의 입금대기 중인 가상계좌가 N개 존재할 수 있으므로 imp_uid로만 가상계좌 말소가 가능합니다)

지원되는 PG사

KG이니시스
NHN KCP
토스페이먼츠 - 구모듈
다날
나이스페이먼츠
KICC
헥토파이낸셜(구 세틀뱅크)
스마트로 - 구모듈
토스페이먼츠 - 신모듈
KSNET
스마트로 - 신모듈
(신) 나이스페이
웰컴페이먼츠

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다

PaymentAnnotation: { imp_uid, merchant_uid, pay_method, ... }

PaymentCancelAnnotation: { pg_tid, amount, cancelled_at, ... }

PaymentResponse: { code, message, response }

ResponseAnnotation: { code, message }

VbankDepositAnnotation: { pg_tid, amount, depositor_name, ... }