파라미터

해외 카드〉정기(빌링) 결제

1. 파트너 인증 요청

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

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

인증이 성공적으로 완료된 경우, 수신되는 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)로 요청 시 응답되며, 테스트 서버로 결제요청 시 해당 파라미터도 함께 전송해야 합니다.	demo…
expires_in	String	Access 토큰 만료 시간입니다.(초)	600

2. 결제창 호출

아래는 결제창 호출 시 사용 가능한 Request 파라미터 목록입니다.

파라미터	필수	타입	길이	설명	값 예시
Authorization		String	500	파트너 인증 후 발급받은 access_token 입니다.
service_id		String	20	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.
comments		String	255	상품명입니다.	테스트 상품
totalAmount		String	10	결제금액입니다. 외화(USD, JPY)는 소수점 둘째 자리까지만 허용 원화(KRW)는 정수만 가능(소수점 불가)	0.10
currency		String	3	결제통화입니다. 가능한 통화는 KRW, USD, JPY 이며, 통화별 파트너(상점) 계정 발급이 필요 테스트 환경에서는 USD 만 가능	USD
resultUrl		String	500	결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.	/result
payCls	테스트 시	String	10	테스트 서버로 결제요청 시에 필요한 값입니다.	demo
service_oid		String	128	주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다.	order12345
firstName		String	25	카드회원의 이름입니다.	iple
lastName		String	25	카드회원의 성입니다.	Kim
email		String	255	구매자 이메일입니다. 결제완료, 취소 이메일이 발송됩니다.	complete@payer-email.com
isDirect		String	1	결제창 호출 방식입니다. Y : 다이렉트 / 공란 : 팝업	Y
country		String	2	청구지 주소 - 국가코드입니다. 카드회원의 청구지 주소가 없으면 발급사 거절 확률이 높아집니다. 표준국가코드(ISO 3166-1)에서 정의된 2자리의 국가코드를 입력해야합니다. 상세내용은 여기에서 확인 가능합니다.	US
administrativeArea		String	2	청구지 주소 - 행정구역 코드입니다. country가 미국(US) 또는 캐나다(CA)인 경우 필수로 입력해야하는 값입니다. 상세내용은 여기에서 확인 가능합니다.	NY
locality		String	32	청구지 주소 - 시/군/구 입니다.	New York
address		String	40	청구지 주소 - 도로명입니다.	1000 5th Ave
postalCode		String	5	청구지 주소 - 우편번호입니다.	10028
serviceDefine		String	2048	사용자 정의 파라미터입니다. 파트너(상점)에서 보낸 값 그대로 반환됩니다.	We help our partners grow.

3. 결제결과 수신

결제 정보가 성공적으로 입력된 경우, POST 방식으로 수신되는 Response 파라미터는 다음과 같습니다.

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

4. 빌링키로 승인 요청

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

파라미터	타입	길이	설명	값 예시
service_id	String	20	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	demo
billing_key	String	128	빌링키입니다.	MlNCQ0pHMn…
comments	String	255	상품명입니다.	테스트 상품
totalAmount	String	10	결제금액입니다. 외화(USD, JPY)는 소수점 둘째 자리까지만 허용 원화(KRW)는 정수만 가능(소수점 불가)	0.10
currency	String	3	결제통화입니다. 가능한 통화는 KRW, USD, JPY 이며, 통화별 파트너(상점) 계정 발급이 필요 테스트 환경에서는 USD 만 가능	USD
resultUrl	String	500	결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.	/result
service_oid	String	128	주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다.	order12345
firstName	String	25	카드회원의 이름입니다.	iple
lastName	String	25	카드회원의 성입니다.	Kim
email	String	255	구매자 이메일입니다. 결제완료, 취소 이메일이 발송됩니다.	complete@payer-email.com
country	String	2	청구지 주소 - 국가코드입니다. 카드회원의 청구지 주소가 없으면 발급사 거절 확률이 높아집니다. 표준국가코드(ISO 3166-1)에서 정의된 2자리의 국가코드를 입력해야합니다. 상세내용은 여기에서 확인 가능합니다.	US
administrativeArea	String	2	청구지 주소 - 행정구역 코드입니다. country가 미국(US) 또는 캐나다(CA)인 경우 필수로 입력해야하는 값입니다. 상세내용은 여기에서 확인 가능합니다.	NY
locality	String	32	청구지 주소 - 시/군/구 입니다.	New York
address	String	40	청구지 주소 - 도로명입니다.	1000 5th Ave
postalCode	String	5	청구지 주소 - 우편번호입니다.	10028
serviceDefine	String	2048	사용자 정의 파라미터입니다. 파트너(상점)에서 보낸 값 그대로 반환됩니다.	We help our partners grow.

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

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