로고Developer Center
홈페이지가입문의

파라미터

해외 카드운영


1. 취소

1 .1 파트너 인증 요청

결제 취소 파트너 인증에 필요한 인증에 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
service_keyString128파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
codeString10파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다.
  • 영문+숫자 조합 10자리로 구성되어야 합니다.
as12345678

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
resultString응답 코드입니다.T0000
messageString응답 코드입니다.Process Success
codeString토큰 확인 코드입니다.as12345678
access_tokenString발행된 Access 토큰입니다.
  • 결제요청 시 Authorization 파라미터에 포함하여 요청합니다.
eyJhbGciOiJzaGEyNT…
token_typeStringAccess 토큰 유형이며, 고정값입니다.Bearer
payClsString테스트 구분값입니다.
  • 테스트 서버(demo-api.payple.kr)로 요청 시 응답되며, 결제창 호출 외 기타 API 요청 시 사용하지 않습니다.
demo
expires_inStringAccess 토큰 만료 시간입니다.(초)600

1.2 취소 요청

취소 요청을 위해 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
commentsString255상품명입니다.테스트 상품
service_oidString128주문번호입니다. 파트너(상점)에서 만든 값으로 거래에 대한 고유식별변호입니다.
중복되지 않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를
응답합니다.
order12345
pay_idString50결제결과 고유키입니다. 결제결과로 수신한 api_id 를 이용해주세요..6548264741426583803027
totalAmountString10결제금액입니다.
  • 외화(USD, JPY)는 소수점 둘째 자리까지만 허용됩니다.
  • 원화(KRW)는 정수만 허용됩니다.
0.10
currencyString3결제통화입니다.
  • 가능한 통화는 KRW, USD, JPY 이며, 통화별 파트너(상점) 계정 발급이 필요
  • 테스트 환경에서는 USD 만 가능
USD

취소가 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
typeString요청 종류입니다.
  • 승인: PAYMENT / 취소: CANCEL
CANCEL
resultString응답 코드입니다.A0000
messageString응답 메시지입니다.Processing Success
api_idString결제결과에 대한 고유키입니다.6548264741426583803027
api_dateString대한민국(UTC+9) 기준 취소시간입니다.2022-06-10 11:01:17
infoObject결제취소정보입니다.
totalAmountString결제금액입니다.0.10
currencyString결제통화입니다.USD
service_oidString주문번호입니다.order12345
submitTimeUtcString국제표준시(UTC) 기준 취소시간입니다.2022-06-10 02:01:16

2. 결과조회

2.1 파트너 인증 요청

결제창 호출을 위한 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
service_keyString128파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
codeString10파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다.
  • 영문+숫자 조합 10자리로 구성되어야 합니다.
as12345678

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
resultString응답 코드입니다.T0000
messageString응답 코드입니다.Process Success
codeString토큰 확인 코드입니다.as12345678
access_tokenString발행된 Access 토큰입니다.
  • 결제요청 시 Authorization 파라미터에 포함하여 요청합니다.
eyJhbGciOiJzaGEyNT…
token_typeStringAccess 토큰 유형이며, 고정값입니다.Bearer
payClsString테스트 구분값입니다.
  • 테스트 서버(demo-api.payple.kr)로 요청 시 응답되며, 결제창 호출 외 기타 API 요청 시 사용하지 않습니다.
demo
expires_inStringAccess 토큰 만료 시간입니다.(초)600

2.2 결과조회 요청

파트너 인증 후 결과조회 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
service_oidString128주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지 않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다.order12345
pay_idString50결제결과 고유키입니다. 결제결과로 수신한 api_id 를 이용해주세요.6548264741426583803027

결과조회가 성공적으로 완료된 후에 받게되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
typeString요청 종류입니다.
  • 승인: PAYMENT / 취소: CANCEL
PAYMENT
resultString응답 코드입니다.A0000
messageString응답 메시지입니다.Processing Success
returnUrlString결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.
api_idString결제결과에 대한 고유키입니다.6548264741426583803027
api_dateString대한민국(UTC+9) 기준 취소시간입니다.2022-06-10 11:01:17
infoObject결제정보입니다.
service_oidString주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다.order12345
commentsString상품명입니다.테스트 상품
pay_typeString결제수단입니다. 현재는 card 만 가능합니다.card
card_numberString카드번호입니다.1234-****-****-5678
totalAmountString결제금액입니다.0.10
currencyString결제통화입니다.USD
firstNameString카드회원의 이름입니다.iple
lastNameString카드회원의 성입니다.Kim
emailString구매자 이메일입니다.complete@payer-email.com
phoneNumberString구매자 휴대폰번호입니다.01012345678
billing_keyString정기(빌링)결제 시 사용되는 빌링키입니다.MlNCQ0pHMn…
submitTimeUtcString국제표준시(UTC) 기준 결과조회 시간입니다.2022-06-10 02:01:16…

3. 빌링키 해지

3.1 파트너 인증 요청

빌링키 해지를 위한 파트너 인증 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
service_keyString128파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
codeString10파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다.
  • 영문+숫자 조합 10자리로 구성되어야 합니다.
as12345678

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
resultString응답 코드입니다.T0000
messageString응답 코드입니다.Process Success
codeString토큰 확인 코드입니다.as12345678
access_tokenString발행된 Access 토큰입니다.
  • API 요청 시 Header의 Authorization 필드에 포함하여 전송해야 합니다.
eyJhbGciOiJzaGEyNT…
token_typeStringAccess 토큰 유형이며, 고정값입니다.Bearer
payClsString테스트 구분값입니다.
  • 테스트 서버(demo-api.payple.kr)로 요청 시 응답되며, 결제창 호출 외 기타 API 요청 시 사용하지 않습니다.
demo
expires_inStringAccess 토큰 만료 시간입니다.(초)600

3.2 빌링키 해지 요청

파트너 인증 후 빌링키 해지 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
billing_keyString128빌링키입니다MlNCQ0pHMn…

빌링키 해지가 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
typeString요청 종류입니다.BILLKEY
resultString응답 코드입니다.A0000
messageString응답 메시지입니다.Processing Success
billing_keyString정기(빌링)결제 시 사용되는 빌링키입니다.MlNCQ0pHMn…
api_dateString대한민국(UTC+9) 기준 빌링키 해지 시간입니다.2022-06-10 11:01:17
submitTimeUtcString국제표준시(UTC) 기준 빌링키 해지 시간입니다.2022-06-10 02:01:16

4. 빌링키 차단

4.1 파트너 인증 요청

빌링키 차단을 위한 파트너 인증 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
service_keyString128파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
  • 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
codeString10파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다.
  • 영문+숫자 조합 10자리로 구성되어야 합니다.
as12345678

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
resultString응답 코드입니다.T0000
messageString응답 코드입니다.Process Success
codeString토큰 확인 코드입니다.as12345678
access_tokenString발행된 Access 토큰입니다.
  • API 요청 시 Header의 Authorization 필드에 포함하여 전송해야 합니다.
eyJhbGciOiJzaGEyNT…
token_typeStringAccess 토큰 유형이며, 고정값입니다.Bearer
payClsString테스트 구분값입니다.
  • 테스트 서버(demo-api.payple.kr)로 요청 시 응답되며, 결제창 호출 외 기타 API 요청 시 사용하지 않습니다.
demo
expires_inStringAccess 토큰 만료 시간입니다.(초)600

4.2 빌링키 차단/해제 요청

파트너 인증 후 빌링키 차단/해제 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터필수타입길이설명값 예시
service_idString20파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.demo
billing_keyString128빌링키입니다MlNCQ0pHMn…

빌링키 차단/해제가 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터타입설명값 예시
typeString요청 종류입니다.BILLKEY
resultString응답 코드입니다.A0000
messageString응답 메시지입니다.Processing Success
billing_keyString정기(빌링)결제 시 사용되는 빌링키입니다.MlNCQ0pHMn…
api_dateString대한민국(UTC+9) 기준 빌링키 해지 시간입니다.2022-06-10 11:01:17
submitTimeUtcString국제표준시(UTC) 기준 빌링키 해지 시간입니다.2022-06-10 02:01:16