파라미터

해외 카드〉운영

1. 취소

1 .1 파트너 인증 요청

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

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

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

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

1.2 취소 요청

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

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

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

파라미터	타입	설명	값 예시
type	String	요청 종류입니다. 승인: PAYMENT / 취소: CANCEL	CANCEL
result	String	응답 코드입니다.	A0000
message	String	응답 메시지입니다.	Processing Success
org_pay_id	String	원거래 결제 건의 pay_id입니다.	6548264741426583803027
api_id	String	결제결과에 대한 고유키입니다.	6548264741426583803027
api_date	String	대한민국(UTC+9) 기준 취소시간입니다.	2022-06-10 11:01:17
receiptUrl	String	매출전표(거래 내역서) 조회 URL입니다.	https://api.payple.kr/gpay/receipt?token=abc123...
info	Object	결제취소정보입니다.
totalAmount	String	결제 취소를 요청한 금액입니다.	0.10
currency	String	결제통화입니다.	USD
service_oid	String	주문번호입니다.	order12345
orgTotalAmount	String	원거래 결제 건의 결제금액입니다.	0.10
remainAmount	String	원거래 결제 건의 잔여금액입니다.	0.10
submitTimeUtc	String	국제표준시(UTC) 기준 취소시간입니다.	2022-06-10 02:01:16

2. 결과조회

2.1 파트너 인증 요청

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

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

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

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

2.2 결과조회 요청

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

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

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

파라미터	타입	설명	값 예시
type	String	요청 종류입니다. 승인: PAYMENT / 취소: CANCEL	PAYMENT
result	String	응답 코드입니다.	A0000
message	String	응답 메시지입니다.	Processing Success
returnUrl	String	결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.
api_id	String	결제결과에 대한 고유키입니다.	6548264741426583803027
api_date	String	대한민국(UTC+9) 기준 취소시간입니다.	2022-06-10 11:01:17
receiptUrl	String	매출전표(거래 내역서) 조회 URL입니다.	https://api.payple.kr/gpay/receipt?token=abc123...
info	Object	결제정보입니다.
service_oid	String	주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다.	order12345
comments	String	상품명입니다.	테스트 상품
pay_type	String	결제수단입니다. 현재는 card 만 가능합니다.	card
card_number	String	카드번호입니다.	1234---5678
totalAmount	String	원거래 결제금액입니다. type 값이 PAYMENT인 경우 결제금액, CANCEL인 경우 취소금액으로 확인합니다.	0.10
currency	String	결제통화입니다.	USD
firstName	String	카드회원의 이름입니다.	iple
lastName	String	카드회원의 성입니다.	Kim
email	String	구매자 이메일입니다.	complete@payer-email.com
phoneNumber	String	구매자 휴대폰번호입니다.	01012345678
billing_key	String	정기(빌링)결제 시 사용되는 빌링키입니다.	MlNCQ0pHMn…
orgTotalAmount	Number	원거래 결제금액입니다.	1000
remainAmount	Number	원거래 잔여금액입니다.	0
submitTimeUtc	String	국제표준시(UTC) 기준 결과조회 시간입니다.	2022-06-10 02:01:16…

3. 빌링키 해지

3.1 파트너 인증 요청

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

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

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

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

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

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

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

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

4. 빌링키 차단

4.1 파트너 인증 요청

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

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

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

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

4.2 빌링키 차단/해제 요청

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

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

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

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

5. 매출전표 조회

5.1 GET 방식 조회 (토큰)

GET 방식 매출전표 조회에 필요한 Request 파라미터는 아래와 같습니다. Query String으로 전달합니다.

파라미터	필수	타입	길이	설명	값 예시
token		String		결제 승인/취소 응답의 receiptUrl에 포함된 암호화 토큰입니다. 별도의 파트너 인증(OAuth)이 필요하지 않습니다. 결제 승인/취소 응답값의 receiptUrl을 그대로 호출하면 됩니다.	abc123...
lang		String	2	매출전표 언어 설정입니다. 미전송 시 한국어(kr)로 응답됩니다. kr(한국어) 또는 en(영어)을 지원합니다.	kr

5.2 파트너 인증 요청 (POST)

매출전표 조회를 위한 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.

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

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

파라미터	타입	설명	값 예시
result	String	응답 코드입니다.	T0000
message	String	응답 메세지입니다.	Process Success
code	String	토큰 확인 코드입니다.	as12345678
access_token	String	발행된 Access 토큰입니다. 매출전표 조회 요청 시 Authorization 파라미터에 포함하여 요청합니다.	eyJhbGciOiJzaGEyNT…
token_type	String	Access 토큰 유형이며, 고정값입니다.	Bearer
payCls	String	테스트 구분값입니다. 테스트 서버(demo-api.payple.kr)로 요청 시 응답되며, 결제창 호출 외 기타 API 요청 시 사용하지 않습니다.	demo
expires_in	String	Access 토큰 만료 시간입니다.(초)	600

5.3 POST 방식 조회 (OAuth)

POST 방식 매출전표 조회에 필요한 Request 파라미터는 아래와 같습니다. 파트너 인증 후 발급받은 Access Token을 Authorization Header에 포함하여 요청합니다.

파라미터	필수	타입	길이	설명	값 예시
pay_id		String		결제 성공 시 응답된 결제 고유 ID입니다. 취소건 조회의 경우 원거래가 아닌 취소 거래의 pay_id 를 사용해야 합니다.	6548264741426583803027
lang		String	2	매출전표 언어 설정입니다. 미전송 시 한국어(kr)로 응답됩니다. kr(한국어) 또는 en(영어)을 지원합니다.	kr

5.4 매출전표 조회 응답

매출전표 조회가 성공적으로 완료된 후에 받게 되는 Response는 다음과 같습니다.

파라미터	타입	설명	값 예시
HTML	text/html	매출전표(거래 내역서) HTML 페이지를 직접 반환합니다. 상점 정보(상호명, 서비스명, 웹사이트, 연락처) 결제 정보(거래 ID, 결제 시간(KST), 주문번호, 결제 금액, 환불 금액, 상품명, 국가, 구매자 이름/이메일, 카드번호(마스킹), 국제 브랜드사) GET/POST 방식 모두 동일한 HTML 응답을 반환합니다.