Type은 파라미터의 '자료형'을 의미하는것이 아니라, 파라미터 값의 형태를 의미합니다. Type 보는 방법에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다.
에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다. 전체 파라미터 정의
전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 상황별 요청 및 응답 파라미터도 확인해보세요.
도 확인해보세요.※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
기본 보기
Search
상황별 파라미터 정의
요청, 응답 파라미터를 파트너 인증 토큰발급, 카드 결제, 결제 취소로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법 상황별 Request 표에서 필수와 요청 구분을 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
•
필수 : 요청 구분에서 해당 파라미터의 필수 값 여부
•
요청 구분 : 해당 파라미터가 쓰이는 결제방식 및 기타 API
예시) 필수가 Y, 요청 구분이 all 이면, 모든 상황에서 필수 파라미터입니다.
필수가 Y, 요청 구분이 빌링키 결제면, 빌링키 결제 요청시에만 필수 파라미터입니다.
필수가 N, 요청 구분이 all 이면, 모든 상황에서 선택 파라미터입니다.
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요
파트너 인증 토큰발급
기본 보기
Search
파트너 인증 토큰발급 요청 필수 파라미터 확인 예시
•
service_id, service_key , code: 모든(all) 파트너 인증 토큰발급 요청 시 필수 파라미터입니다.
파트너 인증 토큰발급 Request(Body) 예시
{
"service_id":"demo",
"service_key":"abcd1234567890",
"code":"as12345678"
}
JSON
기본 보기
Search
파트너 인증 토큰발급 Response 예시
{
"result":"T0000",
"message":"처리 성공",
"code":"as12345678",
"access_token":"eyJhlNDlj...",
"token_type":"Bearer",
"expires_in":"60"
}
JSON
카드 결제 파라미터
기본 보기
Search
기본 보기
Search
카드 결제 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
결제 취소 Request(Body) 예시
{
"service_id":"demo",
"comments": "테스트상품명",
"service_oid": "test120220608512351",
"pay_id": "6548264741426583803027",
"totalAmount": "0.10",
"currency": "USD",
"resultUrl" : "http://test.shop.com"
}
JSON
기본 보기
Search
결제 취소 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
Payple Inc. All rights reserved.