NAV Navbar

페이레터 결제 소개

서비스 안내

몇 번을 고민해도, 당신의 파트너는 페이레터입니다.

페이레터는 온라인 상점의 재화/서비스 판매를 위한 전자결제 대행 서비스를 제공합니다.

보안인증 획득을 통한 안전성 검증, 다양한 결제수단,

안정적인 거래 처리 능력과 더불어 더욱 편리한 결제 서비스를 제공하기 위해 노력하고 있습니다.

1. 전세계 25개국, 260개 회사에서 페이레터 서비스 이용 중
2. 글로벌 신용카드 데이터 보안 인증 PCI-DSS, 국내 정보 보안표준 ISMS 인증 획득으로 안전한 결제환경 제공
3. 국내 1위 E-Commerce, 음원 서비스, VOD 서비스 등의 거래를 통해 검증된 거래 처리 능력
4. 튼튼한 재무 구조로 안정적 서비스 및 대금 정산 가능
5. 경쟁사 대비 월등한 콜센터 고객 응대율(98.7%)

결제수단 및 부가서비스

금융군 간편결제 통신군 상품권/선불카드 부가서비스
신용카드
인터넷뱅킹
가상계좌
토스(TOSS)
카카오페이
페이코
계좌 간편결제
휴대폰
KT 집전화 결제
문화상품권
스마트문상
도서문화상품권
해피머니상품권
모바일팝
틴캐시
편의점캐시
에그머니
교통카드결제
(티머니, 캐시비)
본인확인서비스
(휴대폰/아이핀)

가입절차

신규 가입문의 : 영업팀 장일석 과장(02-6191-3702 / isjang@payletter.com)
1. 온라인 가입 가입하기
2. 가입심사 진행 이용불가업종 보기
3. 보증보험 가입
- 문의 : 서울보증보험 서초지점 [(주)개런티인슈] / 02-3486-0021, 02-3487-0035
4. 계약서 및 구비서류 제출 계약서 보기
5. 결제수단별 심사 진행
- 신용카드/간편결제/휴대폰 : 약 2주 소요
- 인터넷뱅킹 : 약 1~2일 소요
- 상품권/선불카드 : 약 3~5일 소요
6. 등록비 납부 및 가입 완료

구비서류

구분 법인사업자 개인사업자
계약서류 1. 페이레터 통합결제서비스 이용계약서 2부,
2.개인정보 수집 이용 및 활용 동의서 1부
구비서류 1. 사업자등록증 사본 1부
2. 법인 인감증명서 원본 1부(3개월 이내 발급분)
3. 입금계좌 사본 1부(법인명의)
4. 사용인감계 1부(계약서에 사용인감 날인 시)
5. 지급이행 보증보험증권 원본 1부
1. 사업자등록증 사본 1부
2. 대표자 인감증명서 원본 1부(3개월 이내 발급분)
3. 입금계좌 사본 1부(대표자 또는 사업자명의)
4. 지급이행 보증보험증권 원본 1부

연동 전 확인사항

API HTTPS 프로토콜

지원하는 HTTPS 프로토콜

페이레터 API HTTPS는 TLS 1.1, 1.2만을 지원합니다.

방화벽

결제완료 Callback 을 수신하기 위하여 inbound IP를 추가해 주시기 바랍니다.

테스트 : 121.254.205.166

라이브 : 211.115.72.37, 211.115.72.38, 211.115.117.11(예비)

API Authorization

가맹점 계약이 완료되면 API Key가 발급됩니다. 가맹점 계약 안내

API Key는 가맹점 관리자 페이지 에서 확인하실 수 있습니다.

API Key는 결제(PAYMENT) / 조회(SEARCH) 용 두 가지 Key가 발급됩니다.

HttpReqeustHeader의 Authorization 항목에 다음과 같이 API Key를 보내 주시기 바랍니다.

Authorization: PLKEY {가맹점_apikey}

API Endpoint URL

환경 주소
테스트 https://testpgapi.payletter.com/
라이브 https://pgapi.payletter.com/

테스트 환경 가맹점 정보

가입 전에 테스트 환경에서 미리 구성된 API Key로 연동 테스트가 가능합니다.

Parameter Value
가맹점 아이디 pay_test
API Key (PAYMENT) MTFBNTAzNTEwNDAxQUIyMjlCQzgwNTg1MkU4MkZENDA=
API Key (SEARCH) MUI3MjM0RUExQTgyRDA1ODZGRDUyOEM4OTY2QTVCN0Y=

결제수단별 옵션

결제수단 자동결제 결제취소 부분취소 비고
신용카드  O O O 테스트 환경에서는 밴(신용카드)사 통신하지 않음
인터넷뱅킹  X O X 테스트 환경에서 실 결제 발생 (당일 밤 자동 결제 취소됨)
가상계좌 X X X 실제 입금하면 취소가 불가능합니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
토스(TOSS)  X O X TLS 1.1 이상 브라우저만 지원
카카오페이  X O X 테스트 환경에서 실 결제 발생 (당일 밤 자동 결제 취소됨)
페이코  O O X
계좌 간편결제 O O X
휴대폰  O O O 테스트 환경에서 실 결제 발생 (당일 밤 자동 결제 취소됨)
KT 집전화 결제 X O X 테스트 환경에서는 전화가 오지 않음
결제 성공 케이스는 라이브 환경에서 테스트 진행
문화상품권  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
스마트문상  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
도서문화상품권  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
해피머니상품권  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
모바일팝  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
틴캐시  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
편의점캐시  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
에그머니  X O X 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.
교통카드결제 X O O 테스트 환경의 결제는 추후 지원 예정입니다.
테스트가 필요하신 경우 별도 문의 바랍니다.

기술지원

poqdev@payletter.com

결제 관련 문의 시에는 연동 환경, 가맹점 아이디, 주문번호, 거래시간, token 등

상세 정보를 보내주시면 보다 빠른 응대가 가능합니다.

결제 API

API 목록

URL METHOD KEY TYPE 기능
v1.0/payments/request POST PAYMENT 결제 요청
v1.0/payments/cancel POST PAYMENT 결제 취소
v1.0/payments/cancel/partial POST PAYMENT 부분 취소
v1.0/payments/autopay POST PAYMENT 자동결제
v1.0/auth/{auth_method}/request POST PAYMENT 본인인증 요청
v1.0/auth/info/{tid}?client_id={client_id}&auth_info={auth_info} GET SEARCH 본인인증 결과 조회
v1.0/payments/transaction/list GET SEARCH 결제 내역 조회

결제 프로세스

결제 요청

요청

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

{
    "pgcode" : "mobile",
    "user_id":"test_user_id",
    "user_name":"테스터",    
    "service_name":"페이레터",    
    "client_id":"pay_test",
    "order_no":"1234567890",
    "amount":1000,
    "product_name":"테스트상품",    
    "email_flag":"Y",
    "email_addr":"payletter@payletter.com",
    "autopay_flag":"N",    
    "receipt_flag":"Y",
    "custom_parameter":"this is custom parameter",    
    "return_url":"https://testpg.payletter.com/result",
    "callback_url":"https://testpg.payletter.com/callback",
    "cancel_url":"https://testpg.payletter.com/cancel"
}

Key Type

PAYMENT

HTTP Request

POST v1.0/payments/request

Request Parameters

Parameter Default Type Size Description
pgcode 필수 string 20 결제수단 코드 첨부 참조
client_id 필수 string 10 가맹점 아이디
service_name string 30 결제 서비스명
user_id 필수 string 50 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
user_name string 50 가맹점 결제자(회원) 이름
order_no string 50 가맹점 주문번호
amount 필수 number 결제금액
product_name 필수 string 100 결제 상품(컨텐츠)명
email_flag string 1 결제내역 메일 수신 여부(Y:사용, N:미사용)
email_addr string 100 결제내역 메일 수신 주소
autopay_flag string 1 자동 결제 여부
receipt_flag string 1 현금영수증 입력 창 노출 여부(Y:사용, N:미사용)
(*현금영수증 계약이 되어 있는 경우에만 사용 가능)
keyin_flag string 1 신용카드 수기결제 여부
(*별도 계약이 되어 있는 경우에만 사용 가능)
custom_parameter string 1024 가맹점이 전송하는 임의의 값
ex) 고객정보, 주문정보, 기타 필요한 정보를 세팅하면 결제 결과로 다시 리턴
return_url 필수 string 256 결제 완료 후 연결할 웹 페이지 URL
callback_url 필수 string 256 결제 성공 결과를 수신할 callback URL
(가맹점 결제 성공 처리)
cancel_url string 256 취소 버튼 클릭시 연결할 웹 페이지 URL
inapp_flag string 1 In-app 사용 여부
app_return_url string 256 in-app 에서 ISP / KFTC(계좌이체)결제시 연결할 웹 페이지 URL
app_cancel_url string 256 in-app 에서 ISP / KFTC(계좌이체)결제 취소(중단)시 연결할 웹 페이지 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 에러 메시지

결제 연동

결제요청 API Response로 리턴된 URL을 사용하여 결제창을 호출합니다.

사용자가 결제를 진행하면 결제요청에서 전달하신 return_url로 결제 결과가 반환됩니다.

결제완료 처리(재화 지급 등 가맹점의 business logic)은 callback_url에서 수행하는 것을 권장합니다.

return_url 과 callback_url에서의 프로세스는 아래 설명을 참고하시기 바랍니다.

Return URL

결제 결과는 Request의 POST 파라메터로 전송됩니다.

{ 
"user_id":"user_id", 
"user_name":"테스트", 
"amount":1000, 
"tid":"tpay_test-201808162396515", 
"cid":"20180816150336996237", 
"order_no":"1234567890", 
"service_name":"페이레터", 
"product_name":"테스트상품", 
"custom_parameter":"this is custom parameter", 
"transaction_date":"2018-08-16 15:03:52", 
"pay_info":"0101234567", 
"pgcode":"mobile", 
"domestic_flag":"", 
"bilkey":"",
"card_info" : "45797302****1234"
"payhash" : "70C08842BAF0FC8BD4D1857B5F5C15965830E7945C68F03F4A2ECC1715A4F5A1"
}

성공시

Parameter Type 설명
code number 결과
message string 메시지
user_id string 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
order_no string 가맹점의 주문 번호
service_name string 결제 서비스명
product_name string 결제 상품(컨텐츠)명
custom_parameter string 주문요청시 가맹점가 전송한 값
tid string 결제고유번호
cid string 승인번호
amount number 결제요청 금액
pay_info string 결제 부가정보
pgcode string 결제요청한 pg명
billkey string 자동결제 재결제용 빌키
domestic_flag string 국내 / 해외 신용카드 구분 (Y : 국내, N : 해외)
transaction_date string 거래일시(YYYY-MM-DD HH:MM:SS)
install_month number 할부개월수
card_info string 카드 번호 (중간 4자리 masking 처리 )
payhash string 파라메터 검증을 위한 sha256 hash 값
Sha256(user_id +amount + tid +결제용 API Key)
* 일부 결제 수단은 전달되지 않습니다.(가상계좌 등)
가상계좌 선택시
account_no string 가상계좌 번호
account_name string 가상계좌 예금주
bank_code string 가상계좌 은행 코드
bank_name string 가상계좌 은행명
expire_date string 가상계좌 입금만료일 (ex: 20180924)

실패시

Parameter Type 설명
code string 결과
message string 메시지
user_id string 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
order_no string 가맹점의 주문 번호
service_name string 결제 서비스명
product_name string 결제 상품(컨텐츠)명
custom_parameter string 주문요청시 가맹점가 전송한 값

Callback URL

결제가 성공한 경우, Return에서 전달된 결과값들이 json형태로 제공됩니다.

전달받은 Callback URL 을 통해서 결과값을 받아서 가맹점에 맞는 충전, 구매 등의 로직을 수행하도록 합니다.

Callback URL에서 처리 완료 후 성공시 아래 json 문자 열을 출력해 주시기 바랍니다.

{"code":0, "message":"실패시 실패 사유"}

code 는 성공시 0, 실패시 0이 아닌 다른 값을 전달해 주시면 됩니다.

code 가 0이 아닌 경우에는 통보가 실패한 것으로 간주되어 5분마다 최대 20번까지 재 전송됩니다.

발송 내역은 가맹점 관리자 사이트(https://pg1.payletter.com:999/Login.asp)에 로그인 후

조회/취소->노티실패내역조회 메뉴에서 확인이 가능합니다.

ReturnUrl / CallBackUrl로 전달된 파라메터는 위/변조 방지를 위하여

sha256 hash 값을 생성한 후 전달된 payhash 와 비교 검증을 수행하시기 바랍니다.

결제 취소

요청

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

{
    "pgcode" : "mobile",
    "client_id":"pay_test",
    "user_id":"test_user_id",
    "tid":"tpay_test2018010123595900001",   
    "amount" : 1000,
    "ip_addr":"127.0.0.1"
}

Key Type

PAYMENT

HTTP Request

POST v1.0/payments/cancel

Request Parameters

Parameter Type Size Description
pgcode string 20 결제수단 코드(첨부7.1)
client_id string 10 가맹점 아이디
user_id string 50 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
tid string 40 결제 고유 번호
amount number 취소 금액
ip_addr string 30 요청 아이피

Response Parameters

성공시

HTTP 1.1 200 OK
{
    "tid" :"tpay_test201801012359590003",
    "cid":"123456",
    "amount":1000,
"cancel_date":"2018-01-01 23:59:59"
}


실패시

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

성공시

Parameter Type Description
tid string 결제 고유 번호
cid string 승인번호
amount number 취소 금액
cancel_date string 취소 일시(yyyy-MM-dd hh:mm:ss)

실패시

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

부분 취소

일부 결제수단만 부분취소가 가능합니다.

부분 취소가 가능한 결제수단 및 기능 사용 관련 문의는 계약 담당자에게 연락해 주십시오.

요청

POST /v1.0/payments/cancel/partial HTTP/1.1
Host: testpgapi.payletter.com
Authorization: PLKEY B9B190294F0DCAA4662963D81C17B2A7
Content-Type: application/json

{
    "pgcode" : "mobile",
    "client_id":"pay_test",
    "user_id":"test_user_id",
    "tid":"tpay_test2018010123595900001",   
    "amount" : 1000,
    "ip_addr":"127.0.0.1"
}

Key Type

PAYMENT

HTTP Request

POST v1.0/payments/cancel/partial

Request Parameters

Parameter Type Size Description
pgcode string 20 결제수단 코드(첨부7.1)
client_id string 10 가맹점 아이디
user_id string 50 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
tid string 40 결제 고유 번호
amount number 부분취소 금액
ip_addr string 30 요청 아이피

Response Parameters

성공시

HTTP 1.1 200 OK
{
    "tid" :"tpay_test201801012359590003",
    "cid":"123456",
    "amount":1000,
"cancel_date":"2018-01-01 23:59:59"
}


실패시

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

성공시

Parameter Type Description
tid string 결제 고유 번호
cid string 승인번호
amount number 취소 금액
cancel_date string 취소 일시(yyyy-MM-dd hh:mm:ss)

실패시

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

자동 결제

요청

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

{
    "pgcode" : "mobile",
    "client_id":"pay_test",
    "service_name":"페이레터",    
    "user_id":"test_user_id",
    "user_name":"테스터",    
    "order_no":"1234567890",
    "amount":1000,
    "product_name":"테스트상품",    
    "billkey":"tbpay_test201801012359590002",
    "sequence_no":1,
    "ip_addr":"127.0.0.1"
}

Key Type

PAYMENT

HTTP Request

POST v1.0/payments/autopay

Request Parameters

Parameter Default Type Size Description
pgcode 필수 string 20 결제수단 코드(첨부7.1)
client_id 필수 string 10 가맹점 아이디
service_name string 30 결제 서비스명
user_id 필수 string 50 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
user_name string 50 가맹점 결제자(회원) 이름
order_no string 50 가맹점 주문번호
amount 필수 number 결제 금액
product_name 필수 string 100 결제 상품(컨텐츠)명
billkey 필수 string 40 자동결제 재결제용 빌키(자동 결제 첫 회차 응답 파라메터)
sequence_no number
ip_addr string 30 요청 아이피

Response Parameters

성공시

HTTP 1.1 200 OK
{
    "tid" :"tpay_test201801012359590003",
    "cid":"123456",
    "amount":1000,
    "billkey":"tbpay_test201801012359590002",
    "transaction_date":"2018-01-01 23:59:59"
}

실패시

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

성공시

Parameter Type Description
tid string 결제 고유 번호
cid string 승인번호
amount number 결제 금액
billkey string 자동결제 재결제용 빌키
transaction_date string 거래 일시(yyyy-MM-dd hh:mm:ss)

실패시

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

결제 내역 조회

요청

GET
/v1.0/payments/transaction/list?client_id=pay_test&date=20180918&date_type=transacti
on HTTP/1.1
Host: testpgapi.payletter.com
Authorization: PLKEY B9B190294F0DCAA4662963D81C17B2A7

Key Type

SEARCH

HTTP Request

GET v1.0/payments/transaction/list

Request Parameters

Parameter Default Type Size Description
client_id 필수 string 10 가맹점 아이디
date 필수 string 8 조회 일자
date_type 필수 string 20 transaction : 결제일 기준, settle : 결제/취소일 기준
pgcode string 20 사용 결제 수단 코드

date_type : 거래상태 조회 기준

transaction : 결제일 기준

결제일 기준으로 검색된 거래 건으로 현재기준 정상 또는 취소 내역 추출 (예: 취소된 건은 취소건 1건으로 추출됨)

settle : 결제/취소일 기준

결제일 기준의 승인내역과, 취소일 기준의 취소 내역 추출 (예: 취소된 건은 결제일의 승인건 1건, 취소일의 취소건 1건으로 추출됨)

Response Parameters

성공시

HTTP 1.1 200 OK
{
    "total_count": 2,
    "list": [
        {
            "pgcode": "oncash",
            "user_id": "test_user_id",
            "user_name": "테스터",
            "tid": "tpay_test-201809142506687",
            "cid": "2506686",
            "amount": 1000,
            "order_no": "1234567890",
            "product_name": "테스트상품",
            "status_code": 1,
            "transaction_date": "2018-09-14 17:25:36",
            "cancel_date": "2018-09-18 09:52:29"
        },
        {
            "pgcode": "mobile",
            "user_id": "test_user_id",
            "user_name": "테스터",
            "tid": "tpay_test-201809182509659",
            "cid": "20180918095312998861",
            "amount": 100,
            "order_no": "1234567890",
            "product_name": "테스트상품",
            "status_code": 2,
            "transaction_date": "2018-09-18 09:53:25",
            "cancel_date": "2018-09-18 09:54:01"
        }
    ]
}

실패시

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

성공시

Parameter Type Description
total_count number 전체 조회건수
list JSON Array
pgcode string 사용 결제 수단 코드
user_id string 고객사의 결제자 아이디
user_name string 고객사의 결제자 명
tid string 결제고유번호
cid string 승인 번호
amount number 결제금액 (취소 상태인 경우 취소 금액)
order_no string 고객사의 주문 번호
product_name string 상품(컨텐츠)명
status_code number 상태(0:승인, 1:전체취소, 2:부분취소)
transaction_date string 결제 일시
cancel_date string 취소 일시

실패시

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

본인인증

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

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

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

본인인증 요청

요청

POST /v1.0/auth/mobile/request HTTP/1.1
Host: testpgapi.payletter.com
Authorization: PLKEY B9B190294F0DCAA4662963D81C17B2A7
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"
}

Key Type

PAYMENT

HTTP Request

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

Request Parameters

Parameter Default Type Size Description
{auth_method} 필수 URI mobile, ipin ( 휴대폰, 아이핀) 본인인증 요청
client_id 필수 string 10 가맹점 아이디
user_id 필수 string 50 가맹점 결제자(회원) 아이디(영문 및 숫자로 세팅)
custom_parameter string 1024 가맹점이 전송하는 임의의 값
ex) 고객정보, 주문정보, 기타 필요한 정보를 세팅하면 결제 결과로 다시 리턴.
return_url 필수 string 256 결제 완료 후 연결할 웹 페이지 URL
cancel_url 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 암호화 된 사용자 인증 정보

본인인증 결과 조회

요청

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


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_method_code": 2,
    "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:알뜰폰)
mobile_no string 휴대폰 번호
ipin_method_code number PIN 발급시 신원확인수단
(0:공인인증서, 1:카드, 2:휴대폰, 3:대면확인,5:신원보증인 공인인증서, 6:신원보증인 카드,7:신원보증인 휴대폰)
ipin_ci_upd_cnt number CI갱신 횟수를 기재
ipin_ci_virtual_no string 주민번호 대체수단의 식별번호

실패시

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

오류코드

API 요청에 대한 성공/실패 여부는 HTTP StatusCode로 확인합니다.

StatusCode 200 OK 인 경우에만 요청 처리 성공이며, 성공이 아닌 경우에는 아래 StatusCode를 참고하시기 바랍니다.

오류코드 표

HTTP 응답 오류코드 오류메시지 설명
403 998 Authentication token is missing or incorrect. 인증 오류
406 2000 ~ 5000 오류 상세 메시지 비즈니스 로직 처리중 오류 발생
500 999 Internal server error System 오류

첨부

PGCode 표

PGCode 비고
creditcard 신용카드
kftc 인터넷뱅킹(금융결제원)
inibank 인터넷뱅킹(이니시스)
virtualaccount 가상계좌
mobile 휴대폰
book 도서상품권
culture 문화상품권
smartculture 스마트문상
happymoney 해피머니상품권
mobilepop 모바일팝
teencash 틴캐시
tmoney 교통카드결제
cvs 편의점캐시
eggmoney 에그머니
oncash 온캐시
phonebill 폰빌
cashbee 캐시비