Search

파라미터 정의

전체 파라미터 정의

전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 상황별 요청 및 응답 파라미터도 확인해보세요.
※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
Search
Parameter
Parameter
Request Value
Request Type (Length)
Reference
Response Value
Response Type
더 알아보기
"abcd1234567890"
aN(255)
파트너 인증키
"abcd1234567890"
String
"as12345678"
aN(10)
파트너용 토큰 확인 코드
"as12345678"
String
-
-
요청 종류
["PAYMENT" | "CANCEL"]
String
-
-
응답 코드
"T0000"
String
-
-
응답 메시지
"Process Success"
String
-
-
발행된 Access Token
"eyJhbGciOiJzaGEyNT..."
String
-
-
Access Token 유형
"Bearer" (고정값)
String
-
-
Access Token 만료 기간(초)
"600"
String
"eyJhbGciOiJzaGEyNT..."
-
발급받은 Access Token (파트너 인증 토큰발급 응답값 중 access_token)
"eyJhbGciOiJzaGEyNT..."
String
"test120220608512351"
aN(128)
주문번호
"test120220608512351"
String
"테스트상품명"
aAHN(200)
상품명
"테스트상품명"
String
"0.10"
N
결제 요청금액
"0.10"
String
"USD"
A(3)
통화
"USD"
String
"Gildong"
aAHN(25)
카드소유주 이름
"Gildong"
String
"Hong"
aAHN(25)
카드소유주 성
"Hong"
String
"US"
A(2)
국가
"US"
String
"AZ"
A(2)
도/시
"AZ"
String
"302 14 Teheran-ro 34-gil Gangnam-gu"
aNS(40)
도로명 - 특수문자는 space(공백)와 - . _ 만 가능
"302 14 Teheran-ro 34-gil Gangnam-gu"
String
"Seoul"
aNS(32)
시/구/군 - 특수문자는 space(공백)와 - . _ 만 가능
"Seoul"
String
"06220"
aN(6)
우편번호
"06220"
String
"test@payple.kr"
E(250)
이메일 주소
"test@payple.kr"
String
"01012345678"
N(11)
휴대전화 번호
"01012345678"
String
"http://test.shop.com"
-
결제결과 반환(Return) URL
"http://test.shop.com"
String
["Y" | ""]
A(1)
결제창 호출 다이렉트 여부
["Y" | ""]
String
-
-
요청 고유키
"6548264741426583803027"
String
-
-
요청 시간 (페이플 서버기준: GMT +9)
"2022-06-10 11:01:17"
String
-
-
요청 시간 (사용자 입장에서 기준이 되는 결제시간: GMT)
"2022-06-10 02:01:17"
String
"MlNCQ0pHMn…"
aNS(128)
빌링키 (카드정보를 암호화 한 키 값)
"MlNCQ0pHMn…"
String
-
-
결제수단
"card"
String
-
-
카드번호 (일부 마스킹 처리)
"1234-****-****-7890"
String
"6548264741426583803027"
-
결제 요청 고유키
-
String
"Service Define Test"
aAHNS(2048)
사용자 정의 파라미터
"Service Define Test"
String
COUNT33

상황별 파라미터 정의

요청, 응답 파라미터를 파트너 인증 토큰발급, 카드 결제, 결제 취소로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법
상황별 Request 표에서 필수와 요청 구분을 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
필수 : 요청 구분에서 해당 파라미터의 필수 값 여부
요청 구분 : 해당 파라미터가 쓰이는 결제방식 및 기타 API
예시) 필수가 Y, 요청 구분이 all 이면, 모든 상황에서 필수 파라미터입니다.
필수가 Y, 요청 구분이 빌링키 결제면, 빌링키 결제 요청시에만 필수 파라미터입니다.
필수가 N, 요청 구분이 all 이면, 모든 상황에서 선택 파라미터입니다.
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요

파트너 인증 토큰발급

Search
Parameter
Request Value
Type (Length)
필수
요청 구분
Reference
더 알아보기
"demo"
aN(8)
Y
all
파트너 ID
"abcd1234567890"
aN(255)
Y
all
파트너 인증키
"as12345678"
aN(10)
Y
all
파트너용 토큰 확인 코드
파트너 인증 토큰발급 요청 필수 파라미터 확인 예시
service_id, service_key , code: 모든(all) 파트너 인증 토큰발급 요청 시 필수 파라미터입니다.
파트너 인증 토큰발급 Request(Body) 예시
{ "service_id":"demo", "service_key":"abcd1234567890", "code":"as12345678" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"T0000"
String
응답 코드
"처리 성공"
String
응답 메시지
"as12345678"
String
파트너용 토큰 확인 코드
"eyJhlNDlj..."
String
발행된 Access Token
"Bearer" (고정값)
String
Access Token 유형
"60"
String
Access Token 만료 기간(초)
COUNT6
파트너 인증 토큰발급 Response 예시
{ "result":"T0000", "message":"처리 성공", "code":"as12345678", "access_token":"eyJhlNDlj...", "token_type":"Bearer", "expires_in":"60" }
JSON
복사

카드 결제 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"eyJhbGciOiJzaGEyNT..."
-
Y
발급받은 Access Token
"demo"
aN(8)
Y
파트너 ID
"test120220608512351"
aN(128)
N
주문번호
"테스트상품명"
aAHN(200)
Y
상품명
"0.10"
N
Y
결제 요청금액
"USD"
A(3)
Y
통화
"Gildong"
aAHN(25)
N
카드소유주 이름
"Hong"
aAHN(25)
N
카드소유주 성
"test@payple.kr"
E(250)
N
이메일 주소
"01012345678"
N(11)
N
휴대전화 번호
"http://test.shop.com"
Y
결제결과 반환(Return) URL
["Y" | ""]
A(1)
N
결제창 호출 다이렉트 여부
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
String
응답 코드
"처리 성공"
String
응답 메시지
"http://test.shop.com"
String
결제결과 반환(Return) URL
"6548264741426583803027"
String
결제 요청 고유키
"2022-06-10 11:01:17"
String
결제 시간 (페이플 서버기준: GMT +9)
"test120220608512351"
String
주문번호
"테스트상품명"
String
상품명
"card"
String
결제수단
"1234-****-****-7890"
String
카드번호 (일부 마스킹 처리)
"0.10"
String
결제 요청금액
"USD"
String
통화
"Gildong"
String
카드소유주 이름
"Hong"
String
카드소유주 성
"test@payple.kr"
String
이메일 주소
"01012345678"
String
휴대전화 번호
"MlNCQ0pHMn…"
String
빌링키 (카드정보를 암호화 한 키 값)
"2022-06-10 02:01:16"
String
결제 시간 (해외 사용자 기준: GMT )
COUNT17
카드 결제 Response 예시 (결제창 기준)
{ "result": "A0000", "message": "처리 성공", "resultUrl": "http://test.shop.com", "api_id": "6548264741426583803027", "api_date": "2022-06-10 11:01:17", "service_oid": "test120220608512351", "comments": "테스트상품명", "pay_type": "card", "card_number": "1234-****-****-7890", "totalAmount": "0.01", "currency": "USD", "firstName": "Gildong", "lastName": "Hong", "email": "test@payple.kr", "phoneNumber": "01012345678", "billing_key": "MlNCQ0pHMn…", "submitTimeUtc": "2022-06-10 02:01:16" }
JSON
복사

결제 취소

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"demo"
aN(8)
Y
파트너 ID
"테스트상품명"
aAHN(200)
Y
상품명
"test120220608512351"
aN(128)
Y
주문번호
"6548264741426583803027"
Y
취소할 결제건의 api_id * 결제 결과로 받은 응답값인 결제요청 고유키인 api_id를 보내야합니다.
"0.10"
N
Y
결제 취소 요청금액
"USD"
A(3)
Y
통화
"http://test.shop.com"
N
요청 파라미터에 넣어서 보낼 시, 그대로 응답 파라미터로 반환됩니다.
결제 취소 Request(Body) 예시
{ "service_id":"demo", "comments": "테스트상품명", "service_oid": "test120220608512351", "pay_id": "6548264741426583803027", "totalAmount": "0.10", "currency": "USD", "resultUrl" : "http://test.shop.com" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
String
응답 코드
"처리 성공"
String
응답 메시지
"http://test.shop.com"
String
취소 요청시 보낸 값 그대로 반환
"2022-06-10 16:09:22"
String
결제취소 요청 일자
"0.10"
String
결제취소 요청 금액
"USD"
String
결제취소 통화
COUNT6
결제 취소 Response 예시
{ "result": "A0000", "message": "처리 성공", "resultUrl": "http://test.shop.com", "api_date": "2022-06-10 16:09:22", "info": { "totalAmount": "0.10", "currency": "USD" } }
JSON
복사
Search
약자
설명
ALPHABETIC * 대소문자 구분 없음
ALPHABETIC * 단, 반드시 대문자로 설정
NUMERIC
한글 (UTF-8 인코딩 문자열)
ALPHA-NUMERIC * 단, 알파벳(ALPHABET)은 반드시 대문자로 설정
ALPHA-NUMERIC
ALPHA-한글
ALPHA-NUMERIC-SPECIAL
ALPHA-한글-NUMERIC-SPECIAL
COUNT9
Payple Inc. All rights reserved.