파라미터

해외 카드〉간편페이 결제

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)로 요청 시 응답되며, 테스트 서버로 결제요청 시 해당 파라미터도 함께 전송해야 합니다.	demo
expires_in	String	Access 토큰 만료 시간입니다.(초)	600

2. 결제창 호출

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

파라미터	필수	타입	길이	설명	값 예시
Authorization		String	500	파트너 인증 후 발급받은 access_token 입니다.
serviceId		String	20	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	demo
comments		String	255	상품명입니다.	테스트 상품
totalAmount		String	10	결제금액입니다. 소수점 둘째 자리까지만 허용 CNY 최소 결제금액은 1	1.00
resultUrl		String	500	결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.	/result
payCls	테스트 시	String	10	테스트 서버로 결제요청 시에 필요한 값입니다.	demo
currency		String	3	결제통화입니다. 알리페이만 지원되어 현재는 CNY 만 가능 미전송 시 CNY 로 자동 처리됩니다.	CNY
availablePaymentMethod		String	30	특정 간편페이 결제가 필요한 경우 사용합니다. 알리페이는 중국 신분증을 가진 고객만 결제가 가능합니다.	alipay
serviceOid		String	128	주문번호입니다. 파트너(상점)에서 생성한 거래에 대한 고유식별번호입니다. 중복되지않는 고유한 값을 발급해야하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다.	order12345
orders		String		결제창에 표시할 상품 정보입니다. 객체 배열을 JSON 문자열로 전송합니다. 금액·수량·주문번호는 숫자로 넣어도 문자열로 통일해 전송합니다.	[{"orderId":"item-001","name":"테스트 상품","quantity":"1","unitPrice":"1.00"}]
orderId		String		상품 주문번호입니다. orders 전송 시 필수입니다.	item-001
name		String		상품명입니다. orders 전송 시 필수입니다.	테스트 상품
quantity		String		상품 수량입니다. orders 전송 시 필수입니다.	1
unitPrice		String		상품 단가입니다. orders 전송 시 필수입니다.	1.00
firstName		String	25	구매자의 이름입니다.	iple
lastName		String	25	구매자의 성입니다.	Kim
email		String	255	구매자 이메일입니다. 결제완료, 취소 이메일이 발송됩니다.	complete@payer-email.com
isDirect		String	1	결제창 호출 방식입니다. Y : 다이렉트 / 공란 : 팝업	Y
backgroundColor		String	7	결제창 전체 배경 색상입니다. HEX 코드(#RRGGBB)로 전송합니다.	#FFFFFF
foregroundColor		String	7	기본 텍스트 및 전경 요소 색상입니다. HEX 코드(#RRGGBB)로 전송합니다.	#121212
accentColor		String	7	버튼, 가격, 선택 상태 등 강조 영역 색상입니다. HEX 코드(#RRGGBB)로 전송합니다.	#EA3D2F
serviceDefine		String	2048	사용자 정의 파라미터입니다. 파트너(상점)에서 보낸 값 그대로 반환됩니다.	We help our partners grow.

3. 결제결과 수신

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

파라미터	타입	설명	값 예시
type	String	요청 종류입니다. 승인 : PAYMENT / 취소 : CANCEL	PAYMENT
result	String	응답 코드입니다. A0000 : 성공 / A0006 : 처리 중(미확정, 실패 아님) / 그 외 : 실패 A0006 은 간편결제에서만 발생하며, 최종 상태는 결과조회 API로 확인합니다.	A0000
message	String	결과 문구입니다.	처리 성공
resultUrl	String	결제 정보가 성공적으로 입력된 경우, 인증 결과가 POST 방식으로 전송됩니다.	/result
apiId	String	결제결과에 대한 고유키입니다.	6548264741426583803027
apiDate	String	대한민국(UTC+9) 기준 결제시간입니다.	2022-06-10 11:01:17
receiptUrl	String	매출전표(거래 내역서) 조회 URL입니다. 브라우저에서 바로 호출하여 매출전표를 확인할 수 있습니다.	https://api.payple.kr/gpay/receipt?token=abc123...
serviceOid	String	주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다.	order12345
comments	String	상품명입니다.	테스트 상품
payType	String	결제수단입니다. alipay 고정값입니다.	alipay
totalAmount	String	결제금액입니다.	1.00
currency	String	결제통화입니다.	CNY
email	String	구매자 이메일입니다.	complete@payer-email.com
billingKey	String	정기(빌링)결제 시 사용되는 빌링키입니다.	MlNCQ0pHMn…
firstName	String	구매자의 이름입니다.	iple
lastName	String	구매자의 성입니다.	Kim
serviceDefine	String	사용자 정의 파라미터입니다. 파트너(상점)에서 보낸 값 그대로 반환됩니다.	We help our partners grow.