NAV

본인인증

페이레터(주)

페이레터 PG

PG 가맹점 관리자

본인인증

본인인증은 휴대폰/아이핀/신용카드를 통하여 개인 고유 식별정보를 얻을 수 있는 기능입니다.

본인인증 요청 후 완료 페이지로 tid가 반환되며, 해당 tid로 본인인증 결과 값 조회 api를 호출하시면

본인인증 결과값(CI, DI 등) 을 얻을 수 있습니다.

*본인인증 연동 시 iframe 또는 layer 방식으로 연동하시는 경우 정상적인 작동이 되지 않을 수 있습니다.

본인인증 요청

요청

POST /v1.0/payments/request HTTP/1.1
Host: testpgapi.payletter.com
Authorization: PLKEY MTFBNTAzNTEwNDAxQUIyMjlCQzgwNTg1MkU4MkZENDA=
Content-Type: application/json

{
"client_id":"pay_test",
"user_id":"test_user_id",
"custom_parameter":"this is a custom parameters",
"return_url":"https://testpg.payletter.com/auth/result",
"cancel_url":"https://testpg.payletter.com/auth/cancel",
"site_url":"payletter.com",
"site_name":"payletter.com"
}

Key Type

PAYMENT

HTTP Request

POST v1.0/auth/{auth_method}/request

Request Parameters

Parameter | Default | Type | Size | Description
{auth_method} | 필수 | URI | | mobile, ipin, card (휴대폰, 아이핀, 신용카드) 본인인증 요청
client_id | 필수 | string | 10 | 가맹점 아이디
user_id | 필수 | string | 50 | 가맹점 결제자(회원) 아이디(email, 영어/숫자 가능)

custom_parameter

string

1024

가맹점이 전송하는 임의의 값
ex) 고객정보, 주문정보, 기타 필요한 정보를 세팅하면 결제 결과로 다시 리턴.

return_url | 필수 | string | 256 | 인증 완료 후 연결할 웹 페이지 URL
cancel_url | | string | 256 | 취소 버튼 클릭시 연결할 웹 페이지 URL
site_url | | string | 256 | 휴대폰 본인확인 완료 후 최종화면에 나오는 URL
site_name | | string | 256 | 휴대폰 본인확인 시 어플이나 문자메시지에 나오는 URL

Response Parameters

성공시

HTTP 1.1 200 OK
{
"token" : 153438847514600001,
"online_url": "https://testpg.payletter.com/pgsvc/hub.asp?location=online&token=153438847514601",
"mobile_url": "https://testpg.payletter.com/pgsvc/hub.asp?location=mobile&token=153438847514601"
}

실패시

HTTP 1.1 401 Unauthorized
{
"code": 998,
"message": "Authentication token is missing or incorrect"
}

성공시

Parameter | Type | Description
token | number | 본인인증 토큰
online_url | string | PC 환경 본인인증 웹페이지 호출 URL
mobile_url | string | Mobile 환경 본인인증 웹페이지 호출 URL

실패시

Parameter | Type | Description
code | number | 에러 코드
message | string | 에러 메시지

본인인증 연동

ReturnURL

본인인증 결과는 요청시 return_url 로 POST 파라메터로 전송됩니다.

ci code 및 사용자 개인 정보는 인증 성공시에 auth_info 에 암호화 되어 저장 됩니다.

사용자 식별 정보를 얻기 위해선 "3.7 본인인증 정보조회" API 를 이용하여 조회를 해주시기 바랍니다.

Parameter | Type | Description
code | number | 에러 코드
message | string | 에러 메시지
tid | string | 인증 거래 번호
custom_parameter | string | 인증 요청시 가맹점에서 임의로 전송한 값
auth_info | string | 암호화 된 사용자 인증 정보

tid로 본인인증 결과 조회 API를 호출하여 본인인증 결과를 확인하실 수 있습니다.

본인인증 결과 조회

요청

GET /v1.0/auth/info/{tid}&client_id={client_id}&auth_info={auth_info} HTTP/1.1
Host: testpgapi.payletter.com
Authorization: PLKEY MUI3MjM0RUExQTgyRDA1ODZGRDUyOEM4OTY2QTVCN0Y=

Key Type

SEARCH

HTTP Request

GET v1.0/auth/info/{tid}?client_id={client_id}&auth_info={auth_info}

Request Parameters

Parameter | Default | Type | Description
{tid} | 필수 | URI | 본인인증 완료 후 return_url 로 전달된 tid 값
{client_id} | 필수 | URI | 가맹점 아이디
{auth_info} | 필수 | URI | 본인인증 완료 후 return_url 로 전달된 auth_info 값

Response Parameters

성공시

HTTP 1.1 200 OK
{
"tid": "IPIN_CM6120180827141325522",
"real_name": "홍길동",
"birth_date": "19780316",
"gender_code":" M",
"foreign_flag": "N",
"ci_code": "aGf2srxq7chEoEd9QP0pE0CbwI7ob+ +U6OQtKxablBe7yu+Q==",
"di_code": "MC0GCCqGSIb3DQIJAyEAHSq3Tpu5mt5k002eUb5AVF/ =",
"mobile_carrier": null,
"mobile_no": null,
"ipin_ci_upd_cnt": 1,
"ipin_ci_virtual_no": "000000145865"
}

실패시

HTTP 1.1 401 Unauthorized
{
"code": 998,
"message": "Authentication token is missing or incorrect"
}

성공시

Parameter | Type | Description
tid | string | 인증 거래 번호
real_name | string | 이용자 실명
birth_date | string | 이용자 생년월일
gender_code | string | 성별 (F:여성, M:남성)
foreign_flag | string | 내외국인 구별 (N:내국인, Y:외국인)
ci_code | string | CI 값
di_code | string | DI 값
mobile_carrier | string | 이통사 코드 (01: SKT, 02 : KT, 03 : LG U+, 04 : 알뜰폰 SKT, 05 : 알뜰폰 KT, 06 : 알뜰폰 LG U+)
mobile_no | string | 휴대폰 번호
ipin_ci_upd_cnt | number | CI갱신 횟수를 기재
ipin_ci_virtual_no | string | 주민번호 대체수단의 식별번호

cert_cardcode

string

인증에 사용한 신용카드
(국민카드:KB, 롯데카드:LT, 삼성카드:SS, 신한카드:SH, 하나카드:HN, 현대카드:HD, 비씨카드:BC)

mobile_carrier, mobile_no : 인증 수단이 휴대폰인 경우 리턴.

ipin_ci_upd_cnt, ipin_ci_virtual_no : 인증 수단이 IPIN 인 경우 리턴.

cert_cardcode : 인증 수단이 신용카드인 경우 리턴.

실패시

Parameter | Type | Description
code | number | 에러 코드
message | string | 에러 메시지