연동준비
해외 카드결제
샘플코드
페이플 결제 연동을 위한 샘플코드는 아래 버튼을 눌러 확인해주세요.
API 키, 테스트 정보
페이플이 제공하는 테스트 정보를 통해 계약 전 단계에서도 누구나 연동 체험이 가능합니다.
1. 접속정보
내용 | |
---|---|
접속 도메인 | https://demo-api.payple.kr |
service_id | demo |
service_key | abcd1234567890 |
code | as12345678 |
2. 확인사항
내용 | |
---|---|
code | code 는 파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다. ·code 생성규칙 영문+숫자 조합 10자리이며, 유효한 code 가 아닌 경우 T0211 응답코드를 수신합니다. |
국내 카드 화이트리스트 | 파트너(상점) 당 1개의 화이트리스트 처리 가능합니다. ·테스트 환경에서는 국내(KR), 해외발행카드 모두 이용 가능하지만, 라이브 환경에서는 해외발행카드만 이용 가능합니다. ·라이브 환경에서 국내(KR)발행카드로 테스트를 위해서는 고객센터(help@payple.kr)를 통한 화이트리스트 처리 요청이 필요합니다. |
화이트(White) IP 등록 | 페이플 해외 카드결제는 등록되어있는 IP 와의 통신만 허용되며, 등록은 고객센터(help@payple.kr)로 요청이 필요합니다. ·테스트 환경에서는 화이트 IP 등록이 필요없습니다. |
위험국가 리스트 | 위험국가에서 발행된 카드는 이상거래탐지시스템(Decision Manager)에 의해 결제가 거부됩니다. ·위험국가 코드는 여기에서 확인할 수 있습니다. |
웹훅(Webhook)
페이플 웹훅을 이용하면 결제결과 누락을 방지할 수 있습니다.
1. 수신가능 이벤트
이벤트 | 설명 |
---|---|
결제 완료 | 결제 완료 결과를 수신합니다. |
취소 완료 | 결제 취소 결과를 수신합니다. ·파트너 관리자에서 직접 취소한 건도 포함됩니다. |
·라이브
라이브 환경에서 웹훅 등록은 파트너 관리자 〉 기본정보 메뉴에서 가능합니다.
2. 수신 데이터 설명과 예시
2.1 결제 완료
해외 카드결제
JSON
1{
2 "type": "요청 종류",
3 "result": "응답 코드",
4 "message": "응답 메시지",
5 "resultUrl": "결제결과 반환(Return) URL",
6 "api_id": "결제 요청 고유키",
7 "api_date": "대한민국(UTC+9) 기준 결제시간",
8 "info": {
9 "service_oid": "주문번호",
10 "comments": "상품명",
11 "pay_type": "결제수단",
12 "billing_key": "빌링키",
13 "totalAmount": "결제 요청금액",
14 "currency": "통화",
15 "firstName": "카드회원 이름",
16 "lastName": "카드회원 성",
17 "email": "이메일",
18 "phoneNumber": "휴대전화번호",
19 "card_number": "카드번호",
20 "submitTimeUtc": "국제표준시(UTC) 기준 결제시간"
21 },
22 "serviceDefine": "사용자 정의 파라미터"
23}
해외 카드결제 예시
JSON
1{
2 "type": "PAYMENT",
3 "result": "A0000",
4 "message": "처리 성공",
5 "resultUrl": "http://test.shop.com",
6 "api_id": "6548264741426583803027",
7 "api_date": "2022-06-10 11:01:17",
8 "info": {
9 "service_oid": "test120220608512351",
10 "comments": "테스트상품명",
11 "pay_type": "card",
12 "billing_key": "MlNCQ0pHMn...",
13 "totalAmount": "0.10",
14 "currency": "USD",
15 "firstName": "Gildong",
16 "lastName": "Hong",
17 "email": "test@payple.kr",
18 "phoneNumber": "01012345678",
19 "card_number": "1234-****-****-7890",
20 "submitTimeUtc": "2022-06-10 02:01:16"
21 },
22 "serviceDefine": "Service Define Test"
23}
2.2 취소 완료
해외 카드결제
JSON
1{
2 "type": "요청 종류",
3 "result": "응답 코드",
4 "message": "응답 메시지",
5 "resultUrl": "취소 요청시 보낸 값 그대로 반환되는 URL",
6 "api_id": "취소 고유키",
7 "api_date": "대한민국(UTC+9) 기준 취소시간",
8 "info": {
9 "totalAmount": "취소 요청 금액",
10 "currency": "취소 통화",
11 "service_oid": "원거래 주문번호",
12 "submitTimeUtc": "국제표준시(UTC) 기준 취소시간"
13 },
14 "serviceDefine": "사용자 정의 파라미터"
15}
해외 카드결제 예시
JSON
1{
2 "type": "CANCEL",
3 "result": "A0000",
4 "message": "처리 성공",
5 "resultUrl": "http://test.shop.com",
6 "api_id": "676273618072602",
7 "api_date": "2022-06-10 16:09:22",
8 "info": {
9 "totalAmount": "0.10",
10 "currency": "USD",
11 "service_oid": "OID_22072217525616584799763773750",
12 "submitTimeUtc": "2022-06-10 07:09:22"
13 },
14 "serviceDefine": "Service Define Test"
15}