요청
개발자센터-한국어
amount
double
필수
결제요청금액
통합결제창에 표시 및 결제 할 금액을 설정합니다.
소수점을 지원하는 통화만 소수점 금액을 설정합니다.
예) KRW : 15000, USD : 45.00
currency
string
필수
결제통화코드
ISO 4217 통화 코드를 설정합니다.
DCC기능을 이용할 경우 결제통화코드(currency)와 고객의 국가코드(county_code)에 대한 결제통화를 화면에 표시합니다.
DCC를 통해 고객이 결제통화를 변경했다면 변경된 통화와 금액이 웹훅으로 전달됩니다.
merchant_order_id
string
필수
고객사 주문번호
고객사가 모든거래에 매번 유니크하게 채번하여 거래에 부여하는 주문번호입니다.
영문,숫자,-,_의 조합으로 생성할 수 있으며 40바이트 이내로 작성합니다.
결제응답 참조값으로 merchant_order_ref 파라미터에 같은 값이 전달됩니다.
signature_hash
string
필수
시그니쳐 해쉬
요청파라미터와 응답파라미터의 위변조를 검증하기 위한 해쉬값입니다.
업무별로 해쉬생성을 위한 파라미터가 상이하므로 해쉬검증 문서를 참조해 주세요.
environment
string
필수
결제환경
테스트는 'sandbox'로 라이브는 'live'로 설정합니다.
'sandbox'는 콘솔의 Test Mode에 설정된 채널로, 'live'는 Live Mode에 설정된 결제채널로 진행됩니다.
country_code
string
필수
고객 국가코드
결제고객의 두자리 국가코드를 설정합니다.
DCC기능을 이용할 경우 결제통화코드(currency)와 고객의 국가코드(county_code)에 대한 결제통화를 화면에 표시합니다.
description
string
필수
비고
트랜잭션에 설명을 기록하고자 할 경우 설정합니다.
해당 설명은 통합결제창에 표시되어 고객안내를 위한 문구로 이용할 수 있습니다.
해당 설명은 통합결제창에 표시되어 고객안내를 위한 문구로 이용할 수 있습니다.
success_url
string
필수
성공 시 리디렉션 주소
PSP로 부터 결제성공 결과를 수신할 경우 이동할 고객사 성공페이지 또는 컨트롤러
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
failure_url
string
필수
실패 시 리디렉션 주소
포트원 또는 PSP로 부터 결제실패 결과를 수신할 경우 이동할 고객사 성공페이지 또는 컨트롤러
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
pending_url
string
선택
결제결과 수신대기 리디렉션 주소
결제요청에 대한 성공과 최종 결제승인 결과를 구분하여 전달하는 PSP의 경우 중간 결과기다림 페이지를 구성할 수 있습니다.
이 주소를 설정하지 않으면 포트원의 pending page를 화면에 표시한 후 success_url 또는 failure_url로 리디렉션 시킵니다.
이 주소를 설정할 경우 결제요청 성공 시 pending_url로 리디렉션합니다. 이 경우 최종승인결과를 웹훅 또는 결과조회API로 수신 후
고객에게 이메일 또는 문자로 안내할 수 있습니다.
이 주소를 설정하지 않으면 포트원의 pending page를 화면에 표시한 후 success_url 또는 failure_url로 리디렉션 시킵니다.
이 주소를 설정할 경우 결제요청 성공 시 pending_url로 리디렉션합니다. 이 경우 최종승인결과를 웹훅 또는 결과조회API로 수신 후
고객에게 이메일 또는 문자로 안내할 수 있습니다.
해외결제의 경우 결제정보에 대해 PSP와 카드매입사에서 Fraud 검증을 수행합니다.
결제정보에 따라 10초에서 3분까지 처리시간이 소요될 수 있습니다.
요청이 성공했다면 pending page에서 이탈하더라도 결제는 진행이 되며
빠른 페이지 전환을 원하실 경우 pending_url에서 요청 성공메시지 표시 후 최종결과를 별도 안내 해야 합니다.
결제정보에 따라 10초에서 3분까지 처리시간이 소요될 수 있습니다.
요청이 성공했다면 pending page에서 이탈하더라도 결제는 진행이 되며
빠른 페이지 전환을 원하실 경우 pending_url에서 요청 성공메시지 표시 후 최종결과를 별도 안내 해야 합니다.
billing_details
object
고객청구정보
billing_name
string
필수
구매자명(이름)
billing_surname
string
필수
구매자명(성)
billing_eamil
string
필수
구매자 이메일
billing_phone
string
선택
구매자 전화번호
billing_address
object
선택
구매자 청구주소
country_code
string
선택
구매자 청구지 국가코드
country_name
string
선택
구매자 청구지 국가명
city
string
선택
구매자 청구지 도시명
state
string
선택
구매자 청구지 state
postal_code
string
선택
구매자 청구지 우편번호
line_1
string
선택
구매자 청구지 주소
line_2
string
선택
구매자 청구지 상세주소
key
string
필수
포트원 API Key
콘솔 > Settings > API탭의 PortOne Key를 설정합니다.
pmt_channel
string
필수
결제채널코드
결제를 진행 할 결제채널(PSP)의 코드를 설정합니다.
pmt_method
string
필수
결제수단코드
결제를 진행 할 결제수단코드를 설정합니다.
amount
double
필수
결제요청금액
통합결제창에 표시 및 결제 할 금액을 설정합니다.
소수점을 지원하는 통화만 소수점 금액을 설정합니다.
예) KRW : 15000, USD : 45.00
currency
string
필수
결제통화코드
ISO 4217 통화 코드를 설정합니다.
DCC기능을 이용할 경우 결제통화코드(currency)와 고객의 국가코드(county_code)에 대한 결제통화를 화면에 표시합니다.
DCC를 통해 고객이 결제통화를 변경했다면 변경된 통화와 금액이 웹훅으로 전달됩니다.
merchant_order_id
string
필수
고객사 주문번호
고객사가 모든거래에 매번 유니크하게 채번하여 거래에 부여하는 주문번호입니다.
영문,숫자,-,_의 조합으로 생성할 수 있으며 40바이트 이내로 작성합니다.
결제응답 참조값으로 merchant_order_ref 파라미터에 같은 값이 전달됩니다.
signature_hash
string
필수
시그니쳐 해쉬
요청파라미터와 응답파라미터의 위변조를 검증하기 위한 해쉬값입니다.
업무별로 해쉬생성을 위한 파라미터가 상이하므로 해쉬검증 문서를 참조해 주세요.
environment
string
필수
결제환경
테스트는 'sandbox'로 라이브는 'live'로 설정합니다.
'sandbox'는 콘솔의 Test Mode에 설정된 채널로, 'live'는 Live Mode에 설정된 결제채널로 진행됩니다.
description
string
필수
비고
트랜잭션에 설명을 기록하고자 할 경우 설정합니다.
해당 설명은 통합결제창에 표시되어 고객안내를 위한 문구로 이용할 수 있습니다.
해당 설명은 통합결제창에 표시되어 고객안내를 위한 문구로 이용할 수 있습니다.
success_url
string
필수
성공 시 리디렉션 주소
PSP로 부터 결제성공 결과를 수신할 경우 이동할 고객사 성공페이지 또는 컨트롤러
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
failure_url
string
필수
실패 시 리디렉션 주소
포트원 또는 PSP로 부터 결제실패 결과를 수신할 경우 이동할 고객사 성공페이지 또는 컨트롤러
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
리디렉션 결과값을 검증하고 DB처리 및 결과화면 표시를 할 수 있습니다.
pending_url
string
선택
결제결과 수신대기 리디렉션 주소
결제요청에 대한 성공과 최종 결제승인 결과를 구분하여 전달하는 PSP의 경우 중간 결과기다림 페이지를 구성할 수 있습니다.
이 주소를 설정하지 않으면 포트원의 pending page를 화면에 표시한 후 success_url 또는 failure_url로 리디렉션 시킵니다.
이 주소를 설정할 경우 결제요청 성공 시 pending_url로 리디렉션합니다. 이 경우 최종승인결과를 웹훅 또는 결과조회API로 수신 후
고객에게 이메일 또는 문자로 안내할 수 있습니다.
이 주소를 설정하지 않으면 포트원의 pending page를 화면에 표시한 후 success_url 또는 failure_url로 리디렉션 시킵니다.
이 주소를 설정할 경우 결제요청 성공 시 pending_url로 리디렉션합니다. 이 경우 최종승인결과를 웹훅 또는 결과조회API로 수신 후
고객에게 이메일 또는 문자로 안내할 수 있습니다.
해외결제의 경우 결제정보에 대해 PSP와 카드매입사에서 Fraud 검증을 수행합니다.
결제정보에 따라 10초에서 3분까지 처리시간이 소요될 수 있습니다.
요청이 성공했다면 pending page에서 이탈하더라도 결제는 진행이 되며
빠른 페이지 전환을 원하실 경우 pending_url에서 요청 성공메시지 표시 후 최종결과를 별도 안내 해야 합니다.
결제정보에 따라 10초에서 3분까지 처리시간이 소요될 수 있습니다.
요청이 성공했다면 pending page에서 이탈하더라도 결제는 진행이 되며
빠른 페이지 전환을 원하실 경우 pending_url에서 요청 성공메시지 표시 후 최종결과를 별도 안내 해야 합니다.
billing_details
object
고객청구정보
billing_name
string
필수
구매자명(이름)
billing_surname
string
필수
구매자명(성)
billing_eamil
string
필수
구매자 이메일
billing_phone
string
선택
구매자 전화번호
billing_address
object
선택
구매자 청구주소
country_code
string
선택
구매자 청구지 국가코드
country_name
string
선택
구매자 청구지 국가명
city
string
선택
구매자 청구지 도시명
state
string
선택
구매자 청구지 state
postal_code
string
선택
구매자 청구지 우편번호
line_1
string
선택
구매자 청구지 주소
line_2
string
선택
구매자 청구지 상세주소